Struct aws_sdk_codedeploy::operation::update_deployment_group::UpdateDeploymentGroupInput

#[non_exhaustive]
pub struct UpdateDeploymentGroupInput {

    pub application_name: Option<String>,
    pub current_deployment_group_name: Option<String>,
    pub new_deployment_group_name: Option<String>,
    pub deployment_config_name: Option<String>,
    pub ec2_tag_filters: Option<Vec<Ec2TagFilter>>,
    pub on_premises_instance_tag_filters: Option<Vec<TagFilter>>,
    pub auto_scaling_groups: Option<Vec<String>>,
    pub service_role_arn: Option<String>,
    pub trigger_configurations: Option<Vec<TriggerConfig>>,
    pub alarm_configuration: Option<AlarmConfiguration>,
    pub auto_rollback_configuration: Option<AutoRollbackConfiguration>,
    pub outdated_instances_strategy: Option<OutdatedInstancesStrategy>,
    pub deployment_style: Option<DeploymentStyle>,
    pub blue_green_deployment_configuration: Option<BlueGreenDeploymentConfiguration>,
    pub load_balancer_info: Option<LoadBalancerInfo>,
    pub ec2_tag_set: Option<Ec2TagSet>,
    pub ecs_services: Option<Vec<EcsService>>,
    pub on_premises_tag_set: Option<OnPremisesTagSet>,
    pub termination_hook_enabled: Option<bool>,
}

Represents the input of an UpdateDeploymentGroup 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 application name that corresponds to the deployment group to update.

current_deployment_group_name: Option<String>

The current name of the deployment group.

new_deployment_group_name: Option<String>

The new name of the deployment group, if you want to change it.

deployment_config_name: Option<String>

The replacement deployment configuration name to use, if you want to change it.

ec2_tag_filters: Option<Vec<Ec2TagFilter>>

The replacement set of Amazon EC2 tags on which to filter, if you want to change them. To keep the existing tags, enter their names. To remove tags, do not enter any tag names.

on_premises_instance_tag_filters: Option<Vec<TagFilter>>

The replacement set of on-premises instance tags on which to filter, if you want to change them. To keep the existing tags, enter their names. To remove tags, do not enter any tag names.

auto_scaling_groups: Option<Vec<String>>

The replacement list of Auto Scaling groups to be included in the deployment group, if you want to change them.

• To keep the Auto Scaling groups, enter their names or do not specify this parameter.

• To remove Auto Scaling groups, specify a non-null empty list of Auto Scaling group names to detach all CodeDeploy-managed Auto Scaling lifecycle hooks. For examples, see Amazon EC2 instances in an Amazon EC2 Auto Scaling group fail to launch and receive the error "Heartbeat Timeout" in the CodeDeploy User Guide.

service_role_arn: Option<String>

A replacement ARN for the service role, if you want to change it.

trigger_configurations: Option<Vec<TriggerConfig>>

Information about triggers to change when the deployment group is updated. For examples, see Edit a Trigger in a CodeDeploy Deployment Group in the CodeDeploy User Guide.

alarm_configuration: Option<AlarmConfiguration>

Information to add or change about Amazon CloudWatch alarms when the deployment group is updated.

auto_rollback_configuration: Option<AutoRollbackConfiguration>

Information for an automatic rollback configuration that is added or changed when a deployment group is updated.

outdated_instances_strategy: Option<OutdatedInstancesStrategy>

Indicates what happens when new Amazon EC2 instances are launched mid-deployment and do not receive the deployed application revision.

If this option is set to UPDATE or is unspecified, CodeDeploy initiates one or more 'auto-update outdated instances' deployments to apply the deployed application revision to the new Amazon EC2 instances.

If this option is set to IGNORE, CodeDeploy does not initiate a deployment to update the new Amazon EC2 instances. This may result in instances having different revisions.

deployment_style: Option<DeploymentStyle>

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.

blue_green_deployment_configuration: Option<BlueGreenDeploymentConfiguration>

Information about blue/green deployment options for a deployment group.

load_balancer_info: Option<LoadBalancerInfo>

Information about the load balancer used in a deployment.

ec2_tag_set: Option<Ec2TagSet>

Information about groups of tags applied to on-premises instances. The deployment group includes only Amazon EC2 instances identified by all the tag groups.

ecs_services: Option<Vec<EcsService>>

The target Amazon ECS services in the deployment group. This applies only to deployment groups that use the Amazon ECS compute platform. A target Amazon ECS service is specified as an Amazon ECS cluster and service name pair using the format : .

on_premises_tag_set: Option<OnPremisesTagSet>

Information about an on-premises instance tag set. The deployment group includes only on-premises instances identified by all the tag groups.

termination_hook_enabled: Option<bool>

This parameter only applies if you are using CodeDeploy with Amazon EC2 Auto Scaling. For more information, see Integrating CodeDeploy with Amazon EC2 Auto Scaling in the CodeDeploy User Guide.

Set terminationHookEnabled to true to have CodeDeploy install a termination hook into your Auto Scaling group when you update a deployment group. When this hook is installed, CodeDeploy will perform termination deployments.

For information about termination deployments, see Enabling termination deployments during Auto Scaling scale-in events in the CodeDeploy User Guide.

For more information about Auto Scaling scale-in events, see the Scale in topic in the Amazon EC2 Auto Scaling User Guide.

Implementations

impl UpdateDeploymentGroupInput

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

The application name that corresponds to the deployment group to update.

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

The current name of the deployment group.

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

The new name of the deployment group, if you want to change it.

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

The replacement deployment configuration name to use, if you want to change it.

pub fn ec2_tag_filters(&self) -> &[Ec2TagFilter]

The replacement set of Amazon EC2 tags on which to filter, if you want to change them. To keep the existing tags, enter their names. To remove tags, do not enter any tag names.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .ec2_tag_filters.is_none().

pub fn on_premises_instance_tag_filters(&self) -> &[TagFilter]

The replacement set of on-premises instance tags on which to filter, if you want to change them. To keep the existing tags, enter their names. To remove tags, do not enter any tag names.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .on_premises_instance_tag_filters.is_none().

pub fn auto_scaling_groups(&self) -> &[String]

The replacement list of Auto Scaling groups to be included in the deployment group, if you want to change them.

• To keep the Auto Scaling groups, enter their names or do not specify this parameter.

• To remove Auto Scaling groups, specify a non-null empty list of Auto Scaling group names to detach all CodeDeploy-managed Auto Scaling lifecycle hooks. For examples, see Amazon EC2 instances in an Amazon EC2 Auto Scaling group fail to launch and receive the error "Heartbeat Timeout" in the CodeDeploy User Guide.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .auto_scaling_groups.is_none().

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

A replacement ARN for the service role, if you want to change it.

pub fn trigger_configurations(&self) -> &[TriggerConfig]

Information about triggers to change when the deployment group is updated. For examples, see Edit a Trigger in a CodeDeploy Deployment Group in the CodeDeploy User Guide.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .trigger_configurations.is_none().

pub fn alarm_configuration(&self) -> Option<&AlarmConfiguration>

Information to add or change about Amazon CloudWatch alarms when the deployment group is updated.

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

Information for an automatic rollback configuration that is added or changed when a deployment group is updated.

pub fn outdated_instances_strategy(&self) -> Option<&OutdatedInstancesStrategy>

Indicates what happens when new Amazon EC2 instances are launched mid-deployment and do not receive the deployed application revision.

If this option is set to UPDATE or is unspecified, CodeDeploy initiates one or more 'auto-update outdated instances' deployments to apply the deployed application revision to the new Amazon EC2 instances.

If this option is set to IGNORE, CodeDeploy does not initiate a deployment to update the new Amazon EC2 instances. This may result in instances having different revisions.

pub fn deployment_style(&self) -> Option<&DeploymentStyle>

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 blue_green_deployment_configuration( &self, ) -> Option<&BlueGreenDeploymentConfiguration>

Information about blue/green deployment options for a deployment group.

pub fn load_balancer_info(&self) -> Option<&LoadBalancerInfo>

Information about the load balancer used in a deployment.

pub fn ec2_tag_set(&self) -> Option<&Ec2TagSet>

Information about groups of tags applied to on-premises instances. The deployment group includes only Amazon EC2 instances identified by all the tag groups.

pub fn ecs_services(&self) -> &[EcsService]

The target Amazon ECS services in the deployment group. This applies only to deployment groups that use the Amazon ECS compute platform. A target Amazon ECS service is specified as an Amazon ECS cluster and service name pair using the format : .

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .ecs_services.is_none().

pub fn on_premises_tag_set(&self) -> Option<&OnPremisesTagSet>

Information about an on-premises instance tag set. The deployment group includes only on-premises instances identified by all the tag groups.

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

This parameter only applies if you are using CodeDeploy with Amazon EC2 Auto Scaling. For more information, see Integrating CodeDeploy with Amazon EC2 Auto Scaling in the CodeDeploy User Guide.

Set terminationHookEnabled to true to have CodeDeploy install a termination hook into your Auto Scaling group when you update a deployment group. When this hook is installed, CodeDeploy will perform termination deployments.

For information about termination deployments, see Enabling termination deployments during Auto Scaling scale-in events in the CodeDeploy User Guide.

For more information about Auto Scaling scale-in events, see the Scale in topic in the Amazon EC2 Auto Scaling User Guide.

impl UpdateDeploymentGroupInput

pub fn builder() -> UpdateDeploymentGroupInputBuilder

Creates a new builder-style object to manufacture UpdateDeploymentGroupInput.

Trait Implementations

impl Clone for UpdateDeploymentGroupInput

fn clone(&self) -> UpdateDeploymentGroupInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateDeploymentGroupInput

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

Formats the value using the given formatter.

impl PartialEq for UpdateDeploymentGroupInput

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