Struct aws_sdk_cloudformation::types::StackSet

#[non_exhaustive]
pub struct StackSet {

    pub stack_set_name: Option<String>,
    pub stack_set_id: Option<String>,
    pub description: Option<String>,
    pub status: Option<StackSetStatus>,
    pub template_body: Option<String>,
    pub parameters: Option<Vec<Parameter>>,
    pub capabilities: Option<Vec<Capability>>,
    pub tags: Option<Vec<Tag>>,
    pub stack_set_arn: Option<String>,
    pub administration_role_arn: Option<String>,
    pub execution_role_name: Option<String>,
    pub stack_set_drift_detection_details: Option<StackSetDriftDetectionDetails>,
    pub auto_deployment: Option<AutoDeployment>,
    pub permission_model: Option<PermissionModels>,
    pub organizational_unit_ids: Option<Vec<String>>,
    pub managed_execution: Option<ManagedExecution>,
    pub regions: Option<Vec<String>>,
}

A structure that contains information about a stack set. A stack set enables you to provision stacks into Amazon Web Services accounts and across Regions by using a single CloudFormation template. In the stack set, you specify the template to use, in addition to any parameters and capabilities that the template requires.

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.

stack_set_name: Option<String>

The name that's associated with the stack set.

stack_set_id: Option<String>

The ID of the stack set.

description: Option<String>

A description of the stack set that you specify when the stack set is created or updated.

status: Option<StackSetStatus>

The status of the stack set.

template_body: Option<String>

The structure that contains the body of the template that was used to create or update the stack set.

parameters: Option<Vec<Parameter>>

A list of input parameters for a stack set.

capabilities: Option<Vec<Capability>>

The capabilities that are allowed in the stack set. Some stack set templates might include resources that can affect permissions in your Amazon Web Services account—for example, by creating new Identity and Access Management (IAM) users. For more information, see Acknowledging IAM Resources in CloudFormation Templates.

tags: Option<Vec<Tag>>

A list of tags that specify information about the stack set. A maximum number of 50 tags can be specified.

stack_set_arn: Option<String>

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

administration_role_arn: Option<String>

The Amazon Resource Name (ARN) of the IAM role used to create or update the stack set.

Use customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Prerequisites: Granting Permissions for Stack Set Operations in the CloudFormation User Guide.

execution_role_name: Option<String>

The name of the IAM execution role used to create or update the stack set.

Use customized execution roles to control which stack resources users and groups can include in their stack sets.

stack_set_drift_detection_details: Option<StackSetDriftDetectionDetails>

Detailed information about the drift status of the stack set.

For stack sets, contains information about the last completed drift operation performed on the stack set. Information about drift operations currently in progress isn't included.

auto_deployment: Option<AutoDeployment>

[Service-managed permissions] Describes whether StackSets automatically deploys to Organizations accounts that are added to a target organization or organizational unit (OU).

permission_model: Option<PermissionModels>

Describes how the IAM roles required for stack set operations are created.

• With self-managed permissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see Grant Self-Managed Stack Set Permissions.

• With service-managed permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by Organizations. For more information, see Grant Service-Managed Stack Set Permissions.

organizational_unit_ids: Option<Vec<String>>

[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.

managed_execution: Option<ManagedExecution>

Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.

regions: Option<Vec<String>>

Returns a list of all Amazon Web Services Regions the given StackSet has stack instances deployed in. The Amazon Web Services Regions list output is in no particular order.

Implementations

impl StackSet

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

The name that's associated with the stack set.

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

The ID of the stack set.

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

A description of the stack set that you specify when the stack set is created or updated.

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

The status of the stack set.

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

The structure that contains the body of the template that was used to create or update the stack set.

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

A list of input parameters for a stack 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 .parameters.is_none().

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

The capabilities that are allowed in the stack set. Some stack set templates might include resources that can affect permissions in your Amazon Web Services account—for example, by creating new Identity and Access Management (IAM) users. For more information, see Acknowledging IAM Resources in CloudFormation Templates.

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]

A list of tags that specify information about the stack set. A maximum number of 50 tags can be specified.

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 stack_set_arn(&self) -> Option<&str>

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

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

The Amazon Resource Name (ARN) of the IAM role used to create or update the stack set.

Use customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Prerequisites: Granting Permissions for Stack Set Operations in the CloudFormation User Guide.

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

The name of the IAM execution role used to create or update the stack set.

Use customized execution roles to control which stack resources users and groups can include in their stack sets.

pub fn stack_set_drift_detection_details( &self ) -> Option<&StackSetDriftDetectionDetails>

Detailed information about the drift status of the stack set.

For stack sets, contains information about the last completed drift operation performed on the stack set. Information about drift operations currently in progress isn't included.

pub fn auto_deployment(&self) -> Option<&AutoDeployment>

[Service-managed permissions] Describes whether StackSets automatically deploys to Organizations accounts that are added to a target organization or organizational unit (OU).

pub fn permission_model(&self) -> Option<&PermissionModels>

Describes how the IAM roles required for stack set operations are created.

• With self-managed permissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see Grant Self-Managed Stack Set Permissions.

• With service-managed permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by Organizations. For more information, see Grant Service-Managed Stack Set Permissions.

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

[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.

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

pub fn managed_execution(&self) -> Option<&ManagedExecution>

Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.

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

Returns a list of all Amazon Web Services Regions the given StackSet has stack instances deployed in. The Amazon Web Services Regions list output is in no particular order.

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

impl StackSet

pub fn builder() -> StackSetBuilder

Creates a new builder-style object to manufacture StackSet.

Trait Implementations

impl Clone for StackSet

fn clone(&self) -> StackSet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StackSet

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

Formats the value using the given formatter.

impl PartialEq for StackSet

fn eq(&self, other: &StackSet) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for StackSet