Skeddly API
  • Introduction
  • Overview
    • Making Requests
    • Authentication
    • Clients
    • Errors
      • HTTP Status Codes
      • Error Codes
      • Handling Errors
  • Resources
    • Action Exclusions
      • CreateActionExclusion Method
      • DeleteActionExclusion Method
      • GetActionExclusion Method
      • ListActionExclusions Method
      • ModifyActionExclusion Method
    • Action Executions
      • CancelActionExecution Method
      • GetActionExecution Method
      • GetActionExecutionLog Method
      • ListActionExecutions Method
      • ListUpcomingActionExecutions Method
    • Actions
      • Action Types
      • CreateAction Method
      • DeleteAction Method
      • ExecuteAction Method
      • GetAction Method
      • ListActions Method
      • ModifyAction Method
    • Credentials
      • CreateCredential Method
      • CopyCredential Method
      • DeleteCredential Method
      • GenerateIamPolicy Method
      • GenerateAmazonIamRoleExternalId Method
      • GetCredential Method
      • ListCredentials Method
      • ModifyCredential Method
    • Managed Policies
      • GetManagedPolicy Method
      • ListManagedPolicies Method
    • Managed Services
      • CreateManagedServicesPlan Method
      • CreateManagedServicesSelector Method
      • DeleteManagedServicesPlan Method
      • DeleteManagedServicesSelector Method
      • GetManagedServicesPlan Method
      • GetManagedServicesSelector Method
      • ListManagedServicesPlans Method
      • ListManagedServicesSelectors Method
      • ModifyManagedServicesPlan Method
      • ModifyManagedServicesSelector Method
    • Projects
      • ArchiveProject Method
      • CreateProject Method
      • CreateProjectNotification Method
      • CreateProjectRss Method
      • DeleteProjectNotification Method
      • GetProject Method
      • ListProjects Method
      • ModifyProject Method
      • ModifyProjectAccountNotifications Method
      • ModifyProjectReportEmails Method
    • Reports
      • GetBackupsReport Method
    • Regions
      • GetRegion Method
      • ListRegions Method
    • Time Zones
      • ListTimeZones Method
    • Users
      • AttachManagedPolicy Method
      • CreateUser Method
      • DeleteUser Method
      • DetachManagedPolicy Method
      • GetUser Method
      • ListUsers Method
      • ModifyUser Method
      • ModifyUserPassword Method
      • RemoveUserMfa Method
  • Data Types
    • Action Object
    • ActionExecution Object
    • ActionExecutionResult Object
    • ActionExecutionTrigger Object
    • ActionExclusion Object
    • ActionParameters Object
      • AmazonAddSecurityGroupRuleParameters Object
      • AmazonApplyS3BucketPolicyParameters Object
      • AmazonAssociateElasticIpParameters Object
      • AmazonAttachIamRoleToEc2InstancesParameters Object
      • AmazonBackupEc2InstanceParameters Object
      • AmazonBackupEc2InstancesParameters Object
      • AmazonBackupMySQLServerParameters Object
      • AmazonBackupRoute53HostedZoneParameters Object
      • AmazonBackupRoute53HostedZonesParameters Object
      • AmazonChangeDynamoDbTablesParameters Object
      • AmazonChangeEbsVolumesParameters Object
      • AmazonChangeEc2InstanceTypeParameters Object
      • AmazonChangeEc2InstancesParameters Object
      • AmazonChangeRdsInstanceClassParameters Object
      • AmazonCheckRootAccessKeysParameters Object
      • AmazonCloudFormationStackDriftReportParameters Object
      • AmazonCopyAmiImagesParameters Object
      • AmazonCopyEbsSnapshotsParameters Object
      • AmazonCopyEbsVolumeParameters Object
      • AmazonCopyEc2InstanceParameters Object
      • AmazonCopyRdsSnapshotsParameters Object
      • AmazonCopyS3ObjectsParameters Object
      • AmazonCreateAmiImageParameters Object
      • AmazonCreateAmiImagesParameters Object
      • AmazonCreateCloudFormationStackParameters Object
      • AmazonCreateCloudTrailTrailsParameters Object
      • AmazonCreateDirectoryServiceSnapshotsParameters Object
      • AmazonCreateDynamoDbBackupsParameters Object
      • AmazonCreateEbsSnapshotParameters Object
      • AmazonCreateEbsSnapshotsParameters Object
      • AmazonCreateElastiCacheClusterParameters Object
      • AmazonCreateElastiCacheReadReplicaParameters Object
      • AmazonCreateElastiCacheSnapshotsParameters Object
      • AmazonCreateLightsailInstancesFromSnapshotsParameters Object
      • AmazonCreateLightsailInstanceSnapshotsParameters Object
      • AmazonCreateRdsReadReplicaParameters Object
      • AmazonCreateRdsSnapshotParameters Object
      • AmazonCreateRdsSnapshotsParameters Object
      • AmazonCreateRedshiftSnapshotParameters Object
      • AmazonDeleteEbsSnapshotsParameters Object
      • AmazonDeleteEbsVolumesParameters Object
      • AmazonDeleteRdsSnapshotsParameters Object
      • AmazonDeregisterAmiImagesParameters Object
      • AmazonDisableUnusedIamAccessKeysParameters Object
      • AmazonExportDynamoDbTablesParameters Object
      • AmazonRequestEc2SpotInstancesParameters Object
      • AmazonSendSsmCommandParameters Object
      • AmazonStartEc2InstanceParameters Object
      • AmazonStartEc2InstancesParameters Object
      • AmazonTagEbsSnapshotsParameters Object
      • AmazonUpdateAutoScalingGroupsParameters Object
      • AmazonUpdateEcsServicesParameters Object
      • GoogleResizeManagedInstanceGroupsParameters Object
      • GoogleStartVmInstancesParameters Object
      • GoogleStartCloudSqlInstancesParameters Object
    • ActionSchedule Object
    • AllDatabases Object
    • AutoScalingGroupNameComparison Object
    • AmazonIamRoleExternalId Object
    • AmazonIamAccessKeyParameters Object
    • AmazonIamRoleParameters Object
    • AmazonS3Target Object
    • AmiImageDescriptionComparison Object
    • AmiImageNameComparison Object
    • AmiImageTag Object
    • AmiImageVolumeChanges Object
    • AttachVolumeToInstanceParameters Object
    • AzureCredentialParameters Object
    • BackupsReportItem Object
    • BucketNameComparison Object
    • ChangeDeleteOnTerminate Object
    • ChangeEbsVolumeEncryption Object
    • ChangeEbsVolumeSize Object
    • ChangeEbsVolumeType Object
    • CloudFormationParameter Object
    • CloudFormationStackNameComparison Object
    • CloudTrailCloudWatchLogsProperties Object
    • CreateEbsSnapshot Object
    • CreateLightsailInstancesInstance Object
    • Credential Object
    • DatabaseEndpoint Object
    • DaysDetached Object
    • EbsSnapshotDescriptionComparison Object
    • EbsVolumeIdComparison Object
    • EcsClusterNameComparison Object
    • EcsServiceNameComparison Object
    • ElastiCacheClusterIdComparison Object
    • Error Object
    • FirstInFirstOutDeleteSchemeParameters Object
    • GrandfatherFatherSonDeleteSchemeParameters Object
    • GoogleInstanceNameComparison Object
    • GoogleLabelComparison Object
    • GoogleManagedInstanceGroupNameComparison Object
    • GoogleServiceAccountKeyParameters Object
    • IamUserNameComparison Object
    • InstanceNameComparison Object
    • LightsailInstanceNameComparison Object
    • LightsailInstanceSnapshotNameComparison Object
    • ManagedPolicy Object
    • ManagedServicesGroupIdComparison Object
    • ManagedServicesPlan Object
    • ManagedServicesPlanParameters Object
      • ManagedServicesStartStopPlanParameters Object
    • ManagedServicesPlanSchedule Object
    • ManagedServicesResourceIdComparison Object
    • ManagedServicesResourceTagComparison Object
    • ManagedServicesSelector Object
    • MinimumToKeepPeriodParameters Object
    • NameTagComparison Object
    • Project Object
    • ProjectNotification Object
    • ProjectNotificationAmazonSnsSettings Object
    • ProjectNotificationEmailSettings Object
    • ProjectNotificationSlackSettings Object
    • ProjectNotificationsSettings Object
    • ProjectRssFeed Object
    • RdsInstanceIdComparison Object
    • RdsSnapshotIdComparison Object
    • RdsSourceIdComparison Object
    • Region Object
    • ResourceTagComparison Object
    • RollingInstanceStops Object
    • ScheduleParameters Object
      • DailyScheduleParameters Object
      • HourlyScheduleParameters Object
      • NoneScheduleParameters Object
      • MonthlyScheduleParameters Object
      • WeeklyScheduleParameters Object
    • SendSsmCommandParameter Object
    • SpecificDatabases Object
    • SpotInstanceOptions Object
    • StartEc2InstancesInstance Object
    • TableNameComparison Object
    • Tag Object
    • TimeZone Object
    • UpcomingActionExecution Object
    • User Object
    • UserManagedPolicy
    • WeekAndDay Object
Powered by GitBook
On this page
  • Description
  • Properties
  • availabilityZone
  • cancelTimeInSeconds
  • credentialIds
  • elasticIp
  • iamInstanceProfile
  • imageDescriptionComparison
  • imageId
  • imageIdentificationMethod
  • imageNameComparison
  • instanceType
  • keyPair
  • maxInstanceCount
  • maxSpotPriceUsd
  • nameTagComparison
  • regionNames
  • resourceTagComparison
  • securityGroup
  • terminateTimeFrame
  • terminateTimeInSeconds
  • userData
  • userDataFormat
  • vpcSubnetId
  • Sample JSON
  1. Data Types
  2. ActionParameters Object

AmazonRequestEc2SpotInstancesParameters Object

Description

Parameters for the Amazon Request EC2 Spot Instances action.

Properties

availabilityZone

Availability zone in which to launch the requested EC2 instances.

Type: string

Required: No

cancelTimeInSeconds

Time (in seconds) after the request is made when it will be cancelled.

Type: integer

Required: No

credentialIds

Registered credentials to use with the action. One and only one credential must be specified.

Type: Array of string

Required: Yes

elasticIp

Elastic IP address to assign to the launched EC2 instance. If more than one EC2 instance is launched, only one will receive the elastic IP address.

Type: string

Required: No

iamInstanceProfile

IAM instance profile to assign to the launched EC2 instances.

Type: string

Required: No

imageDescriptionComparison

Comparison to use when identifying images by description. Required when imageIdentificationMethod is by-image-description.

Required: Conditional

imageId

Image ID of the AMI image to use for the spot instance request. Required when imageIdentificationMethod is by-image-id.

Type: string

Required: Conditional

imageIdentificationMethod

Method of identifying the AMI image to use.

Type: string

Valid Values:

  • all-images

  • by-image-id

  • by-image-name

  • by-image-description

  • by-image-name-tag

  • by-resource-tag

Required: Yes

imageNameComparison

Comparison to use when identifying images by name. Required when imageIdentificationMethod is by-image-name.

Required: Conditional

instanceType

EC2 Instance type to use with the request.

Type: string

Required: Yes

keyPair

Name of the key pair to assign to the EC2 instances.

Type: string

Required: No

maxInstanceCount

Maximum number of instances to request.

Type: integer

Required: Yes

maxSpotPriceUsd

Maximum spot price to use for the request.

Type: decimal

Required: Yes

nameTagComparison

Comparison to use when identifying images by the Name tag. Required when imageIdentificationMethod is by-image-name-tag.

Required: Conditional

regionNames

Region to use with the action. One and only one region must be specified.

Type: Array of string

Required: Yes

resourceTagComparison

Comparison to use when identifying images by resource tag. Required when imageIdentificationMethod is by-resource-tag.

Required: Conditional

securityGroup

Security group to attach to the EC2 instances.

Type: string

Required: No

terminateTimeFrame

Time frame determining when the EC2 instances will be terminated. Required when terminateTimeInSeconds is set.

Type: string

Valid Values:

  • from-action-start

  • from-instance-launch

Required: Conditional

terminateTimeInSeconds

Time (in seconds) after which the EC2 instances will be terminated.

Type: integer

Required: No

userData

User data which will be used by the EC2 instances.

Type: string

Required: No

userDataFormat

Format of the text in the UserData field. Required when UserData is specified.

Type: string

Valid Values:

  • text

  • base64-encoded

Required: Conditional

vpcSubnetId

ID of the VPC subnet in which the EC2 instances should be launched.

Type: string

Required: No

Sample JSON

{
    "credentialIds": [
        "cred-00000001"
    ],
    "regionNames": [
        "us-east-1"
    ],

    "ImageIdentificationMethod": "by-image-name",
    "ImageNameComparison": {
        "compareType": "starts-with",
        "imageName": "prod-"
    },

    "MaxSpotPriceUsd": 0.25,
    "MaxInstanceCount": 1,

    "InstanceType": "t2.micro",
    "vpcSubnetId": "subnet-00000000",

    "cancelTimeInSeconds": 300,
    "terminateTimeInSeconds": 300,
    "TerminateTimeFrame": "from-instance-launch"
}
PreviousAmazonExportDynamoDbTablesParameters ObjectNextAmazonSendSsmCommandParameters Object

Last updated 7 years ago

Type: object.

Type: object.

Type: object.

Type: object.

AmiImageDescriptionComparison
AmiImageNameComparison
NameTagComparison
ResourceTagComparison