You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::CodeDeploy::Types::CreateDeploymentInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-codedeploy/lib/aws-sdk-codedeploy/types.rb

Overview

Note:

When making an API call, you may pass CreateDeploymentInput data as a hash:

{
  application_name: "ApplicationName", # required
  deployment_group_name: "DeploymentGroupName",
  revision: {
    revision_type: "S3", # accepts S3, GitHub
    s3_location: {
      bucket: "S3Bucket",
      key: "S3Key",
      bundle_type: "tar", # accepts tar, tgz, zip
      version: "VersionId",
      e_tag: "ETag",
    },
    git_hub_location: {
      repository: "Repository",
      commit_id: "CommitId",
    },
  },
  deployment_config_name: "DeploymentConfigName",
  description: "Description",
  ignore_application_stop_failures: false,
  target_instances: {
    tag_filters: [
      {
        key: "Key",
        value: "Value",
        type: "KEY_ONLY", # accepts KEY_ONLY, VALUE_ONLY, KEY_AND_VALUE
      },
    ],
    auto_scaling_groups: ["AutoScalingGroupName"],
    ec2_tag_set: {
      ec2_tag_set_list: [
        [
          {
            key: "Key",
            value: "Value",
            type: "KEY_ONLY", # accepts KEY_ONLY, VALUE_ONLY, KEY_AND_VALUE
          },
        ],
      ],
    },
  },
  auto_rollback_configuration: {
    enabled: false,
    events: ["DEPLOYMENT_FAILURE"], # accepts DEPLOYMENT_FAILURE, DEPLOYMENT_STOP_ON_ALARM, DEPLOYMENT_STOP_ON_REQUEST
  },
  update_outdated_instances_only: false,
  file_exists_behavior: "DISALLOW", # accepts DISALLOW, OVERWRITE, RETAIN
}

Represents the input of a CreateDeployment operation.

Instance Attribute Summary collapse

Instance Attribute Details

#application_nameString

The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.

Returns:

  • (String)


1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
# File 'gems/aws-sdk-codedeploy/lib/aws-sdk-codedeploy/types.rb', line 1001

class CreateDeploymentInput < Struct.new(
  :application_name,
  :deployment_group_name,
  :revision,
  :deployment_config_name,
  :description,
  :ignore_application_stop_failures,
  :target_instances,
  :auto_rollback_configuration,
  :update_outdated_instances_only,
  :file_exists_behavior)
  include Aws::Structure
end

#auto_rollback_configurationTypes::AutoRollbackConfiguration

Configuration information for an automatic rollback that is added when a deployment is created.



1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
# File 'gems/aws-sdk-codedeploy/lib/aws-sdk-codedeploy/types.rb', line 1001

class CreateDeploymentInput < Struct.new(
  :application_name,
  :deployment_group_name,
  :revision,
  :deployment_config_name,
  :description,
  :ignore_application_stop_failures,
  :target_instances,
  :auto_rollback_configuration,
  :update_outdated_instances_only,
  :file_exists_behavior)
  include Aws::Structure
end

#deployment_config_nameString

The name of a 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.

Returns:

  • (String)


1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
# File 'gems/aws-sdk-codedeploy/lib/aws-sdk-codedeploy/types.rb', line 1001

class CreateDeploymentInput < Struct.new(
  :application_name,
  :deployment_group_name,
  :revision,
  :deployment_config_name,
  :description,
  :ignore_application_stop_failures,
  :target_instances,
  :auto_rollback_configuration,
  :update_outdated_instances_only,
  :file_exists_behavior)
  include Aws::Structure
end

#deployment_group_nameString

The name of the deployment group.

Returns:

  • (String)


1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
# File 'gems/aws-sdk-codedeploy/lib/aws-sdk-codedeploy/types.rb', line 1001

class CreateDeploymentInput < Struct.new(
  :application_name,
  :deployment_group_name,
  :revision,
  :deployment_config_name,
  :description,
  :ignore_application_stop_failures,
  :target_instances,
  :auto_rollback_configuration,
  :update_outdated_instances_only,
  :file_exists_behavior)
  include Aws::Structure
end

#descriptionString

A comment about the deployment.

Returns:

  • (String)


1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
# File 'gems/aws-sdk-codedeploy/lib/aws-sdk-codedeploy/types.rb', line 1001

class CreateDeploymentInput < Struct.new(
  :application_name,
  :deployment_group_name,
  :revision,
  :deployment_config_name,
  :description,
  :ignore_application_stop_failures,
  :target_instances,
  :auto_rollback_configuration,
  :update_outdated_instances_only,
  :file_exists_behavior)
  include Aws::Structure
end

#file_exists_behaviorString

Information about how AWS CodeDeploy handles files that already exist in a deployment target location but weren't part of the previous successful deployment.

The fileExistsBehavior parameter takes any of the following values:

  • DISALLOW: The deployment fails. This is also the default behavior if no option is specified.

  • OVERWRITE: The version of the file from the application revision currently being deployed replaces the version already on the instance.

  • RETAIN: The version of the file already on the instance is kept and used as part of the new deployment.

Returns:

  • (String)


1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
# File 'gems/aws-sdk-codedeploy/lib/aws-sdk-codedeploy/types.rb', line 1001

class CreateDeploymentInput < Struct.new(
  :application_name,
  :deployment_group_name,
  :revision,
  :deployment_config_name,
  :description,
  :ignore_application_stop_failures,
  :target_instances,
  :auto_rollback_configuration,
  :update_outdated_instances_only,
  :file_exists_behavior)
  include Aws::Structure
end

#ignore_application_stop_failuresBoolean

If set to true, then if the deployment causes the ApplicationStop deployment lifecycle event to an instance to fail, the deployment to that instance will not be considered to have failed 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 an instance, the deployment to that instance will stop, and the deployment to that instance will be considered to have failed.

Returns:

  • (Boolean)


1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
# File 'gems/aws-sdk-codedeploy/lib/aws-sdk-codedeploy/types.rb', line 1001

class CreateDeploymentInput < Struct.new(
  :application_name,
  :deployment_group_name,
  :revision,
  :deployment_config_name,
  :description,
  :ignore_application_stop_failures,
  :target_instances,
  :auto_rollback_configuration,
  :update_outdated_instances_only,
  :file_exists_behavior)
  include Aws::Structure
end

#revisionTypes::RevisionLocation

The type and location of the revision to deploy.



1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
# File 'gems/aws-sdk-codedeploy/lib/aws-sdk-codedeploy/types.rb', line 1001

class CreateDeploymentInput < Struct.new(
  :application_name,
  :deployment_group_name,
  :revision,
  :deployment_config_name,
  :description,
  :ignore_application_stop_failures,
  :target_instances,
  :auto_rollback_configuration,
  :update_outdated_instances_only,
  :file_exists_behavior)
  include Aws::Structure
end

#target_instancesTypes::TargetInstances

Information about the instances that will belong to the replacement environment in a blue/green deployment.



1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
# File 'gems/aws-sdk-codedeploy/lib/aws-sdk-codedeploy/types.rb', line 1001

class CreateDeploymentInput < Struct.new(
  :application_name,
  :deployment_group_name,
  :revision,
  :deployment_config_name,
  :description,
  :ignore_application_stop_failures,
  :target_instances,
  :auto_rollback_configuration,
  :update_outdated_instances_only,
  :file_exists_behavior)
  include Aws::Structure
end

#update_outdated_instances_onlyBoolean

Indicates whether to deploy to all instances or only to instances that are not running the latest application revision.

Returns:

  • (Boolean)


1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
# File 'gems/aws-sdk-codedeploy/lib/aws-sdk-codedeploy/types.rb', line 1001

class CreateDeploymentInput < Struct.new(
  :application_name,
  :deployment_group_name,
  :revision,
  :deployment_config_name,
  :description,
  :ignore_application_stop_failures,
  :target_instances,
  :auto_rollback_configuration,
  :update_outdated_instances_only,
  :file_exists_behavior)
  include Aws::Structure
end