NAME
Paws::CodeDeploy - Perl Interface to AWS AWS CodeDeploy
SYNOPSIS
use Paws;
my $obj = Paws->service('CodeDeploy');
my $res = $obj->Method(
Arg1 => $val1,
Arg2 => [ 'V1', 'V2' ],
# if Arg3 is an object, the HashRef will be used as arguments to the constructor
# of the arguments type
Arg3 => { Att1 => 'Val1' },
# if Arg4 is an array of objects, the HashRefs will be passed as arguments to
# the constructor of the arguments type
Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ],
);DESCRIPTION
AWS CodeDeploy
AWS CodeDeploy is a deployment service that automates application deployments to Amazon EC2 instances, on-premises instances running in your own facility, or serverless AWS Lambda functions.
You can deploy a nearly unlimited variety of application content, such as an updated Lambda function, code, web and configuration files, executables, packages, scripts, multimedia files, and so on. AWS CodeDeploy can deploy application content stored in Amazon S3 buckets, GitHub repositories, or Bitbucket repositories. You do not need to make changes to your existing code before you can use AWS CodeDeploy.
AWS CodeDeploy makes it easier for you to rapidly release new features, helps you avoid downtime during application deployment, and handles the complexity of updating your applications, without many of the risks associated with error-prone manual deployments.
AWS CodeDeploy Components
Use the information in this guide to help you work with the following AWS CodeDeploy components:
Application: A name that uniquely identifies the application you want to deploy. AWS CodeDeploy uses this name, which functions as a container, to ensure the correct combination of revision, deployment configuration, and deployment group are referenced during a deployment.
Deployment group: A set of individual instances or CodeDeploy Lambda applications. A Lambda deployment group contains a group of applications. An EC2/On-premises deployment group contains individually tagged instances, Amazon EC2 instances in Auto Scaling groups, or both.
Deployment configuration: A set of deployment rules and deployment success and failure conditions used by AWS CodeDeploy during a deployment.
Deployment: The process and the components used in the process of updating a Lambda function or of installing content on one or more instances.
Application revisions: For an AWS Lambda deployment, this is an AppSpec file that specifies the Lambda function to update and one or more functions to validate deployment lifecycle events. For an EC2/On-premises deployment, this is an archive file containing source content—source code, web pages, executable files, and deployment scripts—along with an AppSpec file. Revisions are stored in Amazon S3 buckets or GitHub repositories. For Amazon S3, a revision is uniquely identified by its Amazon S3 object key and its ETag, version, or both. For GitHub, a revision is uniquely identified by its commit ID.
This guide also contains information to help you get details about the instances in your deployments, to make on-premises instances available for AWS CodeDeploy deployments, and to get details about a Lambda function deployment.
AWS CodeDeploy Information Resources
AWS CodeDeploy User Guide (http://docs.aws.amazon.com/codedeploy/latest/userguide)
AWS CodeDeploy API Reference Guide (http://docs.aws.amazon.com/codedeploy/latest/APIReference/)
AWS CLI Reference for AWS CodeDeploy (http://docs.aws.amazon.com/cli/latest/reference/deploy/index.html)
AWS CodeDeploy Developer Forum (https://forums.aws.amazon.com/forum.jspa?forumID=179)
For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/codedeploy-2014-10-06
METHODS
AddTagsToOnPremisesInstances
- InstanceNames => ArrayRef[Str|Undef]
- Tags => ArrayRef[Paws::CodeDeploy::Tag]
Each argument is described in detail in: Paws::CodeDeploy::AddTagsToOnPremisesInstances
Returns: nothing
Adds tags to on-premises instances.
BatchGetApplicationRevisions
- ApplicationName => Str
- Revisions => ArrayRef[Paws::CodeDeploy::RevisionLocation]
Each argument is described in detail in: Paws::CodeDeploy::BatchGetApplicationRevisions
Returns: a Paws::CodeDeploy::BatchGetApplicationRevisionsOutput instance
Gets information about one or more application revisions.
BatchGetApplications
Each argument is described in detail in: Paws::CodeDeploy::BatchGetApplications
Returns: a Paws::CodeDeploy::BatchGetApplicationsOutput instance
Gets information about one or more applications.
BatchGetDeploymentGroups
Each argument is described in detail in: Paws::CodeDeploy::BatchGetDeploymentGroups
Returns: a Paws::CodeDeploy::BatchGetDeploymentGroupsOutput instance
Gets information about one or more deployment groups.
BatchGetDeploymentInstances
Each argument is described in detail in: Paws::CodeDeploy::BatchGetDeploymentInstances
Returns: a Paws::CodeDeploy::BatchGetDeploymentInstancesOutput instance
Gets information about one or more instance that are part of a deployment group.
BatchGetDeployments
Each argument is described in detail in: Paws::CodeDeploy::BatchGetDeployments
Returns: a Paws::CodeDeploy::BatchGetDeploymentsOutput instance
Gets information about one or more deployments.
BatchGetOnPremisesInstances
Each argument is described in detail in: Paws::CodeDeploy::BatchGetOnPremisesInstances
Returns: a Paws::CodeDeploy::BatchGetOnPremisesInstancesOutput instance
Gets information about one or more on-premises instances.
ContinueDeployment
Each argument is described in detail in: Paws::CodeDeploy::ContinueDeployment
Returns: nothing
For a blue/green deployment, starts the process of rerouting traffic from instances in the original environment to instances in the replacement environment without waiting for a specified wait time to elapse. (Traffic rerouting, which is achieved by registering instances in the replacement environment with the load balancer, can start as soon as all instances have a status of Ready.)
CreateApplication
Each argument is described in detail in: Paws::CodeDeploy::CreateApplication
Returns: a Paws::CodeDeploy::CreateApplicationOutput instance
Creates an application.
CreateDeployment
- ApplicationName => Str
- [AutoRollbackConfiguration => Paws::CodeDeploy::AutoRollbackConfiguration]
- [DeploymentConfigName => Str]
- [DeploymentGroupName => Str]
- [Description => Str]
- [FileExistsBehavior => Str]
- [IgnoreApplicationStopFailures => Bool]
- [Revision => Paws::CodeDeploy::RevisionLocation]
- [TargetInstances => Paws::CodeDeploy::TargetInstances]
- [UpdateOutdatedInstancesOnly => Bool]
Each argument is described in detail in: Paws::CodeDeploy::CreateDeployment
Returns: a Paws::CodeDeploy::CreateDeploymentOutput instance
Deploys an application revision through the specified deployment group.
CreateDeploymentConfig
- DeploymentConfigName => Str
- [ComputePlatform => Str]
- [MinimumHealthyHosts => Paws::CodeDeploy::MinimumHealthyHosts]
- [TrafficRoutingConfig => Paws::CodeDeploy::TrafficRoutingConfig]
Each argument is described in detail in: Paws::CodeDeploy::CreateDeploymentConfig
Returns: a Paws::CodeDeploy::CreateDeploymentConfigOutput instance
Creates a deployment configuration.
CreateDeploymentGroup
- ApplicationName => Str
- DeploymentGroupName => Str
- ServiceRoleArn => Str
- [AlarmConfiguration => Paws::CodeDeploy::AlarmConfiguration]
- [AutoRollbackConfiguration => Paws::CodeDeploy::AutoRollbackConfiguration]
- [AutoScalingGroups => ArrayRef[Str|Undef]]
- [BlueGreenDeploymentConfiguration => Paws::CodeDeploy::BlueGreenDeploymentConfiguration]
- [DeploymentConfigName => Str]
- [DeploymentStyle => Paws::CodeDeploy::DeploymentStyle]
- [Ec2TagFilters => ArrayRef[Paws::CodeDeploy::EC2TagFilter]]
- [Ec2TagSet => Paws::CodeDeploy::EC2TagSet]
- [LoadBalancerInfo => Paws::CodeDeploy::LoadBalancerInfo]
- [OnPremisesInstanceTagFilters => ArrayRef[Paws::CodeDeploy::TagFilter]]
- [OnPremisesTagSet => Paws::CodeDeploy::OnPremisesTagSet]
- [TriggerConfigurations => ArrayRef[Paws::CodeDeploy::TriggerConfig]]
Each argument is described in detail in: Paws::CodeDeploy::CreateDeploymentGroup
Returns: a Paws::CodeDeploy::CreateDeploymentGroupOutput instance
Creates a deployment group to which application revisions will be deployed.
DeleteApplication
Each argument is described in detail in: Paws::CodeDeploy::DeleteApplication
Returns: nothing
Deletes an application.
DeleteDeploymentConfig
Each argument is described in detail in: Paws::CodeDeploy::DeleteDeploymentConfig
Returns: nothing
Deletes a deployment configuration.
A deployment configuration cannot be deleted if it is currently in use. Predefined configurations cannot be deleted.
DeleteDeploymentGroup
Each argument is described in detail in: Paws::CodeDeploy::DeleteDeploymentGroup
Returns: a Paws::CodeDeploy::DeleteDeploymentGroupOutput instance
Deletes a deployment group.
DeleteGitHubAccountToken
Each argument is described in detail in: Paws::CodeDeploy::DeleteGitHubAccountToken
Returns: a Paws::CodeDeploy::DeleteGitHubAccountTokenOutput instance
Deletes a GitHub account connection.
DeregisterOnPremisesInstance
Each argument is described in detail in: Paws::CodeDeploy::DeregisterOnPremisesInstance
Returns: nothing
Deregisters an on-premises instance.
GetApplication
Each argument is described in detail in: Paws::CodeDeploy::GetApplication
Returns: a Paws::CodeDeploy::GetApplicationOutput instance
Gets information about an application.
GetApplicationRevision
- ApplicationName => Str
- Revision => Paws::CodeDeploy::RevisionLocation
Each argument is described in detail in: Paws::CodeDeploy::GetApplicationRevision
Returns: a Paws::CodeDeploy::GetApplicationRevisionOutput instance
Gets information about an application revision.
GetDeployment
Each argument is described in detail in: Paws::CodeDeploy::GetDeployment
Returns: a Paws::CodeDeploy::GetDeploymentOutput instance
Gets information about a deployment.
GetDeploymentConfig
Each argument is described in detail in: Paws::CodeDeploy::GetDeploymentConfig
Returns: a Paws::CodeDeploy::GetDeploymentConfigOutput instance
Gets information about a deployment configuration.
GetDeploymentGroup
Each argument is described in detail in: Paws::CodeDeploy::GetDeploymentGroup
Returns: a Paws::CodeDeploy::GetDeploymentGroupOutput instance
Gets information about a deployment group.
GetDeploymentInstance
Each argument is described in detail in: Paws::CodeDeploy::GetDeploymentInstance
Returns: a Paws::CodeDeploy::GetDeploymentInstanceOutput instance
Gets information about an instance as part of a deployment.
GetOnPremisesInstance
Each argument is described in detail in: Paws::CodeDeploy::GetOnPremisesInstance
Returns: a Paws::CodeDeploy::GetOnPremisesInstanceOutput instance
Gets information about an on-premises instance.
ListApplicationRevisions
- ApplicationName => Str
- [Deployed => Str]
- [NextToken => Str]
- [S3Bucket => Str]
- [S3KeyPrefix => Str]
- [SortBy => Str]
- [SortOrder => Str]
Each argument is described in detail in: Paws::CodeDeploy::ListApplicationRevisions
Returns: a Paws::CodeDeploy::ListApplicationRevisionsOutput instance
Lists information about revisions for an application.
ListApplications
Each argument is described in detail in: Paws::CodeDeploy::ListApplications
Returns: a Paws::CodeDeploy::ListApplicationsOutput instance
Lists the applications registered with the applicable IAM user or AWS account.
ListDeploymentConfigs
Each argument is described in detail in: Paws::CodeDeploy::ListDeploymentConfigs
Returns: a Paws::CodeDeploy::ListDeploymentConfigsOutput instance
Lists the deployment configurations with the applicable IAM user or AWS account.
ListDeploymentGroups
Each argument is described in detail in: Paws::CodeDeploy::ListDeploymentGroups
Returns: a Paws::CodeDeploy::ListDeploymentGroupsOutput instance
Lists the deployment groups for an application registered with the applicable IAM user or AWS account.
ListDeploymentInstances
- DeploymentId => Str
- [InstanceStatusFilter => ArrayRef[Str|Undef]]
- [InstanceTypeFilter => ArrayRef[Str|Undef]]
- [NextToken => Str]
Each argument is described in detail in: Paws::CodeDeploy::ListDeploymentInstances
Returns: a Paws::CodeDeploy::ListDeploymentInstancesOutput instance
Lists the instance for a deployment associated with the applicable IAM user or AWS account.
ListDeployments
- [ApplicationName => Str]
- [CreateTimeRange => Paws::CodeDeploy::TimeRange]
- [DeploymentGroupName => Str]
- [IncludeOnlyStatuses => ArrayRef[Str|Undef]]
- [NextToken => Str]
Each argument is described in detail in: Paws::CodeDeploy::ListDeployments
Returns: a Paws::CodeDeploy::ListDeploymentsOutput instance
Lists the deployments in a deployment group for an application registered with the applicable IAM user or AWS account.
ListGitHubAccountTokenNames
Each argument is described in detail in: Paws::CodeDeploy::ListGitHubAccountTokenNames
Returns: a Paws::CodeDeploy::ListGitHubAccountTokenNamesOutput instance
Lists the names of stored connections to GitHub accounts.
ListOnPremisesInstances
- [NextToken => Str]
- [RegistrationStatus => Str]
- [TagFilters => ArrayRef[Paws::CodeDeploy::TagFilter]]
Each argument is described in detail in: Paws::CodeDeploy::ListOnPremisesInstances
Returns: a Paws::CodeDeploy::ListOnPremisesInstancesOutput instance
Gets a list of names for one or more on-premises instances.
Unless otherwise specified, both registered and deregistered on-premises instance names will be listed. To list only registered or deregistered on-premises instance names, use the registration status parameter.
PutLifecycleEventHookExecutionStatus
Each argument is described in detail in: Paws::CodeDeploy::PutLifecycleEventHookExecutionStatus
Returns: a Paws::CodeDeploy::PutLifecycleEventHookExecutionStatusOutput instance
Sets the result of a Lambda validation function. The function validates one or both lifecycle events (BeforeAllowTraffic and AfterAllowTraffic) and returns Succeeded or Failed.
RegisterApplicationRevision
- ApplicationName => Str
- Revision => Paws::CodeDeploy::RevisionLocation
- [Description => Str]
Each argument is described in detail in: Paws::CodeDeploy::RegisterApplicationRevision
Returns: nothing
Registers with AWS CodeDeploy a revision for the specified application.
RegisterOnPremisesInstance
Each argument is described in detail in: Paws::CodeDeploy::RegisterOnPremisesInstance
Returns: nothing
Registers an on-premises instance.
Only one IAM ARN (an IAM session ARN or IAM user ARN) is supported in the request. You cannot use both.
RemoveTagsFromOnPremisesInstances
- InstanceNames => ArrayRef[Str|Undef]
- Tags => ArrayRef[Paws::CodeDeploy::Tag]
Each argument is described in detail in: Paws::CodeDeploy::RemoveTagsFromOnPremisesInstances
Returns: nothing
Removes one or more tags from one or more on-premises instances.
SkipWaitTimeForInstanceTermination
Each argument is described in detail in: Paws::CodeDeploy::SkipWaitTimeForInstanceTermination
Returns: nothing
In a blue/green deployment, overrides any specified wait time and starts terminating instances immediately after the traffic routing is completed.
StopDeployment
Each argument is described in detail in: Paws::CodeDeploy::StopDeployment
Returns: a Paws::CodeDeploy::StopDeploymentOutput instance
Attempts to stop an ongoing deployment.
UpdateApplication
Each argument is described in detail in: Paws::CodeDeploy::UpdateApplication
Returns: nothing
Changes the name of an application.
UpdateDeploymentGroup
- ApplicationName => Str
- CurrentDeploymentGroupName => Str
- [AlarmConfiguration => Paws::CodeDeploy::AlarmConfiguration]
- [AutoRollbackConfiguration => Paws::CodeDeploy::AutoRollbackConfiguration]
- [AutoScalingGroups => ArrayRef[Str|Undef]]
- [BlueGreenDeploymentConfiguration => Paws::CodeDeploy::BlueGreenDeploymentConfiguration]
- [DeploymentConfigName => Str]
- [DeploymentStyle => Paws::CodeDeploy::DeploymentStyle]
- [Ec2TagFilters => ArrayRef[Paws::CodeDeploy::EC2TagFilter]]
- [Ec2TagSet => Paws::CodeDeploy::EC2TagSet]
- [LoadBalancerInfo => Paws::CodeDeploy::LoadBalancerInfo]
- [NewDeploymentGroupName => Str]
- [OnPremisesInstanceTagFilters => ArrayRef[Paws::CodeDeploy::TagFilter]]
- [OnPremisesTagSet => Paws::CodeDeploy::OnPremisesTagSet]
- [ServiceRoleArn => Str]
- [TriggerConfigurations => ArrayRef[Paws::CodeDeploy::TriggerConfig]]
Each argument is described in detail in: Paws::CodeDeploy::UpdateDeploymentGroup
Returns: a Paws::CodeDeploy::UpdateDeploymentGroupOutput instance
Changes information about a deployment group.
PAGINATORS
Paginator methods are helpers that repetively call methods that return partial results
ListAllApplicationRevisions(sub { },ApplicationName => Str, [Deployed => Str, NextToken => Str, S3Bucket => Str, S3KeyPrefix => Str, SortBy => Str, SortOrder => Str])
ListAllApplicationRevisions(ApplicationName => Str, [Deployed => Str, NextToken => Str, S3Bucket => Str, S3KeyPrefix => Str, SortBy => Str, SortOrder => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- revisions, passing the object as the first parameter, and the string 'revisions' as the second parameter If not, it will return a a Paws::CodeDeploy::ListApplicationRevisionsOutput instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllApplications(sub { },[NextToken => Str])
ListAllApplications([NextToken => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- applications, passing the object as the first parameter, and the string 'applications' as the second parameter If not, it will return a a Paws::CodeDeploy::ListApplicationsOutput instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllDeploymentConfigs(sub { },[NextToken => Str])
ListAllDeploymentConfigs([NextToken => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- deploymentConfigsList, passing the object as the first parameter, and the string 'deploymentConfigsList' as the second parameter If not, it will return a a Paws::CodeDeploy::ListDeploymentConfigsOutput instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllDeploymentGroups(sub { },ApplicationName => Str, [NextToken => Str])
ListAllDeploymentGroups(ApplicationName => Str, [NextToken => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- deploymentGroups, passing the object as the first parameter, and the string 'deploymentGroups' as the second parameter If not, it will return a a Paws::CodeDeploy::ListDeploymentGroupsOutput instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllDeploymentInstances(sub { },DeploymentId => Str, [InstanceStatusFilter => ArrayRef[Str|Undef], InstanceTypeFilter => ArrayRef[Str|Undef], NextToken => Str])
ListAllDeploymentInstances(DeploymentId => Str, [InstanceStatusFilter => ArrayRef[Str|Undef], InstanceTypeFilter => ArrayRef[Str|Undef], NextToken => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- instancesList, passing the object as the first parameter, and the string 'instancesList' as the second parameter If not, it will return a a Paws::CodeDeploy::ListDeploymentInstancesOutput instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllDeployments(sub { },[ApplicationName => Str, CreateTimeRange => Paws::CodeDeploy::TimeRange, DeploymentGroupName => Str, IncludeOnlyStatuses => ArrayRef[Str|Undef], NextToken => Str])
ListAllDeployments([ApplicationName => Str, CreateTimeRange => Paws::CodeDeploy::TimeRange, DeploymentGroupName => Str, IncludeOnlyStatuses => ArrayRef[Str|Undef], NextToken => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- deployments, passing the object as the first parameter, and the string 'deployments' as the second parameter If not, it will return a a Paws::CodeDeploy::ListDeploymentsOutput instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
SEE ALSO
This service class forms part of Paws
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