Struct aws_sdk_codedeploy::client::Client
source · pub struct Client { /* private fields */ }
Expand description
Client for AWS CodeDeploy
Client for invoking operations on AWS CodeDeploy. Each operation on AWS CodeDeploy is a method on this
this struct. .send()
MUST be invoked on the generated operations to dispatch the request to the service.
Examples
Constructing a client and invoking an operation
// create a shared configuration. This can be used & shared between multiple service clients.
let shared_config = aws_config::load_from_env().await;
let client = aws_sdk_codedeploy::Client::new(&shared_config);
// invoke an operation
/* let rsp = client
.<operation_name>().
.<param>("some value")
.send().await; */
Constructing a client with custom configuration
use aws_config::retry::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_codedeploy::config::Builder::from(&shared_config)
.retry_config(RetryConfig::disabled())
.build();
let client = aws_sdk_codedeploy::Client::from_conf(config);
Implementations§
source§impl Client
impl Client
sourcepub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
pub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
Creates a client with the given service configuration.
source§impl Client
impl Client
Constructs a fluent builder for the AddTagsToOnPremisesInstances
operation.
- The fluent builder is configurable:
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:The tag key-value pairs to add to the on-premises instances.
Keys and values are both required. Keys cannot be null or empty strings. Value-only tags are not allowed.
instance_names(Vec<String>)
/set_instance_names(Option<Vec<String>>)
:The names of the on-premises instances to which to add tags.
- On success, responds with
AddTagsToOnPremisesInstancesOutput
- On failure, responds with
SdkError<AddTagsToOnPremisesInstancesError>
sourcepub fn batch_get_application_revisions(&self) -> BatchGetApplicationRevisions
pub fn batch_get_application_revisions(&self) -> BatchGetApplicationRevisions
Constructs a fluent builder for the BatchGetApplicationRevisions
operation.
- The fluent builder is configurable:
application_name(impl Into<String>)
/set_application_name(Option<String>)
:The name of an CodeDeploy application about which to get revision information.
revisions(Vec<RevisionLocation>)
/set_revisions(Option<Vec<RevisionLocation>>)
:An array of
RevisionLocation
objects that specify information to get about the application revisions, including type and location. The maximum number ofRevisionLocation
objects you can specify is 25.
- On success, responds with
BatchGetApplicationRevisionsOutput
with field(s):application_name(Option<String>)
:The name of the application that corresponds to the revisions.
error_message(Option<String>)
:Information about errors that might have occurred during the API call.
revisions(Option<Vec<RevisionInfo>>)
:Additional information about the revisions, including the type and location.
- On failure, responds with
SdkError<BatchGetApplicationRevisionsError>
sourcepub fn batch_get_applications(&self) -> BatchGetApplications
pub fn batch_get_applications(&self) -> BatchGetApplications
Constructs a fluent builder for the BatchGetApplications
operation.
- The fluent builder is configurable:
application_names(Vec<String>)
/set_application_names(Option<Vec<String>>)
:A list of application names separated by spaces. The maximum number of application names you can specify is 100.
- On success, responds with
BatchGetApplicationsOutput
with field(s):applications_info(Option<Vec<ApplicationInfo>>)
:Information about the applications.
- On failure, responds with
SdkError<BatchGetApplicationsError>
sourcepub fn batch_get_deployment_groups(&self) -> BatchGetDeploymentGroups
pub fn batch_get_deployment_groups(&self) -> BatchGetDeploymentGroups
Constructs a fluent builder for the BatchGetDeploymentGroups
operation.
- The fluent builder is configurable:
application_name(impl Into<String>)
/set_application_name(Option<String>)
:The name of an CodeDeploy application associated with the applicable IAM or Amazon Web Services account.
deployment_group_names(Vec<String>)
/set_deployment_group_names(Option<Vec<String>>)
:The names of the deployment groups.
- On success, responds with
BatchGetDeploymentGroupsOutput
with field(s):deployment_groups_info(Option<Vec<DeploymentGroupInfo>>)
:Information about the deployment groups.
error_message(Option<String>)
:Information about errors that might have occurred during the API call.
- On failure, responds with
SdkError<BatchGetDeploymentGroupsError>
sourcepub fn batch_get_deployment_instances(&self) -> BatchGetDeploymentInstances
pub fn batch_get_deployment_instances(&self) -> BatchGetDeploymentInstances
Constructs a fluent builder for the BatchGetDeploymentInstances
operation.
- The fluent builder is configurable:
deployment_id(impl Into<String>)
/set_deployment_id(Option<String>)
:The unique ID of a deployment.
instance_ids(Vec<String>)
/set_instance_ids(Option<Vec<String>>)
:The unique IDs of instances used in the deployment. The maximum number of instance IDs you can specify is 25.
- On success, responds with
BatchGetDeploymentInstancesOutput
with field(s):instances_summary(Option<Vec<InstanceSummary>>)
:Information about the instance.
error_message(Option<String>)
:Information about errors that might have occurred during the API call.
- On failure, responds with
SdkError<BatchGetDeploymentInstancesError>
sourcepub fn batch_get_deployments(&self) -> BatchGetDeployments
pub fn batch_get_deployments(&self) -> BatchGetDeployments
Constructs a fluent builder for the BatchGetDeployments
operation.
- The fluent builder is configurable:
deployment_ids(Vec<String>)
/set_deployment_ids(Option<Vec<String>>)
:A list of deployment IDs, separated by spaces. The maximum number of deployment IDs you can specify is 25.
- On success, responds with
BatchGetDeploymentsOutput
with field(s):deployments_info(Option<Vec<DeploymentInfo>>)
:Information about the deployments.
- On failure, responds with
SdkError<BatchGetDeploymentsError>
sourcepub fn batch_get_deployment_targets(&self) -> BatchGetDeploymentTargets
pub fn batch_get_deployment_targets(&self) -> BatchGetDeploymentTargets
Constructs a fluent builder for the BatchGetDeploymentTargets
operation.
- The fluent builder is configurable:
deployment_id(impl Into<String>)
/set_deployment_id(Option<String>)
:The unique ID of a deployment.
target_ids(Vec<String>)
/set_target_ids(Option<Vec<String>>)
:The unique IDs of the deployment targets. The compute platform of the deployment determines the type of the targets and their formats. The maximum number of deployment target IDs you can specify is 25.
-
For deployments that use the EC2/On-premises compute platform, the target IDs are Amazon EC2 or on-premises instances IDs, and their target type is
instanceTarget
. -
For deployments that use the Lambda compute platform, the target IDs are the names of Lambda functions, and their target type is
instanceTarget
. -
For deployments that use the Amazon ECS compute platform, the target IDs are pairs of Amazon ECS clusters and services specified using the format
: ecsTarget
. -
For deployments that are deployed with CloudFormation, the target IDs are CloudFormation stack IDs. Their target type is
cloudFormationTarget
.
-
- On success, responds with
BatchGetDeploymentTargetsOutput
with field(s):deployment_targets(Option<Vec<DeploymentTarget>>)
:A list of target objects for a deployment. Each target object contains details about the target, such as its status and lifecycle events. The type of the target objects depends on the deployment’ compute platform.
-
EC2/On-premises: Each target object is an Amazon EC2 or on-premises instance.
-
Lambda: The target object is a specific version of an Lambda function.
-
Amazon ECS: The target object is an Amazon ECS service.
-
CloudFormation: The target object is an CloudFormation blue/green deployment.
-
- On failure, responds with
SdkError<BatchGetDeploymentTargetsError>
sourcepub fn batch_get_on_premises_instances(&self) -> BatchGetOnPremisesInstances
pub fn batch_get_on_premises_instances(&self) -> BatchGetOnPremisesInstances
Constructs a fluent builder for the BatchGetOnPremisesInstances
operation.
- The fluent builder is configurable:
instance_names(Vec<String>)
/set_instance_names(Option<Vec<String>>)
:The names of the on-premises instances about which to get information. The maximum number of instance names you can specify is 25.
- On success, responds with
BatchGetOnPremisesInstancesOutput
with field(s):instance_infos(Option<Vec<InstanceInfo>>)
:Information about the on-premises instances.
- On failure, responds with
SdkError<BatchGetOnPremisesInstancesError>
sourcepub fn continue_deployment(&self) -> ContinueDeployment
pub fn continue_deployment(&self) -> ContinueDeployment
Constructs a fluent builder for the ContinueDeployment
operation.
- The fluent builder is configurable:
deployment_id(impl Into<String>)
/set_deployment_id(Option<String>)
:The unique ID of a blue/green deployment for which you want to start rerouting traffic to the replacement environment.
deployment_wait_type(DeploymentWaitType)
/set_deployment_wait_type(Option<DeploymentWaitType>)
:The status of the deployment’s waiting period.
READY_WAIT
indicates that the deployment is ready to start shifting traffic.TERMINATION_WAIT
indicates that the traffic is shifted, but the original target is not terminated.
- On success, responds with
ContinueDeploymentOutput
- On failure, responds with
SdkError<ContinueDeploymentError>
sourcepub fn create_application(&self) -> CreateApplication
pub fn create_application(&self) -> CreateApplication
Constructs a fluent builder for the CreateApplication
operation.
- The fluent builder is configurable:
application_name(impl Into<String>)
/set_application_name(Option<String>)
:The name of the application. This name must be unique with the applicable IAM or Amazon Web Services account.
compute_platform(ComputePlatform)
/set_compute_platform(Option<ComputePlatform>)
:The destination platform type for the deployment (
Lambda
,Server
, orECS
).tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:The metadata that you apply to CodeDeploy applications to help you organize and categorize them. Each tag consists of a key and an optional value, both of which you define.
- On success, responds with
CreateApplicationOutput
with field(s):application_id(Option<String>)
:A unique application ID.
- On failure, responds with
SdkError<CreateApplicationError>
sourcepub fn create_deployment(&self) -> CreateDeployment
pub fn create_deployment(&self) -> CreateDeployment
Constructs a fluent builder for the CreateDeployment
operation.
- The fluent builder is configurable:
application_name(impl Into<String>)
/set_application_name(Option<String>)
:The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.
deployment_group_name(impl Into<String>)
/set_deployment_group_name(Option<String>)
:The name of the deployment group.
revision(RevisionLocation)
/set_revision(Option<RevisionLocation>)
:The type and location of the revision to deploy.
deployment_config_name(impl Into<String>)
/set_deployment_config_name(Option<String>)
:The name of a deployment configuration associated with the IAM 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(impl Into<String>)
/set_description(Option<String>)
:A comment about the deployment.
ignore_application_stop_failures(bool)
/set_ignore_application_stop_failures(bool)
:If true, then if an
ApplicationStop
,BeforeBlockTraffic
, orAfterBlockTraffic
deployment lifecycle event to an instance fails, then the deployment continues to the next deployment lifecycle event. For example, ifApplicationStop
fails, the deployment continues withDownloadBundle
. IfBeforeBlockTraffic
fails, the deployment continues withBlockTraffic
. IfAfterBlockTraffic
fails, the deployment continues withApplicationStop
.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
, andAfterBlockTraffic
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 theApplicationStop
,BeforeBlockTraffic
, andAfterBlockTraffic
failures should be ignored.target_instances(TargetInstances)
/set_target_instances(Option<TargetInstances>)
:Information about the instances that belong to the replacement environment in a blue/green deployment.
auto_rollback_configuration(AutoRollbackConfiguration)
/set_auto_rollback_configuration(Option<AutoRollbackConfiguration>)
:Configuration information for an automatic rollback that is added when a deployment is created.
update_outdated_instances_only(bool)
/set_update_outdated_instances_only(bool)
:Indicates whether to deploy to all instances or only to instances that are not running the latest application revision.
file_exists_behavior(FileExistsBehavior)
/set_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(AlarmConfiguration)
/set_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 theUpdateDeploymentGroup
IAM permission when callingCreateDeployment
.
- On success, responds with
CreateDeploymentOutput
with field(s):deployment_id(Option<String>)
:The unique ID of a deployment.
- On failure, responds with
SdkError<CreateDeploymentError>
sourcepub fn create_deployment_config(&self) -> CreateDeploymentConfig
pub fn create_deployment_config(&self) -> CreateDeploymentConfig
Constructs a fluent builder for the CreateDeploymentConfig
operation.
- The fluent builder is configurable:
deployment_config_name(impl Into<String>)
/set_deployment_config_name(Option<String>)
:The name of the deployment configuration to create.
minimum_healthy_hosts(MinimumHealthyHosts)
/set_minimum_healthy_hosts(Option<MinimumHealthyHosts>)
:The minimum number of healthy instances that should be available at any time during the deployment. There are two parameters expected in the input: type and value.
The type parameter takes either of the following values:
-
HOST_COUNT: The value parameter represents the minimum number of healthy instances as an absolute value.
-
FLEET_PERCENT: The value parameter represents the minimum number of healthy instances as a percentage of the total number of instances in the deployment. If you specify FLEET_PERCENT, at the start of the deployment, CodeDeploy converts the percentage to the equivalent number of instances and rounds up fractional instances.
The value parameter takes an integer.
For example, to set a minimum of 95% healthy instance, specify a type of FLEET_PERCENT and a value of 95.
-
traffic_routing_config(TrafficRoutingConfig)
/set_traffic_routing_config(Option<TrafficRoutingConfig>)
:The configuration that specifies how the deployment traffic is routed.
compute_platform(ComputePlatform)
/set_compute_platform(Option<ComputePlatform>)
:The destination platform type for the deployment (
Lambda
,Server
, orECS
).
- On success, responds with
CreateDeploymentConfigOutput
with field(s):deployment_config_id(Option<String>)
:A unique deployment configuration ID.
- On failure, responds with
SdkError<CreateDeploymentConfigError>
sourcepub fn create_deployment_group(&self) -> CreateDeploymentGroup
pub fn create_deployment_group(&self) -> CreateDeploymentGroup
Constructs a fluent builder for the CreateDeploymentGroup
operation.
- The fluent builder is configurable:
application_name(impl Into<String>)
/set_application_name(Option<String>)
:The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.
deployment_group_name(impl Into<String>)
/set_deployment_group_name(Option<String>)
:The name of a new deployment group for the specified application.
deployment_config_name(impl Into<String>)
/set_deployment_config_name(Option<String>)
:If specified, the deployment configuration name can be either one of the predefined configurations provided with CodeDeploy or a custom deployment configuration that you create by calling the create deployment configuration operation.
CodeDeployDefault.OneAtATime
is the default deployment configuration. It is used if a configuration isn’t specified for the deployment or deployment group.For more information about the predefined deployment configurations in CodeDeploy, see Working with Deployment Configurations in CodeDeploy in the CodeDeploy User Guide.
ec2_tag_filters(Vec<Ec2TagFilter>)
/set_ec2_tag_filters(Option<Vec<Ec2TagFilter>>)
:The Amazon EC2 tags on which to filter. The deployment group includes Amazon EC2 instances with any of the specified tags. Cannot be used in the same call as ec2TagSet.
on_premises_instance_tag_filters(Vec<TagFilter>)
/set_on_premises_instance_tag_filters(Option<Vec<TagFilter>>)
:The on-premises instance tags on which to filter. The deployment group includes on-premises instances with any of the specified tags. Cannot be used in the same call as
OnPremisesTagSet
.auto_scaling_groups(Vec<String>)
/set_auto_scaling_groups(Option<Vec<String>>)
:A list of associated Amazon EC2 Auto Scaling groups.
service_role_arn(impl Into<String>)
/set_service_role_arn(Option<String>)
:A service role Amazon Resource Name (ARN) that allows CodeDeploy to act on the user’s behalf when interacting with Amazon Web Services services.
trigger_configurations(Vec<TriggerConfig>)
/set_trigger_configurations(Option<Vec<TriggerConfig>>)
:Information about triggers to create when the deployment group is created. For examples, see Create a Trigger for an CodeDeploy Event in the CodeDeploy User Guide.
alarm_configuration(AlarmConfiguration)
/set_alarm_configuration(Option<AlarmConfiguration>)
:Information to add about Amazon CloudWatch alarms when the deployment group is created.
auto_rollback_configuration(AutoRollbackConfiguration)
/set_auto_rollback_configuration(Option<AutoRollbackConfiguration>)
:Configuration information for an automatic rollback that is added when a deployment group is created.
outdated_instances_strategy(OutdatedInstancesStrategy)
/set_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(DeploymentStyle)
/set_deployment_style(Option<DeploymentStyle>)
:Information about the type of deployment, in-place or blue/green, that you want to run and whether to route deployment traffic behind a load balancer.
blue_green_deployment_configuration(BlueGreenDeploymentConfiguration)
/set_blue_green_deployment_configuration(Option<BlueGreenDeploymentConfiguration>)
:Information about blue/green deployment options for a deployment group.
load_balancer_info(LoadBalancerInfo)
/set_load_balancer_info(Option<LoadBalancerInfo>)
:Information about the load balancer used in a deployment.
ec2_tag_set(Ec2TagSet)
/set_ec2_tag_set(Option<Ec2TagSet>)
:Information about groups of tags applied to Amazon EC2 instances. The deployment group includes only Amazon EC2 instances identified by all the tag groups. Cannot be used in the same call as
ec2TagFilters
.ecs_services(Vec<EcsService>)
/set_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(OnPremisesTagSet)
/set_on_premises_tag_set(Option<OnPremisesTagSet>)
:Information about groups of tags applied to on-premises instances. The deployment group includes only on-premises instances identified by all of the tag groups. Cannot be used in the same call as
onPremisesInstanceTagFilters
.tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:The metadata that you apply to CodeDeploy deployment groups to help you organize and categorize them. Each tag consists of a key and an optional value, both of which you define.
- On success, responds with
CreateDeploymentGroupOutput
with field(s):deployment_group_id(Option<String>)
:A unique deployment group ID.
- On failure, responds with
SdkError<CreateDeploymentGroupError>
sourcepub fn delete_application(&self) -> DeleteApplication
pub fn delete_application(&self) -> DeleteApplication
Constructs a fluent builder for the DeleteApplication
operation.
- The fluent builder is configurable:
application_name(impl Into<String>)
/set_application_name(Option<String>)
:The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.
- On success, responds with
DeleteApplicationOutput
- On failure, responds with
SdkError<DeleteApplicationError>
sourcepub fn delete_deployment_config(&self) -> DeleteDeploymentConfig
pub fn delete_deployment_config(&self) -> DeleteDeploymentConfig
Constructs a fluent builder for the DeleteDeploymentConfig
operation.
- The fluent builder is configurable:
deployment_config_name(impl Into<String>)
/set_deployment_config_name(Option<String>)
:The name of a deployment configuration associated with the IAM user or Amazon Web Services account.
- On success, responds with
DeleteDeploymentConfigOutput
- On failure, responds with
SdkError<DeleteDeploymentConfigError>
sourcepub fn delete_deployment_group(&self) -> DeleteDeploymentGroup
pub fn delete_deployment_group(&self) -> DeleteDeploymentGroup
Constructs a fluent builder for the DeleteDeploymentGroup
operation.
- The fluent builder is configurable:
application_name(impl Into<String>)
/set_application_name(Option<String>)
:The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.
deployment_group_name(impl Into<String>)
/set_deployment_group_name(Option<String>)
:The name of a deployment group for the specified application.
- On success, responds with
DeleteDeploymentGroupOutput
with field(s):hooks_not_cleaned_up(Option<Vec<AutoScalingGroup>>)
:If the output contains no data, and the corresponding deployment group contained at least one Auto Scaling group, CodeDeploy successfully removed all corresponding Auto Scaling lifecycle event hooks from the Amazon EC2 instances in the Auto Scaling group. If the output contains data, CodeDeploy could not remove some Auto Scaling lifecycle event hooks from the Amazon EC2 instances in the Auto Scaling group.
- On failure, responds with
SdkError<DeleteDeploymentGroupError>
sourcepub fn delete_git_hub_account_token(&self) -> DeleteGitHubAccountToken
pub fn delete_git_hub_account_token(&self) -> DeleteGitHubAccountToken
Constructs a fluent builder for the DeleteGitHubAccountToken
operation.
- The fluent builder is configurable:
token_name(impl Into<String>)
/set_token_name(Option<String>)
:The name of the GitHub account connection to delete.
- On success, responds with
DeleteGitHubAccountTokenOutput
with field(s):token_name(Option<String>)
:The name of the GitHub account connection that was deleted.
- On failure, responds with
SdkError<DeleteGitHubAccountTokenError>
sourcepub fn delete_resources_by_external_id(&self) -> DeleteResourcesByExternalId
pub fn delete_resources_by_external_id(&self) -> DeleteResourcesByExternalId
Constructs a fluent builder for the DeleteResourcesByExternalId
operation.
- The fluent builder is configurable:
external_id(impl Into<String>)
/set_external_id(Option<String>)
:The unique ID of an external resource (for example, a CloudFormation stack ID) that is linked to one or more CodeDeploy resources.
- On success, responds with
DeleteResourcesByExternalIdOutput
- On failure, responds with
SdkError<DeleteResourcesByExternalIdError>
sourcepub fn deregister_on_premises_instance(&self) -> DeregisterOnPremisesInstance
pub fn deregister_on_premises_instance(&self) -> DeregisterOnPremisesInstance
Constructs a fluent builder for the DeregisterOnPremisesInstance
operation.
- The fluent builder is configurable:
instance_name(impl Into<String>)
/set_instance_name(Option<String>)
:The name of the on-premises instance to deregister.
- On success, responds with
DeregisterOnPremisesInstanceOutput
- On failure, responds with
SdkError<DeregisterOnPremisesInstanceError>
sourcepub fn get_application(&self) -> GetApplication
pub fn get_application(&self) -> GetApplication
Constructs a fluent builder for the GetApplication
operation.
- The fluent builder is configurable:
application_name(impl Into<String>)
/set_application_name(Option<String>)
:The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.
- On success, responds with
GetApplicationOutput
with field(s):application(Option<ApplicationInfo>)
:Information about the application.
- On failure, responds with
SdkError<GetApplicationError>
sourcepub fn get_application_revision(&self) -> GetApplicationRevision
pub fn get_application_revision(&self) -> GetApplicationRevision
Constructs a fluent builder for the GetApplicationRevision
operation.
- The fluent builder is configurable:
application_name(impl Into<String>)
/set_application_name(Option<String>)
:The name of the application that corresponds to the revision.
revision(RevisionLocation)
/set_revision(Option<RevisionLocation>)
:Information about the application revision to get, including type and location.
- On success, responds with
GetApplicationRevisionOutput
with field(s):application_name(Option<String>)
:The name of the application that corresponds to the revision.
revision(Option<RevisionLocation>)
:Additional information about the revision, including type and location.
revision_info(Option<GenericRevisionInfo>)
:General information about the revision.
- On failure, responds with
SdkError<GetApplicationRevisionError>
sourcepub fn get_deployment(&self) -> GetDeployment
pub fn get_deployment(&self) -> GetDeployment
Constructs a fluent builder for the GetDeployment
operation.
- The fluent builder is configurable:
deployment_id(impl Into<String>)
/set_deployment_id(Option<String>)
:The unique ID of a deployment associated with the IAM user or Amazon Web Services account.
- On success, responds with
GetDeploymentOutput
with field(s):deployment_info(Option<DeploymentInfo>)
:Information about the deployment.
- On failure, responds with
SdkError<GetDeploymentError>
sourcepub fn get_deployment_config(&self) -> GetDeploymentConfig
pub fn get_deployment_config(&self) -> GetDeploymentConfig
Constructs a fluent builder for the GetDeploymentConfig
operation.
- The fluent builder is configurable:
deployment_config_name(impl Into<String>)
/set_deployment_config_name(Option<String>)
:The name of a deployment configuration associated with the IAM user or Amazon Web Services account.
- On success, responds with
GetDeploymentConfigOutput
with field(s):deployment_config_info(Option<DeploymentConfigInfo>)
:Information about the deployment configuration.
- On failure, responds with
SdkError<GetDeploymentConfigError>
sourcepub fn get_deployment_group(&self) -> GetDeploymentGroup
pub fn get_deployment_group(&self) -> GetDeploymentGroup
Constructs a fluent builder for the GetDeploymentGroup
operation.
- The fluent builder is configurable:
application_name(impl Into<String>)
/set_application_name(Option<String>)
:The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.
deployment_group_name(impl Into<String>)
/set_deployment_group_name(Option<String>)
:The name of a deployment group for the specified application.
- On success, responds with
GetDeploymentGroupOutput
with field(s):deployment_group_info(Option<DeploymentGroupInfo>)
:Information about the deployment group.
- On failure, responds with
SdkError<GetDeploymentGroupError>
sourcepub fn get_deployment_instance(&self) -> GetDeploymentInstance
pub fn get_deployment_instance(&self) -> GetDeploymentInstance
Constructs a fluent builder for the GetDeploymentInstance
operation.
- The fluent builder is configurable:
deployment_id(impl Into<String>)
/set_deployment_id(Option<String>)
:The unique ID of a deployment.
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The unique ID of an instance in the deployment group.
- On success, responds with
GetDeploymentInstanceOutput
with field(s):instance_summary(Option<InstanceSummary>)
:Information about the instance.
- On failure, responds with
SdkError<GetDeploymentInstanceError>
sourcepub fn get_deployment_target(&self) -> GetDeploymentTarget
pub fn get_deployment_target(&self) -> GetDeploymentTarget
Constructs a fluent builder for the GetDeploymentTarget
operation.
- The fluent builder is configurable:
deployment_id(impl Into<String>)
/set_deployment_id(Option<String>)
:The unique ID of a deployment.
target_id(impl Into<String>)
/set_target_id(Option<String>)
:The unique ID of a deployment target.
- On success, responds with
GetDeploymentTargetOutput
with field(s):deployment_target(Option<DeploymentTarget>)
:A deployment target that contains information about a deployment such as its status, lifecycle events, and when it was last updated. It also contains metadata about the deployment target. The deployment target metadata depends on the deployment target’s type (
instanceTarget
,lambdaTarget
, orecsTarget
).
- On failure, responds with
SdkError<GetDeploymentTargetError>
sourcepub fn get_on_premises_instance(&self) -> GetOnPremisesInstance
pub fn get_on_premises_instance(&self) -> GetOnPremisesInstance
Constructs a fluent builder for the GetOnPremisesInstance
operation.
- The fluent builder is configurable:
instance_name(impl Into<String>)
/set_instance_name(Option<String>)
:The name of the on-premises instance about which to get information.
- On success, responds with
GetOnPremisesInstanceOutput
with field(s):instance_info(Option<InstanceInfo>)
:Information about the on-premises instance.
- On failure, responds with
SdkError<GetOnPremisesInstanceError>
sourcepub fn list_application_revisions(&self) -> ListApplicationRevisions
pub fn list_application_revisions(&self) -> ListApplicationRevisions
Constructs a fluent builder for the ListApplicationRevisions
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
application_name(impl Into<String>)
/set_application_name(Option<String>)
:The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.
sort_by(ApplicationRevisionSortBy)
/set_sort_by(Option<ApplicationRevisionSortBy>)
:The column name to use to sort the list results:
-
registerTime
: Sort by the time the revisions were registered with CodeDeploy. -
firstUsedTime
: Sort by the time the revisions were first used in a deployment. -
lastUsedTime
: Sort by the time the revisions were last used in a deployment.
If not specified or set to null, the results are returned in an arbitrary order.
-
sort_order(SortOrder)
/set_sort_order(Option<SortOrder>)
:The order in which to sort the list results:
-
ascending
: ascending order. -
descending
: descending order.
If not specified, the results are sorted in ascending order.
If set to null, the results are sorted in an arbitrary order.
-
s3_bucket(impl Into<String>)
/set_s3_bucket(Option<String>)
:An Amazon S3 bucket name to limit the search for revisions.
If set to null, all of the user’s buckets are searched.
s3_key_prefix(impl Into<String>)
/set_s3_key_prefix(Option<String>)
:A key prefix for the set of Amazon S3 objects to limit the search for revisions.
deployed(ListStateFilterAction)
/set_deployed(Option<ListStateFilterAction>)
:Whether to list revisions based on whether the revision is the target revision of a deployment group:
-
include
: List revisions that are target revisions of a deployment group. -
exclude
: Do not list revisions that are target revisions of a deployment group. -
ignore
: List all revisions.
-
next_token(impl Into<String>)
/set_next_token(Option<String>)
:An identifier returned from the previous
ListApplicationRevisions
call. It can be used to return the next set of applications in the list.
- On success, responds with
ListApplicationRevisionsOutput
with field(s):revisions(Option<Vec<RevisionLocation>>)
:A list of locations that contain the matching revisions.
next_token(Option<String>)
:If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list application revisions call to return the next set of application revisions in the list.
- On failure, responds with
SdkError<ListApplicationRevisionsError>
sourcepub fn list_applications(&self) -> ListApplications
pub fn list_applications(&self) -> ListApplications
Constructs a fluent builder for the ListApplications
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:An identifier returned from the previous list applications call. It can be used to return the next set of applications in the list.
- On success, responds with
ListApplicationsOutput
with field(s):applications(Option<Vec<String>>)
:A list of application names.
next_token(Option<String>)
:If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list applications call to return the next set of applications in the list.
- On failure, responds with
SdkError<ListApplicationsError>
sourcepub fn list_deployment_configs(&self) -> ListDeploymentConfigs
pub fn list_deployment_configs(&self) -> ListDeploymentConfigs
Constructs a fluent builder for the ListDeploymentConfigs
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:An identifier returned from the previous
ListDeploymentConfigs
call. It can be used to return the next set of deployment configurations in the list.
- On success, responds with
ListDeploymentConfigsOutput
with field(s):deployment_configs_list(Option<Vec<String>>)
:A list of deployment configurations, including built-in configurations such as
CodeDeployDefault.OneAtATime
.next_token(Option<String>)
:If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list deployment configurations call to return the next set of deployment configurations in the list.
- On failure, responds with
SdkError<ListDeploymentConfigsError>
sourcepub fn list_deployment_groups(&self) -> ListDeploymentGroups
pub fn list_deployment_groups(&self) -> ListDeploymentGroups
Constructs a fluent builder for the ListDeploymentGroups
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
application_name(impl Into<String>)
/set_application_name(Option<String>)
:The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:An identifier returned from the previous list deployment groups call. It can be used to return the next set of deployment groups in the list.
- On success, responds with
ListDeploymentGroupsOutput
with field(s):application_name(Option<String>)
:The application name.
deployment_groups(Option<Vec<String>>)
:A list of deployment group names.
next_token(Option<String>)
:If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list deployment groups call to return the next set of deployment groups in the list.
- On failure, responds with
SdkError<ListDeploymentGroupsError>
sourcepub fn list_deployment_instances(&self) -> ListDeploymentInstances
pub fn list_deployment_instances(&self) -> ListDeploymentInstances
Constructs a fluent builder for the ListDeploymentInstances
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
deployment_id(impl Into<String>)
/set_deployment_id(Option<String>)
:The unique ID of a deployment.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:An identifier returned from the previous list deployment instances call. It can be used to return the next set of deployment instances in the list.
instance_status_filter(Vec<InstanceStatus>)
/set_instance_status_filter(Option<Vec<InstanceStatus>>)
:A subset of instances to list by status:
-
Pending
: Include those instances with pending deployments. -
InProgress
: Include those instances where deployments are still in progress. -
Succeeded
: Include those instances with successful deployments. -
Failed
: Include those instances with failed deployments. -
Skipped
: Include those instances with skipped deployments. -
Unknown
: Include those instances with deployments in an unknown state.
-
instance_type_filter(Vec<InstanceType>)
/set_instance_type_filter(Option<Vec<InstanceType>>)
:The set of instances in a blue/green deployment, either those in the original environment (“BLUE”) or those in the replacement environment (“GREEN”), for which you want to view instance information.
- On success, responds with
ListDeploymentInstancesOutput
with field(s):instances_list(Option<Vec<String>>)
:A list of instance IDs.
next_token(Option<String>)
:If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list deployment instances call to return the next set of deployment instances in the list.
- On failure, responds with
SdkError<ListDeploymentInstancesError>
sourcepub fn list_deployments(&self) -> ListDeployments
pub fn list_deployments(&self) -> ListDeployments
Constructs a fluent builder for the ListDeployments
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
application_name(impl Into<String>)
/set_application_name(Option<String>)
:The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.
If
applicationName
is specified, thendeploymentGroupName
must be specified. If it is not specified, thendeploymentGroupName
must not be specified.deployment_group_name(impl Into<String>)
/set_deployment_group_name(Option<String>)
:The name of a deployment group for the specified application.
If
deploymentGroupName
is specified, thenapplicationName
must be specified. If it is not specified, thenapplicationName
must not be specified.external_id(impl Into<String>)
/set_external_id(Option<String>)
:The unique ID of an external resource for returning deployments linked to the external resource.
include_only_statuses(Vec<DeploymentStatus>)
/set_include_only_statuses(Option<Vec<DeploymentStatus>>)
:A subset of deployments to list by status:
-
Created
: Include created deployments in the resulting list. -
Queued
: Include queued deployments in the resulting list. -
In Progress
: Include in-progress deployments in the resulting list. -
Succeeded
: Include successful deployments in the resulting list. -
Failed
: Include failed deployments in the resulting list. -
Stopped
: Include stopped deployments in the resulting list.
-
create_time_range(TimeRange)
/set_create_time_range(Option<TimeRange>)
:A time range (start and end) for returning a subset of the list of deployments.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:An identifier returned from the previous list deployments call. It can be used to return the next set of deployments in the list.
- On success, responds with
ListDeploymentsOutput
with field(s):deployments(Option<Vec<String>>)
:A list of deployment IDs.
next_token(Option<String>)
:If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list deployments call to return the next set of deployments in the list.
- On failure, responds with
SdkError<ListDeploymentsError>
sourcepub fn list_deployment_targets(&self) -> ListDeploymentTargets
pub fn list_deployment_targets(&self) -> ListDeploymentTargets
Constructs a fluent builder for the ListDeploymentTargets
operation.
- The fluent builder is configurable:
deployment_id(impl Into<String>)
/set_deployment_id(Option<String>)
:The unique ID of a deployment.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:A token identifier returned from the previous
ListDeploymentTargets
call. It can be used to return the next set of deployment targets in the list.target_filters(HashMap<TargetFilterName, Vec<String>>)
/set_target_filters(Option<HashMap<TargetFilterName, Vec<String>>>)
:A key used to filter the returned targets. The two valid values are:
-
TargetStatus
- ATargetStatus
filter string can beFailed
,InProgress
,Pending
,Ready
,Skipped
,Succeeded
, orUnknown
. -
ServerInstanceLabel
- AServerInstanceLabel
filter string can beBlue
orGreen
.
-
- On success, responds with
ListDeploymentTargetsOutput
with field(s):target_ids(Option<Vec<String>>)
:The unique IDs of deployment targets.
next_token(Option<String>)
:If a large amount of information is returned, a token identifier is also returned. It can be used in a subsequent
ListDeploymentTargets
call to return the next set of deployment targets in the list.
- On failure, responds with
SdkError<ListDeploymentTargetsError>
sourcepub fn list_git_hub_account_token_names(&self) -> ListGitHubAccountTokenNames
pub fn list_git_hub_account_token_names(&self) -> ListGitHubAccountTokenNames
Constructs a fluent builder for the ListGitHubAccountTokenNames
operation.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:An identifier returned from the previous
ListGitHubAccountTokenNames
call. It can be used to return the next set of names in the list.
- On success, responds with
ListGitHubAccountTokenNamesOutput
with field(s):token_name_list(Option<Vec<String>>)
:A list of names of connections to GitHub accounts.
next_token(Option<String>)
:If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent
ListGitHubAccountTokenNames
call to return the next set of names in the list.
- On failure, responds with
SdkError<ListGitHubAccountTokenNamesError>
sourcepub fn list_on_premises_instances(&self) -> ListOnPremisesInstances
pub fn list_on_premises_instances(&self) -> ListOnPremisesInstances
Constructs a fluent builder for the ListOnPremisesInstances
operation.
- The fluent builder is configurable:
registration_status(RegistrationStatus)
/set_registration_status(Option<RegistrationStatus>)
:The registration status of the on-premises instances:
-
Deregistered
: Include deregistered on-premises instances in the resulting list. -
Registered
: Include registered on-premises instances in the resulting list.
-
tag_filters(Vec<TagFilter>)
/set_tag_filters(Option<Vec<TagFilter>>)
:The on-premises instance tags that are used to restrict the on-premises instance names returned.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:An identifier returned from the previous list on-premises instances call. It can be used to return the next set of on-premises instances in the list.
- On success, responds with
ListOnPremisesInstancesOutput
with field(s):instance_names(Option<Vec<String>>)
:The list of matching on-premises instance names.
next_token(Option<String>)
:If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list on-premises instances call to return the next set of on-premises instances in the list.
- On failure, responds with
SdkError<ListOnPremisesInstancesError>
Constructs a fluent builder for the ListTagsForResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The ARN of a CodeDeploy resource.
ListTagsForResource
returns all the tags associated with the resource that is identified by theResourceArn
.next_token(impl Into<String>)
/set_next_token(Option<String>)
:An identifier returned from the previous
ListTagsForResource
call. It can be used to return the next set of applications in the list.
- On success, responds with
ListTagsForResourceOutput
with field(s):tags(Option<Vec<Tag>>)
:A list of tags returned by
ListTagsForResource
. The tags are associated with the resource identified by the inputResourceArn
parameter.next_token(Option<String>)
:If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list application revisions call to return the next set of application revisions in the list.
- On failure, responds with
SdkError<ListTagsForResourceError>
sourcepub fn put_lifecycle_event_hook_execution_status(
&self
) -> PutLifecycleEventHookExecutionStatus
pub fn put_lifecycle_event_hook_execution_status(
&self
) -> PutLifecycleEventHookExecutionStatus
Constructs a fluent builder for the PutLifecycleEventHookExecutionStatus
operation.
- The fluent builder is configurable:
deployment_id(impl Into<String>)
/set_deployment_id(Option<String>)
:The unique ID of a deployment. Pass this ID to a Lambda function that validates a deployment lifecycle event.
lifecycle_event_hook_execution_id(impl Into<String>)
/set_lifecycle_event_hook_execution_id(Option<String>)
:The execution ID of a deployment’s lifecycle hook. A deployment lifecycle hook is specified in the
hooks
section of the AppSpec file.status(LifecycleEventStatus)
/set_status(Option<LifecycleEventStatus>)
:The result of a Lambda function that validates a deployment lifecycle event. The values listed in Valid Values are valid for lifecycle statuses in general; however, only
Succeeded
andFailed
can be passed successfully in your API call.
- On success, responds with
PutLifecycleEventHookExecutionStatusOutput
with field(s):lifecycle_event_hook_execution_id(Option<String>)
:The execution ID of the lifecycle event hook. A hook is specified in the
hooks
section of the deployment’s AppSpec file.
- On failure, responds with
SdkError<PutLifecycleEventHookExecutionStatusError>
sourcepub fn register_application_revision(&self) -> RegisterApplicationRevision
pub fn register_application_revision(&self) -> RegisterApplicationRevision
Constructs a fluent builder for the RegisterApplicationRevision
operation.
- The fluent builder is configurable:
application_name(impl Into<String>)
/set_application_name(Option<String>)
:The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.
description(impl Into<String>)
/set_description(Option<String>)
:A comment about the revision.
revision(RevisionLocation)
/set_revision(Option<RevisionLocation>)
:Information about the application revision to register, including type and location.
- On success, responds with
RegisterApplicationRevisionOutput
- On failure, responds with
SdkError<RegisterApplicationRevisionError>
sourcepub fn register_on_premises_instance(&self) -> RegisterOnPremisesInstance
pub fn register_on_premises_instance(&self) -> RegisterOnPremisesInstance
Constructs a fluent builder for the RegisterOnPremisesInstance
operation.
- The fluent builder is configurable:
instance_name(impl Into<String>)
/set_instance_name(Option<String>)
:The name of the on-premises instance to register.
iam_session_arn(impl Into<String>)
/set_iam_session_arn(Option<String>)
:The ARN of the IAM session to associate with the on-premises instance.
iam_user_arn(impl Into<String>)
/set_iam_user_arn(Option<String>)
:The ARN of the IAM user to associate with the on-premises instance.
- On success, responds with
RegisterOnPremisesInstanceOutput
- On failure, responds with
SdkError<RegisterOnPremisesInstanceError>
Constructs a fluent builder for the RemoveTagsFromOnPremisesInstances
operation.
- The fluent builder is configurable:
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:The tag key-value pairs to remove from the on-premises instances.
instance_names(Vec<String>)
/set_instance_names(Option<Vec<String>>)
:The names of the on-premises instances from which to remove tags.
- On success, responds with
RemoveTagsFromOnPremisesInstancesOutput
- On failure, responds with
SdkError<RemoveTagsFromOnPremisesInstancesError>
sourcepub fn skip_wait_time_for_instance_termination(
&self
) -> SkipWaitTimeForInstanceTermination
pub fn skip_wait_time_for_instance_termination(
&self
) -> SkipWaitTimeForInstanceTermination
Constructs a fluent builder for the SkipWaitTimeForInstanceTermination
operation.
- The fluent builder is configurable:
deployment_id(impl Into<String>)
/set_deployment_id(Option<String>)
:The unique ID of a blue/green deployment for which you want to skip the instance termination wait time.
- On success, responds with
SkipWaitTimeForInstanceTerminationOutput
- On failure, responds with
SdkError<SkipWaitTimeForInstanceTerminationError>
sourcepub fn stop_deployment(&self) -> StopDeployment
pub fn stop_deployment(&self) -> StopDeployment
Constructs a fluent builder for the StopDeployment
operation.
- The fluent builder is configurable:
deployment_id(impl Into<String>)
/set_deployment_id(Option<String>)
:The unique ID of a deployment.
auto_rollback_enabled(bool)
/set_auto_rollback_enabled(Option<bool>)
:Indicates, when a deployment is stopped, whether instances that have been updated should be rolled back to the previous version of the application revision.
- On success, responds with
StopDeploymentOutput
with field(s):status(Option<StopStatus>)
:The status of the stop deployment operation:
-
Pending: The stop operation is pending.
-
Succeeded: The stop operation was successful.
-
status_message(Option<String>)
:An accompanying status message.
- On failure, responds with
SdkError<StopDeploymentError>
sourcepub fn tag_resource(&self) -> TagResource
pub fn tag_resource(&self) -> TagResource
Constructs a fluent builder for the TagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The ARN of a resource, such as a CodeDeploy application or deployment group.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:A list of tags that
TagResource
associates with a resource. The resource is identified by theResourceArn
input parameter.
- On success, responds with
TagResourceOutput
- On failure, responds with
SdkError<TagResourceError>
sourcepub fn untag_resource(&self) -> UntagResource
pub fn untag_resource(&self) -> UntagResource
Constructs a fluent builder for the UntagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The Amazon Resource Name (ARN) that specifies from which resource to disassociate the tags with the keys in the
TagKeys
input parameter.tag_keys(Vec<String>)
/set_tag_keys(Option<Vec<String>>)
:A list of keys of
Tag
objects. TheTag
objects identified by the keys are disassociated from the resource specified by theResourceArn
input parameter.
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
sourcepub fn update_application(&self) -> UpdateApplication
pub fn update_application(&self) -> UpdateApplication
Constructs a fluent builder for the UpdateApplication
operation.
- The fluent builder is configurable:
application_name(impl Into<String>)
/set_application_name(Option<String>)
:The current name of the application you want to change.
new_application_name(impl Into<String>)
/set_new_application_name(Option<String>)
:The new name to give the application.
- On success, responds with
UpdateApplicationOutput
- On failure, responds with
SdkError<UpdateApplicationError>
sourcepub fn update_deployment_group(&self) -> UpdateDeploymentGroup
pub fn update_deployment_group(&self) -> UpdateDeploymentGroup
Constructs a fluent builder for the UpdateDeploymentGroup
operation.
- The fluent builder is configurable:
application_name(impl Into<String>)
/set_application_name(Option<String>)
:The application name that corresponds to the deployment group to update.
current_deployment_group_name(impl Into<String>)
/set_current_deployment_group_name(Option<String>)
:The current name of the deployment group.
new_deployment_group_name(impl Into<String>)
/set_new_deployment_group_name(Option<String>)
:The new name of the deployment group, if you want to change it.
deployment_config_name(impl Into<String>)
/set_deployment_config_name(Option<String>)
:The replacement deployment configuration name to use, if you want to change it.
ec2_tag_filters(Vec<Ec2TagFilter>)
/set_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(Vec<TagFilter>)
/set_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(Vec<String>)
/set_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(impl Into<String>)
/set_service_role_arn(Option<String>)
:A replacement ARN for the service role, if you want to change it.
trigger_configurations(Vec<TriggerConfig>)
/set_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(AlarmConfiguration)
/set_alarm_configuration(Option<AlarmConfiguration>)
:Information to add or change about Amazon CloudWatch alarms when the deployment group is updated.
auto_rollback_configuration(AutoRollbackConfiguration)
/set_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(OutdatedInstancesStrategy)
/set_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(DeploymentStyle)
/set_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(BlueGreenDeploymentConfiguration)
/set_blue_green_deployment_configuration(Option<BlueGreenDeploymentConfiguration>)
:Information about blue/green deployment options for a deployment group.
load_balancer_info(LoadBalancerInfo)
/set_load_balancer_info(Option<LoadBalancerInfo>)
:Information about the load balancer used in a deployment.
ec2_tag_set(Ec2TagSet)
/set_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(Vec<EcsService>)
/set_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(OnPremisesTagSet)
/set_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.
- On success, responds with
UpdateDeploymentGroupOutput
with field(s):hooks_not_cleaned_up(Option<Vec<AutoScalingGroup>>)
:If the output contains no data, and the corresponding deployment group contained at least one Auto Scaling group, CodeDeploy successfully removed all corresponding Auto Scaling lifecycle event hooks from the Amazon Web Services account. If the output contains data, CodeDeploy could not remove some Auto Scaling lifecycle event hooks from the Amazon Web Services account.
- On failure, responds with
SdkError<UpdateDeploymentGroupError>
source§impl Client
impl Client
sourcepub fn new(sdk_config: &SdkConfig) -> Self
pub fn new(sdk_config: &SdkConfig) -> Self
Creates a new client from an SDK Config.
Panics
- This method will panic if the
sdk_config
is missing an async sleep implementation. If you experience this panic, set thesleep_impl
on the Config passed into this function to fix it. - This method will panic if the
sdk_config
is missing an HTTP connector. If you experience this panic, set thehttp_connector
on the Config passed into this function to fix it.
sourcepub fn from_conf(conf: Config) -> Self
pub fn from_conf(conf: Config) -> Self
Creates a new client from the service Config
.
Panics
- This method will panic if the
conf
is missing an async sleep implementation. If you experience this panic, set thesleep_impl
on the Config passed into this function to fix it. - This method will panic if the
conf
is missing an HTTP connector. If you experience this panic, set thehttp_connector
on the Config passed into this function to fix it.