Struct aws_sdk_codedeploy::operation::create_deployment::CreateDeploymentInput

#[non_exhaustive]
pub struct CreateDeploymentInput {
    pub application_name: Option<String>,
    pub deployment_group_name: Option<String>,
    pub revision: Option<RevisionLocation>,
    pub deployment_config_name: Option<String>,
    pub description: Option<String>,
    pub ignore_application_stop_failures: Option<bool>,
    pub target_instances: Option<TargetInstances>,
    pub auto_rollback_configuration: Option<AutoRollbackConfiguration>,
    pub update_outdated_instances_only: Option<bool>,
    pub file_exists_behavior: Option<FileExistsBehavior>,
    pub override_alarm_configuration: Option<AlarmConfiguration>,
}

Represents the input of a CreateDeployment operation.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

application_name: Option<String>

The name of an CodeDeploy application associated with the user or Amazon Web Services account.

deployment_group_name: Option<String>

The name of the deployment group.

revision: Option<RevisionLocation>

The type and location of the revision to deploy.

deployment_config_name: Option<String>

The name of a deployment configuration associated with the user or Amazon Web Services 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.

description: Option<String>

A comment about the deployment.

ignore_application_stop_failures: Option<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 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.

target_instances: Option<TargetInstances>

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

auto_rollback_configuration: Option<AutoRollbackConfiguration>

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

update_outdated_instances_only: Option<bool>

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

file_exists_behavior: Option<FileExistsBehavior>

Information about how 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.

override_alarm_configuration: Option<AlarmConfiguration>

Allows you to specify information about alarms associated with a deployment. The alarm configuration that you specify here will override the alarm configuration at the deployment group level. Consider overriding the alarm configuration if you have set up alarms at the deployment group level that are causing deployment failures. In this case, you would call CreateDeployment to create a new deployment that uses a previous application revision that is known to work, and set its alarm configuration to turn off alarm polling. Turning off alarm polling ensures that the new deployment proceeds without being blocked by the alarm that was generated by the previous, failed, deployment.

If you specify an overrideAlarmConfiguration, you need the UpdateDeploymentGroup IAM permission when calling CreateDeployment.

Implementations

impl CreateDeploymentInput

pub fn application_name(&self) -> Option<&str>

The name of an CodeDeploy application associated with the user or Amazon Web Services account.

pub fn deployment_group_name(&self) -> Option<&str>

The name of the deployment group.

pub fn revision(&self) -> Option<&RevisionLocation>

The type and location of the revision to deploy.

pub fn deployment_config_name(&self) -> Option<&str>

The name of a deployment configuration associated with the user or Amazon Web Services 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) -> Option<&str>

A comment about the deployment.

pub fn ignore_application_stop_failures(&self) -> Option<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 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) -> Option<&TargetInstances>

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

pub fn auto_rollback_configuration(&self) -> Option<&AutoRollbackConfiguration>

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

pub fn update_outdated_instances_only(&self) -> Option<bool>

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) -> Option<&FileExistsBehavior>

Information about how 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 override_alarm_configuration(&self) -> Option<&AlarmConfiguration>

Allows you to specify information about alarms associated with a deployment. The alarm configuration that you specify here will override the alarm configuration at the deployment group level. Consider overriding the alarm configuration if you have set up alarms at the deployment group level that are causing deployment failures. In this case, you would call CreateDeployment to create a new deployment that uses a previous application revision that is known to work, and set its alarm configuration to turn off alarm polling. Turning off alarm polling ensures that the new deployment proceeds without being blocked by the alarm that was generated by the previous, failed, deployment.

If you specify an overrideAlarmConfiguration, you need the UpdateDeploymentGroup IAM permission when calling CreateDeployment.

impl CreateDeploymentInput

pub fn builder() -> CreateDeploymentInputBuilder

Creates a new builder-style object to manufacture CreateDeploymentInput.

Trait Implementations

impl Clone for CreateDeploymentInput

fn clone(&self) -> CreateDeploymentInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateDeploymentInput

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

Formats the value using the given formatter.

impl PartialEq for CreateDeploymentInput

fn eq(&self, other: &CreateDeploymentInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateDeploymentInput