Struct aws_sdk_codedeploy::client::fluent_builders::CreateDeployment

pub struct CreateDeployment { /* private fields */ }

Fluent builder constructing a request to CreateDeployment.

Deploys an application revision through the specified deployment group.

Implementations

impl CreateDeployment

pub async fn send(
    self
) -> Result<CreateDeploymentOutput, SdkError<CreateDeploymentError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn application_name(self, input: impl Into<String>) -> Self

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

pub fn set_application_name(self, input: Option<String>) -> Self

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

pub fn deployment_group_name(self, input: impl Into<String>) -> Self

The name of the deployment group.

pub fn set_deployment_group_name(self, input: Option<String>) -> Self

The name of the deployment group.

pub fn revision(self, input: RevisionLocation) -> Self

The type and location of the revision to deploy.

pub fn set_revision(self, input: Option<RevisionLocation>) -> Self

The type and location of the revision to deploy.

pub fn deployment_config_name(self, input: impl Into<String>) -> Self

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.

pub fn set_deployment_config_name(self, input: Option<String>) -> Self

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.

pub fn description(self, input: impl Into<String>) -> Self

A comment about the deployment.

pub fn set_description(self, input: Option<String>) -> Self

A comment about the deployment.

pub fn ignore_application_stop_failures(self, input: bool) -> Self

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.

pub fn set_ignore_application_stop_failures(self, input: Option<bool>) -> Self

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.

pub fn target_instances(self, input: TargetInstances) -> Self

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

pub fn set_target_instances(self, input: Option<TargetInstances>) -> Self

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

pub fn auto_rollback_configuration(
    self,
    input: AutoRollbackConfiguration
) -> Self

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

pub fn set_auto_rollback_configuration(
    self,
    input: Option<AutoRollbackConfiguration>
) -> Self

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

pub fn update_outdated_instances_only(self, input: bool) -> Self

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

pub fn set_update_outdated_instances_only(self, input: Option<bool>) -> Self

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

pub fn file_exists_behavior(self, input: FileExistsBehavior) -> Self

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.

pub fn set_file_exists_behavior(self, input: Option<FileExistsBehavior>) -> Self

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.

Trait Implementations

impl Clone for CreateDeployment

fn clone(&self) -> CreateDeployment

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateDeployment

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.