Struct aws_sdk_cloudformation::operation::describe_change_set::DescribeChangeSetOutput

#[non_exhaustive]
pub struct DescribeChangeSetOutput {

    pub change_set_name: Option<String>,
    pub change_set_id: Option<String>,
    pub stack_id: Option<String>,
    pub stack_name: Option<String>,
    pub description: Option<String>,
    pub parameters: Option<Vec<Parameter>>,
    pub creation_time: Option<DateTime>,
    pub execution_status: Option<ExecutionStatus>,
    pub status: Option<ChangeSetStatus>,
    pub status_reason: Option<String>,
    pub notification_arns: Option<Vec<String>>,
    pub rollback_configuration: Option<RollbackConfiguration>,
    pub capabilities: Option<Vec<Capability>>,
    pub tags: Option<Vec<Tag>>,
    pub changes: Option<Vec<Change>>,
    pub next_token: Option<String>,
    pub include_nested_stacks: Option<bool>,
    pub parent_change_set_id: Option<String>,
    pub root_change_set_id: Option<String>,
    pub on_stack_failure: Option<OnStackFailure>,
    pub import_existing_resources: Option<bool>,
    /* private fields */
}

The output for the DescribeChangeSet action.

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.

change_set_name: Option<String>

The name of the change set.

change_set_id: Option<String>

The Amazon Resource Name (ARN) of the change set.

stack_id: Option<String>

The Amazon Resource Name (ARN) of the stack that's associated with the change set.

stack_name: Option<String>

The name of the stack that's associated with the change set.

description: Option<String>

Information about the change set.

parameters: Option<Vec<Parameter>>

A list of Parameter structures that describes the input parameters and their values used to create the change set. For more information, see the Parameter data type.

creation_time: Option<DateTime>

The start time when the change set was created, in UTC.

execution_status: Option<ExecutionStatus>

If the change set execution status is AVAILABLE, you can execute the change set. If you can't execute the change set, the status indicates why. For example, a change set might be in an UNAVAILABLE state because CloudFormation is still creating it or in an OBSOLETE state because the stack was already updated.

status: Option<ChangeSetStatus>

The current status of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or FAILED.

status_reason: Option<String>

A description of the change set's status. For example, if your attempt to create a change set failed, CloudFormation shows the error message.

notification_arns: Option<Vec<String>>

The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated with the stack if you execute the change set.

rollback_configuration: Option<RollbackConfiguration>

The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.

capabilities: Option<Vec<Capability>>

If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.

tags: Option<Vec<Tag>>

If you execute the change set, the tags that will be associated with the stack.

changes: Option<Vec<Change>>

A list of Change structures that describes the resources CloudFormation changes if you execute the change set.

next_token: Option<String>

If the output exceeds 1 MB, a string that identifies the next page of changes. If there is no additional page, this value is null.

include_nested_stacks: Option<bool>

Verifies if IncludeNestedStacks is set to True.

parent_change_set_id: Option<String>

Specifies the change set ID of the parent change set in the current nested change set hierarchy.

root_change_set_id: Option<String>

Specifies the change set ID of the root change set in the current nested change set hierarchy.

on_stack_failure: Option<OnStackFailure>

Determines what action will be taken if stack creation fails. When this parameter is specified, the DisableRollback parameter to the ExecuteChangeSet API operation must not be specified. This must be one of these values:

• DELETE - Deletes the change set if the stack creation fails. This is only valid when the ChangeSetType parameter is set to CREATE. If the deletion of the stack fails, the status of the stack is DELETE_FAILED.

• DO_NOTHING - if the stack creation fails, do nothing. This is equivalent to specifying true for the DisableRollback parameter to the ExecuteChangeSet API operation.

• ROLLBACK - if the stack creation fails, roll back the stack. This is equivalent to specifying false for the DisableRollback parameter to the ExecuteChangeSet API operation.

import_existing_resources: Option<bool>

Indicates if the change set imports resources that already exist.

This parameter can only import resources that have custom names in templates. To import resources that do not accept custom names, such as EC2 instances, use the resource import feature instead.

Implementations

impl DescribeChangeSetOutput

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

The name of the change set.

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

The Amazon Resource Name (ARN) of the change set.

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

The Amazon Resource Name (ARN) of the stack that's associated with the change set.

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

The name of the stack that's associated with the change set.

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

Information about the change set.

pub fn parameters(&self) -> &[Parameter]

A list of Parameter structures that describes the input parameters and their values used to create the change set. For more information, see the Parameter data type.

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

pub fn creation_time(&self) -> Option<&DateTime>

The start time when the change set was created, in UTC.

pub fn execution_status(&self) -> Option<&ExecutionStatus>

If the change set execution status is AVAILABLE, you can execute the change set. If you can't execute the change set, the status indicates why. For example, a change set might be in an UNAVAILABLE state because CloudFormation is still creating it or in an OBSOLETE state because the stack was already updated.

pub fn status(&self) -> Option<&ChangeSetStatus>

The current status of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or FAILED.

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

A description of the change set's status. For example, if your attempt to create a change set failed, CloudFormation shows the error message.

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

The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated with the stack if you execute the change set.

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

pub fn rollback_configuration(&self) -> Option<&RollbackConfiguration>

The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.

pub fn capabilities(&self) -> &[Capability]

If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.

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

pub fn tags(&self) -> &[Tag]

If you execute the change set, the tags that will be associated with the stack.

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

pub fn changes(&self) -> &[Change]

A list of Change structures that describes the resources CloudFormation changes if you execute the change set.

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

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

If the output exceeds 1 MB, a string that identifies the next page of changes. If there is no additional page, this value is null.

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

Verifies if IncludeNestedStacks is set to True.

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

Specifies the change set ID of the parent change set in the current nested change set hierarchy.

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

Specifies the change set ID of the root change set in the current nested change set hierarchy.

pub fn on_stack_failure(&self) -> Option<&OnStackFailure>

Determines what action will be taken if stack creation fails. When this parameter is specified, the DisableRollback parameter to the ExecuteChangeSet API operation must not be specified. This must be one of these values:

• DELETE - Deletes the change set if the stack creation fails. This is only valid when the ChangeSetType parameter is set to CREATE. If the deletion of the stack fails, the status of the stack is DELETE_FAILED.

• DO_NOTHING - if the stack creation fails, do nothing. This is equivalent to specifying true for the DisableRollback parameter to the ExecuteChangeSet API operation.

• ROLLBACK - if the stack creation fails, roll back the stack. This is equivalent to specifying false for the DisableRollback parameter to the ExecuteChangeSet API operation.

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

Indicates if the change set imports resources that already exist.

This parameter can only import resources that have custom names in templates. To import resources that do not accept custom names, such as EC2 instances, use the resource import feature instead.

impl DescribeChangeSetOutput

pub fn builder() -> DescribeChangeSetOutputBuilder

Creates a new builder-style object to manufacture DescribeChangeSetOutput.

Trait Implementations

impl Clone for DescribeChangeSetOutput

fn clone(&self) -> DescribeChangeSetOutput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DescribeChangeSetOutput

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

Formats the value using the given formatter.

impl PartialEq for DescribeChangeSetOutput

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

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for DescribeChangeSetOutput