com.amazonaws.internal.SdkInternalList<T> tags
The tag key-value pairs to add to the on-premises instances.
Keys and values are both required. Keys cannot be nulls or empty strings. Value-only tags are not allowed.
com.amazonaws.internal.SdkInternalList<T> instanceNames
The names of the on-premises instances to add tags to.
String applicationId
The application ID.
String applicationName
The application name.
Date createTime
The time that the application was created.
Boolean linkedToGitHub
True if the user has authenticated with GitHub for the specified application; otherwise, false.
String applicationName
The name of an existing AWS CodeDeploy application to get revision information about.
com.amazonaws.internal.SdkInternalList<T> revisions
Information to get about the application revisions, including revision type and location.
String applicationName
The name of the application that corresponds to the revisions.
String errorMessage
Information about errors that may have occurred during the API call.
com.amazonaws.internal.SdkInternalList<T> revisions
Additional information about the revisions, including the revision type and location.
com.amazonaws.internal.SdkInternalList<T> applicationNames
A list of application names, with multiple application names separated by spaces.
com.amazonaws.internal.SdkInternalList<T> applicationsInfo
Information about the applications.
String deploymentId
The unique ID of a deployment.
com.amazonaws.internal.SdkInternalList<T> instanceIds
The unique IDs of instances in the deployment's deployment group.
com.amazonaws.internal.SdkInternalList<T> instancesSummary
Information about the instances.
String errorMessage
Information about errors that may have occurred during the API call.
com.amazonaws.internal.SdkInternalList<T> deploymentIds
A list of deployment IDs, with multiple deployment IDs separated by spaces.
com.amazonaws.internal.SdkInternalList<T> deploymentsInfo
Information about the deployments.
com.amazonaws.internal.SdkInternalList<T> instanceNames
The names of the on-premises instances to get information about.
com.amazonaws.internal.SdkInternalList<T> instanceInfos
Information about the on-premises instances.
String applicationName
The name of the application. This name must be unique with the applicable IAM user or AWS account.
String applicationId
A unique application ID.
String deploymentConfigName
The name of the deployment configuration to create.
MinimumHealthyHosts minimumHealthyHosts
The minimum number of healthy instances that should be available at any time during the deployment. There are two parameters expected in the input: type and value.
The type parameter takes either of the following values:
The value parameter takes an integer.
For example, to set a minimum of 95% healthy instances, specify a type of FLEET_PERCENT and a value of 95.
String deploymentConfigId
A unique deployment configuration ID.
String applicationName
The name of an existing AWS CodeDeploy application associated with the applicable IAM user or AWS account.
String deploymentGroupName
The name of a new deployment group for the specified application.
String deploymentConfigName
If specified, the deployment configuration name can be either one of the predefined configurations provided with AWS CodeDeploy, or a custom deployment configuration that you created by calling the create deployment configuration operation.
CodeDeployDefault.OneAtATime is the default deployment configuration that is used if a configuration isn't specified for either the deployment or the deployment group.
The predefined deployment configurations including the following:
CodeDeployDefault.AllAtOnce attempts to deploy an application revision to as many instances as possible at once. The status of the overall deployment will be displayed as Succeeded if the application revision is deployed to one or more of the instances. The status of the overall deployment will be displayed as Failed if the application revision is not deployed to any of the instances. Using an example of nine instances, CodeDeployDefault.AllAtOnce will attempt to deploy to all nine instances at once. The overall deployment will succeed if deployment to even a single instance is successful; it will fail only if deployments to all nine instances fail.
CodeDeployDefault.HalfAtATime deploys to up to half of the instances at a time (with fractions rounded down). The overall deployment succeeds if the application revision deploys to at least half of the instances (with fractions rounded up); otherwise, the deployment fails. For example, for nine instances, deploy to up to four instances at a time. The overall deployment succeeds if deployment to five or more instances succeed; otherwise, the deployment fails. Note that the deployment may successfully deploy to some instances, even if the overall deployment fails.
CodeDeployDefault.OneAtATime deploys the application revision to only one instance at a time.
For deployment groups that contain more than one instance:
The overall deployment succeeds if the application revision deploys to all of the instances. The exception to this rule is that if deployment to the last instance fails, the overall deployment still succeeds. This is because AWS CodeDeploy allows only one instance to be taken offline at a time with the CodeDeployDefault.OneAtATime configuration.
The overall deployment fails as soon as the application revision fails to deploy to any but the last instance. Note that the deployment may successfully deploy to some instances, even if the overall deployment fails.
Example: For nine instances, deploy to one instance at a time. The overall deployment succeeds if the first eight instances are successfully deployed to, but it fails if deployment to any of the first eight instances fails.
For deployment groups that contain only one instance, the overall deployment is of course successful only if deployment to the single instance succeeds.
com.amazonaws.internal.SdkInternalList<T> ec2TagFilters
The Amazon EC2 tags to filter on.
com.amazonaws.internal.SdkInternalList<T> onPremisesInstanceTagFilters
The on-premises instance tags to filter on.
com.amazonaws.internal.SdkInternalList<T> autoScalingGroups
A list of associated Auto Scaling groups.
String serviceRoleArn
A service role ARN that allows AWS CodeDeploy to act on the user's behalf when interacting with AWS services.
com.amazonaws.internal.SdkInternalList<T> triggerConfigurations
Information about triggers to create when the deployment group is created.
String deploymentGroupId
A unique deployment group ID.
String applicationName
The name of an existing AWS CodeDeploy application associated with the applicable IAM user or AWS account.
String deploymentGroupName
The deployment group's name.
RevisionLocation revision
The type of revision to deploy, along with information about the revision's location.
String deploymentConfigName
The name of an existing deployment configuration associated with the applicable IAM user or AWS account.
If not specified, the value configured in the deployment group will be used as the default. If the deployment group does not have a deployment configuration associated with it, then CodeDeployDefault.OneAtATime will be used by default.
String description
A comment about the deployment.
Boolean ignoreApplicationStopFailures
If set to true, then if the deployment causes the ApplicationStop deployment lifecycle event to fail to a specific instance, the deployment will not be considered to have failed to that instance at that point and will continue on to the BeforeInstall deployment lifecycle event.
If set to false or not specified, then if the deployment causes the ApplicationStop deployment lifecycle event to fail to a specific instance, the deployment will stop to that instance, and the deployment to that instance will be considered to have failed.
String deploymentId
A unique deployment ID.
String applicationName
The name of an existing AWS CodeDeploy application associated with the applicable IAM user or AWS account.
String deploymentConfigName
The name of an existing deployment configuration associated with the applicable IAM user or AWS account.
com.amazonaws.internal.SdkInternalList<T> hooksNotCleanedUp
If the output contains no data, and the corresponding deployment group contained at least one Auto Scaling group, AWS CodeDeploy successfully removed all corresponding Auto Scaling lifecycle event hooks from the Amazon EC2 instances in the Auto Scaling. If the output does contain data, AWS CodeDeploy could not remove some Auto Scaling lifecycle event hooks from the Amazon EC2 instances in the Auto Scaling group.
String deploymentConfigId
The deployment configuration ID.
String deploymentConfigName
The deployment configuration name.
MinimumHealthyHosts minimumHealthyHosts
Information about the number or percentage of minimum healthy instances.
Date createTime
The time that the deployment configuration was created.
String applicationName
The application name.
String deploymentGroupId
The deployment group ID.
String deploymentGroupName
The deployment group name.
String deploymentConfigName
The deployment configuration name.
com.amazonaws.internal.SdkInternalList<T> ec2TagFilters
The Amazon EC2 tags to filter on.
com.amazonaws.internal.SdkInternalList<T> onPremisesInstanceTagFilters
The on-premises instance tags to filter on.
com.amazonaws.internal.SdkInternalList<T> autoScalingGroups
A list of associated Auto Scaling groups.
String serviceRoleArn
A service role ARN.
RevisionLocation targetRevision
Information about the deployment group's target revision, including the revision's type and its location.
com.amazonaws.internal.SdkInternalList<T> triggerConfigurations
A list of associated triggers.
String applicationName
The application name.
String deploymentGroupName
The deployment group name.
String deploymentConfigName
The deployment configuration name.
String deploymentId
The deployment ID.
RevisionLocation revision
Information about the location of application artifacts that are stored and the service to retrieve them from.
String status
The current state of the deployment as a whole.
ErrorInformation errorInformation
Information about any error associated with this deployment.
Date createTime
A timestamp indicating when the deployment was created.
Date startTime
A timestamp indicating when the deployment began deploying to the deployment group.
Note that in some cases, the reported value of the start time may be later than the complete time. This is due to differences in the clock settings of various back-end servers that participate in the overall deployment process.
Date completeTime
A timestamp indicating when the deployment was completed.
DeploymentOverview deploymentOverview
A summary of the deployment status of the instances in the deployment.
String description
A comment about the deployment.
String creator
How the deployment was created:
Boolean ignoreApplicationStopFailures
If true, then if the deployment causes the ApplicationStop deployment lifecycle event to fail to a specific instance, the deployment will not be considered to have failed to that instance at that point and will continue on to the BeforeInstall deployment lifecycle event.
If false or not specified, then if the deployment causes the ApplicationStop deployment lifecycle event to fail to a specific instance, the deployment will stop to that instance, and the deployment to that instance will be considered to have failed.
Long pending
The number of instances that are pending in the deployment.
Long inProgress
The number of instances that are in progress in the deployment.
Long succeeded
The number of instances that have succeeded in the deployment.
Long failed
The number of instances that have failed in the deployment.
Long skipped
The number of instances that have been skipped in the deployment.
String instanceName
The name of the on-premises instance to deregister.
String errorCode
The associated error code:
String scriptName
The name of the script.
String message
The message associated with the error.
String logTail
The last portion of the associated diagnostic log.
If available, AWS CodeDeploy returns up to the last 4 KB of the associated diagnostic log.
String code
The error code:
String message
An accompanying error message.
String description
A comment about the revision.
com.amazonaws.internal.SdkInternalList<T> deploymentGroups
The deployment groups where this is the current target revision.
Date firstUsedTime
When the revision was first used by AWS CodeDeploy.
Date lastUsedTime
When the revision was last used by AWS CodeDeploy.
Date registerTime
When the revision was registered with AWS CodeDeploy.
String applicationName
The name of an existing AWS CodeDeploy application associated with the applicable IAM user or AWS account.
ApplicationInfo application
Information about the application.
String applicationName
The name of the application that corresponds to the revision.
RevisionLocation revision
Information about the application revision to get, including the revision's type and its location.
String applicationName
The name of the application that corresponds to the revision.
RevisionLocation revision
Additional information about the revision, including the revision's type and its location.
GenericRevisionInfo revisionInfo
General information about the revision.
String deploymentConfigName
The name of an existing deployment configuration associated with the applicable IAM user or AWS account.
DeploymentConfigInfo deploymentConfigInfo
Information about the deployment configuration.
DeploymentGroupInfo deploymentGroupInfo
Information about the deployment group.
InstanceSummary instanceSummary
Information about the instance.
String deploymentId
An existing deployment ID associated with the applicable IAM user or AWS account.
DeploymentInfo deploymentInfo
Information about the deployment.
String instanceName
The name of the on-premises instance to get information about
InstanceInfo instanceInfo
Information about the on-premises instance.
String repository
The GitHub account and repository pair that stores a reference to the commit that represents the bundled artifacts for the application revision.
Specified as account/repository.
String commitId
The SHA1 commit ID of the GitHub commit that represents the bundled artifacts for the application revision.
String instanceName
The name of the on-premises instance.
String iamUserArn
The IAM user ARN associated with the on-premises instance.
String instanceArn
The ARN of the on-premises instance.
Date registerTime
The time that the on-premises instance was registered.
Date deregisterTime
If the on-premises instance was deregistered, the time that the on-premises instance was deregistered.
com.amazonaws.internal.SdkInternalList<T> tags
The tags that are currently associated with the on-premises instance.
String deploymentId
The deployment ID.
String instanceId
The instance ID.
String status
The deployment status for this instance:
Date lastUpdatedAt
A timestamp indicating when the instance information was last updated.
com.amazonaws.internal.SdkInternalList<T> lifecycleEvents
A list of lifecycle events for this instance.
String lifecycleEventName
The deployment lifecycle event name, such as ApplicationStop, BeforeInstall, AfterInstall, ApplicationStart, or ValidateService.
Diagnostics diagnostics
Diagnostic information about the deployment lifecycle event.
Date startTime
A timestamp indicating when the deployment lifecycle event started.
Date endTime
A timestamp indicating when the deployment lifecycle event ended.
String status
The deployment lifecycle event status:
String applicationName
The name of an existing AWS CodeDeploy application associated with the applicable IAM user or AWS account.
String sortBy
The column name to sort the list results by:
If not specified or set to null, the results will be returned in an arbitrary order.
String sortOrder
The order to sort the list results by:
If not specified, the results will be sorted in ascending order.
If set to null, the results will be sorted in an arbitrary order.
String s3Bucket
A specific Amazon S3 bucket name to limit the search for revisions.
If set to null, then all of the user's buckets will be searched.
String s3KeyPrefix
A specific key prefix for the set of Amazon S3 objects to limit the search for revisions.
String deployed
Whether to list revisions based on whether the revision is the target revision of an deployment group:
String nextToken
An identifier that was returned from the previous list application revisions call, which can be used to return the next set of applications in the list.
com.amazonaws.internal.SdkInternalList<T> revisions
A list of revision locations that contain the matching revisions.
String nextToken
If the amount of information that is returned is significantly large, an identifier will also be returned, which can be used in a subsequent list application revisions call to return the next set of application revisions in the list.
String nextToken
An identifier that was returned from the previous list applications call, which can be used to return the next set of applications in the list.
com.amazonaws.internal.SdkInternalList<T> applications
A list of application names.
String nextToken
If the amount of information that is returned is significantly large, an identifier will also be returned, which can be used in a subsequent list applications call to return the next set of applications in the list.
String nextToken
An identifier that was returned from the previous list deployment configurations call, which can be used to return the next set of deployment configurations in the list.
com.amazonaws.internal.SdkInternalList<T> deploymentConfigsList
A list of deployment configurations, including the built-in configurations such as CodeDeployDefault.OneAtATime.
String nextToken
If the amount of information that is returned is significantly large, an identifier will also be returned, which can be used in a subsequent list deployment configurations call to return the next set of deployment configurations in the list.
String applicationName
The name of an existing AWS CodeDeploy application associated with the applicable IAM user or AWS account.
String nextToken
An identifier that was returned from the previous list deployment groups call, which can be used to return the next set of deployment groups in the list.
String applicationName
The application name.
com.amazonaws.internal.SdkInternalList<T> deploymentGroups
A list of corresponding deployment group names.
String nextToken
If the amount of information that is returned is significantly large, an identifier will also be returned, which can be used in a subsequent list deployment groups call to return the next set of deployment groups in the list.
String deploymentId
The unique ID of a deployment.
String nextToken
An identifier that was returned from the previous list deployment instances call, which can be used to return the next set of deployment instances in the list.
com.amazonaws.internal.SdkInternalList<T> instanceStatusFilter
A subset of instances to list, by status:
com.amazonaws.internal.SdkInternalList<T> instancesList
A list of instances IDs.
String nextToken
If the amount of information that is returned is significantly large, an identifier will also be returned, which can be used in a subsequent list deployment instances call to return the next set of deployment instances in the list.
String applicationName
The name of an existing AWS CodeDeploy application associated with the applicable IAM user or AWS account.
String deploymentGroupName
The name of an existing deployment group for the specified application.
com.amazonaws.internal.SdkInternalList<T> includeOnlyStatuses
A subset of deployments to list, by status:
TimeRange createTimeRange
A deployment creation start- and end-time range for returning a subset of the list of deployments.
String nextToken
An identifier that was returned from the previous list deployments call, which can be used to return the next set of deployments in the list.
com.amazonaws.internal.SdkInternalList<T> deployments
A list of deployment IDs.
String nextToken
If the amount of information that is returned is significantly large, an identifier will also be returned, which can be used in a subsequent list deployments call to return the next set of deployments in the list.
String registrationStatus
The on-premises instances registration status:
com.amazonaws.internal.SdkInternalList<T> tagFilters
The on-premises instance tags that will be used to restrict the corresponding on-premises instance names that are returned.
String nextToken
An identifier that was returned from the previous list on-premises instances call, which can be used to return the next set of on-premises instances in the list.
com.amazonaws.internal.SdkInternalList<T> instanceNames
The list of matching on-premises instance names.
String nextToken
If the amount of information that is returned is significantly large, an identifier will also be returned, which can be used in a subsequent list on-premises instances call to return the next set of on-premises instances in the list.
Integer value
The minimum healthy instances value.
String type
The minimum healthy instances type:
For example, for 9 instances, if a HOST_COUNT of 6 is specified, deploy to up to 3 instances at a time. The deployment succeeds if 6 or more instances are successfully deployed to; otherwise, the deployment fails. If a FLEET_PERCENT of 40 is specified, deploy to up to 5 instances at a time. The deployment succeeds if 4 or more instances are successfully deployed to; otherwise, the deployment fails.
String applicationName
The name of an existing AWS CodeDeploy application associated with the applicable IAM user or AWS account.
String description
A comment about the revision.
RevisionLocation revision
Information about the application revision to register, including the revision's type and its location.
com.amazonaws.internal.SdkInternalList<T> tags
The tag key-value pairs to remove from the on-premises instances.
com.amazonaws.internal.SdkInternalList<T> instanceNames
The names of the on-premises instances to remove tags from.
RevisionLocation revisionLocation
GenericRevisionInfo genericRevisionInfo
String revisionType
The application revision's type:
S3Location s3Location
GitHubLocation gitHubLocation
String bucket
The name of the Amazon S3 bucket where the application revision is stored.
String key
The name of the Amazon S3 object that represents the bundled artifacts for the application revision.
String bundleType
The file type of the application revision. Must be one of the following:
String version
A specific version of the Amazon S3 object that represents the bundled artifacts for the application revision.
If the version is not specified, the system will use the most recent version by default.
String eTag
The ETag of the Amazon S3 object that represents the bundled artifacts for the application revision.
If the ETag is not specified as an input parameter, ETag validation of the object will be skipped.
String deploymentId
The unique ID of a deployment.
String triggerName
String triggerTargetArn
The arn of the Amazon Simple Notification Service topic through which notifications about deployment or instance events are sent.
com.amazonaws.internal.SdkInternalList<T> triggerEvents
The event type or types for which notifications are triggered.
The following event type values are supported:
String applicationName
The application name corresponding to the deployment group to update.
String currentDeploymentGroupName
The current name of the existing deployment group.
String newDeploymentGroupName
The new name of the deployment group, if you want to change it.
String deploymentConfigName
The replacement deployment configuration name to use, if you want to change it.
com.amazonaws.internal.SdkInternalList<T> ec2TagFilters
The replacement set of Amazon EC2 tags to filter on, if you want to change them. To keep the existing tags, enter their names. To remove tags, do not enter any tag names.
com.amazonaws.internal.SdkInternalList<T> onPremisesInstanceTagFilters
The replacement set of on-premises instance tags for filter on, if you want to change them. To keep the existing tags, enter their names. To remove tags, do not enter any tag names.
com.amazonaws.internal.SdkInternalList<T> autoScalingGroups
The replacement list of Auto Scaling groups to be included in the deployment group, if you want to change them. To keep the existing Auto Scaling groups, enter their names. To remove Auto Scaling groups, do not enter any Auto Scaling group names.
String serviceRoleArn
A replacement service role's ARN, if you want to change it.
com.amazonaws.internal.SdkInternalList<T> triggerConfigurations
Information about triggers to change when the deployment group is updated.
com.amazonaws.internal.SdkInternalList<T> hooksNotCleanedUp
If the output contains no data, and the corresponding deployment group contained at least one Auto Scaling group, AWS CodeDeploy successfully removed all corresponding Auto Scaling lifecycle event hooks from the AWS account. If the output does contain data, AWS CodeDeploy could not remove some Auto Scaling lifecycle event hooks from the AWS account.
Copyright © 2016. All rights reserved.