/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::CodeDeploy::CreateDeployment

NAME

Paws::CodeDeploy::CreateDeployment - Arguments for method CreateDeployment on Paws::CodeDeploy

DESCRIPTION

This class represents the parameters used for calling the method CreateDeployment on the AWS CodeDeploy service. Use the attributes of this class as arguments to method CreateDeployment.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateDeployment.

SYNOPSIS

my $codedeploy = Paws->service('CodeDeploy');
my $CreateDeploymentOutput = $codedeploy->CreateDeployment(
  ApplicationName           => 'MyApplicationName',
  AutoRollbackConfiguration => {
    Enabled => 1,    # OPTIONAL
    Events  => [
      'DEPLOYMENT_FAILURE',
      ... # values: DEPLOYMENT_FAILURE, DEPLOYMENT_STOP_ON_ALARM, DEPLOYMENT_STOP_ON_REQUEST
    ],    # OPTIONAL
  },    # OPTIONAL
  DeploymentConfigName          => 'MyDeploymentConfigName',    # OPTIONAL
  DeploymentGroupName           => 'MyDeploymentGroupName',     # OPTIONAL
  Description                   => 'MyDescription',             # OPTIONAL
  FileExistsBehavior            => 'DISALLOW',                  # OPTIONAL
  IgnoreApplicationStopFailures => 1,                           # OPTIONAL
  Revision                      => {
    AppSpecContent => {
      Content => 'MyRawStringContent',    # OPTIONAL
      Sha256  => 'MyRawStringSha256',     # OPTIONAL
    },    # OPTIONAL
    GitHubLocation => {
      CommitId   => 'MyCommitId',      # OPTIONAL
      Repository => 'MyRepository',    # OPTIONAL
    },    # OPTIONAL
    RevisionType =>
      'S3',    # values: S3, GitHub, String, AppSpecContent; OPTIONAL
    S3Location => {
      Bucket     => 'MyS3Bucket',     # OPTIONAL
      BundleType => 'tar',     # values: tar, tgz, zip, YAML, JSON; OPTIONAL
      ETag       => 'MyETag',  # OPTIONAL
      Key        => 'MyS3Key', # OPTIONAL
      Version    => 'MyVersionId',    # OPTIONAL
    },    # OPTIONAL
    String => {
      Content => 'MyRawStringContent',    # OPTIONAL
      Sha256  => 'MyRawStringSha256',     # OPTIONAL
    },    # OPTIONAL
  },    # OPTIONAL
  TargetInstances => {
    AutoScalingGroups => [ 'MyAutoScalingGroupName', ... ],    # OPTIONAL
    Ec2TagSet         => {
      Ec2TagSetList => [
        [
          {
            Key  => 'MyKey',       # OPTIONAL
            Type => 'KEY_ONLY'
            ,    # values: KEY_ONLY, VALUE_ONLY, KEY_AND_VALUE; OPTIONAL
            Value => 'MyValue',    # OPTIONAL
          },
          ...
        ],
        ...
      ],    # OPTIONAL
    },    # OPTIONAL
    TagFilters => [
      {
        Key  => 'MyKey',       # OPTIONAL
        Type => 'KEY_ONLY'
        ,    # values: KEY_ONLY, VALUE_ONLY, KEY_AND_VALUE; OPTIONAL
        Value => 'MyValue',    # OPTIONAL
      },
      ...
    ],
  },    # OPTIONAL
  UpdateOutdatedInstancesOnly => 1,    # OPTIONAL
);

# Results:
my $DeploymentId = $CreateDeploymentOutput->DeploymentId;

# Returns a L<Paws::CodeDeploy::CreateDeploymentOutput> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/codedeploy/CreateDeployment

ATTRIBUTES

REQUIRED ApplicationName => Str

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

AutoRollbackConfiguration => Paws::CodeDeploy::AutoRollbackConfiguration

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

DeploymentConfigName => Str

The name of a deployment configuration associated with the IAM user or AWS account.

If not specified, the value configured in the deployment group is used as the default. If the deployment group does not have a deployment configuration associated with it, CodeDeployDefault.OneAtATime is used by default.

DeploymentGroupName => Str

The name of the deployment group.

Description => Str

A comment about the deployment.

FileExistsBehavior => Str

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.

Valid values are: "DISALLOW", "OVERWRITE", "RETAIN"

IgnoreApplicationStopFailures => Bool

If true, then if an ApplicationStop, BeforeBlockTraffic, or AfterBlockTraffic deployment lifecycle event to an instance fails, then the deployment continues to the next deployment lifecycle event. For example, if ApplicationStop fails, the deployment continues with DownloadBundle. If BeforeBlockTraffic fails, the deployment continues with BlockTraffic. If AfterBlockTraffic fails, the deployment continues with ApplicationStop.

If false or not specified, then if a lifecycle event fails during a deployment to an instance, that deployment fails. If deployment to that instance is part of an overall deployment and the number of healthy hosts is not less than the minimum number of healthy hosts, then a deployment to the next instance is attempted.

During a deployment, the AWS CodeDeploy agent runs the scripts specified for ApplicationStop, BeforeBlockTraffic, and AfterBlockTraffic in the AppSpec file from the previous successful deployment. (All other scripts are run from the AppSpec file in the current deployment.) If one of these scripts contains an error and does not run successfully, the deployment can fail.

If the cause of the failure is a script from the last successful deployment that will never run successfully, create a new deployment and use ignoreApplicationStopFailures to specify that the ApplicationStop, BeforeBlockTraffic, and AfterBlockTraffic failures should be ignored.

Revision => Paws::CodeDeploy::RevisionLocation

The type and location of the revision to deploy.

TargetInstances => Paws::CodeDeploy::TargetInstances

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

UpdateOutdatedInstancesOnly => Bool

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

SEE ALSO

This class forms part of Paws, documenting arguments for method CreateDeployment in Paws::CodeDeploy

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues