Struct aws_sdk_codedeploy::model::deployment_info::Builder

pub struct Builder { /* private fields */ }

A builder for DeploymentInfo.

Implementations

impl Builder

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

The application name.

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

The application name.

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

The deployment group name.

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

The deployment group name.

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

The deployment configuration name.

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

The deployment configuration name.

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

The unique ID of a deployment.

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

The unique ID of a deployment.

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

Information about the application revision that was deployed to the deployment group before the most recent successful deployment.

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

Information about the application revision that was deployed to the deployment group before the most recent successful deployment.

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

Information about the location of stored application artifacts and the service from which to retrieve them.

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

Information about the location of stored application artifacts and the service from which to retrieve them.

pub fn status(self, input: DeploymentStatus) -> Self

The current state of the deployment as a whole.

pub fn set_status(self, input: Option<DeploymentStatus>) -> Self

The current state of the deployment as a whole.

pub fn error_information(self, input: ErrorInformation) -> Self

Information about any error associated with this deployment.

pub fn set_error_information(self, input: Option<ErrorInformation>) -> Self

Information about any error associated with this deployment.

pub fn create_time(self, input: DateTime) -> Self

A timestamp that indicates when the deployment was created.

pub fn set_create_time(self, input: Option<DateTime>) -> Self

A timestamp that indicates when the deployment was created.

pub fn start_time(self, input: DateTime) -> Self

A timestamp that indicates when the deployment was deployed to the deployment group.

In some cases, the reported value of the start time might be later than the complete time. This is due to differences in the clock settings of backend servers that participate in the deployment process.

pub fn set_start_time(self, input: Option<DateTime>) -> Self

A timestamp that indicates when the deployment was deployed to the deployment group.

In some cases, the reported value of the start time might be later than the complete time. This is due to differences in the clock settings of backend servers that participate in the deployment process.

pub fn complete_time(self, input: DateTime) -> Self

A timestamp that indicates when the deployment was complete.

pub fn set_complete_time(self, input: Option<DateTime>) -> Self

A timestamp that indicates when the deployment was complete.

pub fn deployment_overview(self, input: DeploymentOverview) -> Self

A summary of the deployment status of the instances in the deployment.

pub fn set_deployment_overview(self, input: Option<DeploymentOverview>) -> Self

A summary of the deployment status of the instances in the deployment.

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 creator(self, input: DeploymentCreator) -> Self

The means by which the deployment was created:

• user: A user created the deployment.

• autoscaling: Amazon EC2 Auto Scaling created the deployment.

• codeDeployRollback: A rollback process created the deployment.

• CodeDeployAutoUpdate: An auto-update process created the deployment when it detected outdated Amazon EC2 instances.

pub fn set_creator(self, input: Option<DeploymentCreator>) -> Self

The means by which the deployment was created:

• user: A user created the deployment.

• autoscaling: Amazon EC2 Auto Scaling created the deployment.

• codeDeployRollback: A rollback process created the deployment.

• CodeDeployAutoUpdate: An auto-update process created the deployment when it detected outdated Amazon EC2 instances.

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 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 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 auto_rollback_configuration(
    self,
    input: AutoRollbackConfiguration
) -> Self

Information about the automatic rollback configuration associated with the deployment.

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

Information about the automatic rollback configuration associated with the deployment.

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

Indicates whether only instances that are not running the latest application revision are to be deployed to.

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

Indicates whether only instances that are not running the latest application revision are to be deployed to.

pub fn rollback_info(self, input: RollbackInfo) -> Self

Information about a deployment rollback.

pub fn set_rollback_info(self, input: Option<RollbackInfo>) -> Self

Information about a deployment rollback.

pub fn deployment_style(self, input: DeploymentStyle) -> Self

Information about the type of deployment, either in-place or blue/green, you want to run and whether to route deployment traffic behind a load balancer.

pub fn set_deployment_style(self, input: Option<DeploymentStyle>) -> Self

Information about the type of deployment, either in-place or blue/green, you want to run and whether to route deployment traffic behind a load balancer.

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 instance_termination_wait_time_started(self, input: bool) -> Self

Indicates whether the wait period set for the termination of instances in the original environment has started. Status is 'false' if the KEEP_ALIVE option is specified. Otherwise, 'true' as soon as the termination wait period starts.

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

Indicates whether the wait period set for the termination of instances in the original environment has started. Status is 'false' if the KEEP_ALIVE option is specified. Otherwise, 'true' as soon as the termination wait period starts.

pub fn blue_green_deployment_configuration(
    self,
    input: BlueGreenDeploymentConfiguration
) -> Self

Information about blue/green deployment options for this deployment.

pub fn set_blue_green_deployment_configuration(
    self,
    input: Option<BlueGreenDeploymentConfiguration>
) -> Self

Information about blue/green deployment options for this deployment.

pub fn load_balancer_info(self, input: LoadBalancerInfo) -> Self

Information about the load balancer used in the deployment.

pub fn set_load_balancer_info(self, input: Option<LoadBalancerInfo>) -> Self

Information about the load balancer used in the deployment.

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

Provides information about the results of a deployment, such as whether instances in the original environment in a blue/green deployment were not terminated.

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

Provides information about the results of a deployment, such as whether instances in the original environment in a blue/green deployment were not terminated.

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

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

• 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 CodeDeploy handles files that already exist in a deployment target location but weren't part of the previous successful deployment.

• 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 deployment_status_messages(self, input: impl Into<String>) -> Self

Appends an item to deployment_status_messages.

To override the contents of this collection use set_deployment_status_messages.

Messages that contain information about the status of a deployment.

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

Messages that contain information about the status of a deployment.

pub fn compute_platform(self, input: ComputePlatform) -> Self

The destination platform type for the deployment (Lambda, Server, or ECS).

pub fn set_compute_platform(self, input: Option<ComputePlatform>) -> Self

The destination platform type for the deployment (Lambda, Server, or ECS).

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

The unique ID for an external resource (for example, a CloudFormation stack ID) that is linked to this deployment.

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

The unique ID for an external resource (for example, a CloudFormation stack ID) that is linked to this deployment.

pub fn related_deployments(self, input: RelatedDeployments) -> Self

Information about deployments related to the specified deployment.

pub fn set_related_deployments(self, input: Option<RelatedDeployments>) -> Self

Information about deployments related to the specified deployment.

pub fn override_alarm_configuration(self, input: AlarmConfiguration) -> Self

Information about alarms associated with a deployment or deployment group.

pub fn set_override_alarm_configuration(
    self,
    input: Option<AlarmConfiguration>
) -> Self

Information about alarms associated with a deployment or deployment group.

pub fn build(self) -> DeploymentInfo

Consumes the builder and constructs a DeploymentInfo.

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.

impl PartialEq<Builder> for Builder

fn eq(&self, other: &Builder) -> 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 Builder