#[non_exhaustive]pub struct CreateDeploymentInputBuilder { /* private fields */ }
Expand description
A builder for CreateDeploymentInput
.
Implementations§
Source§impl CreateDeploymentInputBuilder
impl CreateDeploymentInputBuilder
Sourcepub fn application_name(self, input: impl Into<String>) -> Self
pub fn application_name(self, input: impl Into<String>) -> Self
The name of an CodeDeploy application associated with the user or Amazon Web Services account.
This field is required.Sourcepub fn set_application_name(self, input: Option<String>) -> Self
pub fn set_application_name(self, input: Option<String>) -> Self
The name of an CodeDeploy application associated with the user or Amazon Web Services account.
Sourcepub fn get_application_name(&self) -> &Option<String>
pub fn get_application_name(&self) -> &Option<String>
The name of an CodeDeploy application associated with the user or Amazon Web Services account.
Sourcepub fn deployment_group_name(self, input: impl Into<String>) -> Self
pub fn deployment_group_name(self, input: impl Into<String>) -> Self
The name of the deployment group.
Sourcepub fn set_deployment_group_name(self, input: Option<String>) -> Self
pub fn set_deployment_group_name(self, input: Option<String>) -> Self
The name of the deployment group.
Sourcepub fn get_deployment_group_name(&self) -> &Option<String>
pub fn get_deployment_group_name(&self) -> &Option<String>
The name of the deployment group.
Sourcepub fn revision(self, input: RevisionLocation) -> Self
pub fn revision(self, input: RevisionLocation) -> Self
The type and location of the revision to deploy.
Sourcepub fn set_revision(self, input: Option<RevisionLocation>) -> Self
pub fn set_revision(self, input: Option<RevisionLocation>) -> Self
The type and location of the revision to deploy.
Sourcepub fn get_revision(&self) -> &Option<RevisionLocation>
pub fn get_revision(&self) -> &Option<RevisionLocation>
The type and location of the revision to deploy.
Sourcepub fn deployment_config_name(self, input: impl Into<String>) -> Self
pub fn deployment_config_name(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_deployment_config_name(self, input: Option<String>) -> Self
pub fn set_deployment_config_name(self, input: Option<String>) -> Self
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.
Sourcepub fn get_deployment_config_name(&self) -> &Option<String>
pub fn get_deployment_config_name(&self) -> &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.
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
A comment about the deployment.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
A comment about the deployment.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
A comment about the deployment.
Sourcepub fn ignore_application_stop_failures(self, input: bool) -> Self
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.
Sourcepub fn set_ignore_application_stop_failures(self, input: Option<bool>) -> Self
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.
Sourcepub fn get_ignore_application_stop_failures(&self) -> &Option<bool>
pub fn get_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.
Sourcepub fn target_instances(self, input: TargetInstances) -> Self
pub fn target_instances(self, input: TargetInstances) -> Self
Information about the instances that belong to the replacement environment in a blue/green deployment.
Sourcepub fn set_target_instances(self, input: Option<TargetInstances>) -> Self
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.
Sourcepub fn get_target_instances(&self) -> &Option<TargetInstances>
pub fn get_target_instances(&self) -> &Option<TargetInstances>
Information about the instances that belong to the replacement environment in a blue/green deployment.
Sourcepub fn auto_rollback_configuration(
self,
input: AutoRollbackConfiguration,
) -> Self
pub fn auto_rollback_configuration( self, input: AutoRollbackConfiguration, ) -> Self
Configuration information for an automatic rollback that is added when a deployment is created.
Sourcepub fn set_auto_rollback_configuration(
self,
input: Option<AutoRollbackConfiguration>,
) -> Self
pub fn set_auto_rollback_configuration( self, input: Option<AutoRollbackConfiguration>, ) -> Self
Configuration information for an automatic rollback that is added when a deployment is created.
Sourcepub fn get_auto_rollback_configuration(
&self,
) -> &Option<AutoRollbackConfiguration>
pub fn get_auto_rollback_configuration( &self, ) -> &Option<AutoRollbackConfiguration>
Configuration information for an automatic rollback that is added when a deployment is created.
Sourcepub fn update_outdated_instances_only(self, input: bool) -> Self
pub fn update_outdated_instances_only(self, input: bool) -> Self
Indicates whether to deploy to all instances or only to instances that are not running the latest application revision.
Sourcepub fn set_update_outdated_instances_only(self, input: Option<bool>) -> Self
pub fn set_update_outdated_instances_only(self, input: Option<bool>) -> Self
Indicates whether to deploy to all instances or only to instances that are not running the latest application revision.
Sourcepub fn get_update_outdated_instances_only(&self) -> &Option<bool>
pub fn get_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.
Sourcepub fn file_exists_behavior(self, input: FileExistsBehavior) -> Self
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.
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.
Sourcepub fn set_file_exists_behavior(self, input: Option<FileExistsBehavior>) -> Self
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.
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.
Sourcepub fn get_file_exists_behavior(&self) -> &Option<FileExistsBehavior>
pub fn get_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.
Sourcepub fn override_alarm_configuration(self, input: AlarmConfiguration) -> Self
pub fn override_alarm_configuration(self, input: AlarmConfiguration) -> Self
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
.
Sourcepub fn set_override_alarm_configuration(
self,
input: Option<AlarmConfiguration>,
) -> Self
pub fn set_override_alarm_configuration( self, input: Option<AlarmConfiguration>, ) -> Self
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
.
Sourcepub fn get_override_alarm_configuration(&self) -> &Option<AlarmConfiguration>
pub fn get_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
.
Sourcepub fn build(self) -> Result<CreateDeploymentInput, BuildError>
pub fn build(self) -> Result<CreateDeploymentInput, BuildError>
Consumes the builder and constructs a CreateDeploymentInput
.
Source§impl CreateDeploymentInputBuilder
impl CreateDeploymentInputBuilder
Sourcepub async fn send_with(
self,
client: &Client,
) -> Result<CreateDeploymentOutput, SdkError<CreateDeploymentError, HttpResponse>>
pub async fn send_with( self, client: &Client, ) -> Result<CreateDeploymentOutput, SdkError<CreateDeploymentError, HttpResponse>>
Sends a request with this input using the given client.
Trait Implementations§
Source§impl Clone for CreateDeploymentInputBuilder
impl Clone for CreateDeploymentInputBuilder
Source§fn clone(&self) -> CreateDeploymentInputBuilder
fn clone(&self) -> CreateDeploymentInputBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for CreateDeploymentInputBuilder
impl Debug for CreateDeploymentInputBuilder
Source§impl Default for CreateDeploymentInputBuilder
impl Default for CreateDeploymentInputBuilder
Source§fn default() -> CreateDeploymentInputBuilder
fn default() -> CreateDeploymentInputBuilder
Source§impl PartialEq for CreateDeploymentInputBuilder
impl PartialEq for CreateDeploymentInputBuilder
Source§fn eq(&self, other: &CreateDeploymentInputBuilder) -> bool
fn eq(&self, other: &CreateDeploymentInputBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for CreateDeploymentInputBuilder
Auto Trait Implementations§
impl Freeze for CreateDeploymentInputBuilder
impl RefUnwindSafe for CreateDeploymentInputBuilder
impl Send for CreateDeploymentInputBuilder
impl Sync for CreateDeploymentInputBuilder
impl Unpin for CreateDeploymentInputBuilder
impl UnwindSafe for CreateDeploymentInputBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);