Package software.amazon.awssdk.services.cloudformation.model

Interface StackSetSummary.Builder

All Superinterfaces:

Buildable, CopyableBuilder<StackSetSummary.Builder,StackSetSummary>, SdkBuilder<StackSetSummary.Builder,StackSetSummary>, SdkPojo

Enclosing class:

StackSetSummary

@Mutable
@NotThreadSafe
public static interface StackSetSummary.Builder
extends SdkPojo, CopyableBuilder<StackSetSummary.Builder,StackSetSummary>

Method Summary

Modifier and Type	Method	Description
default StackSetSummary.Builder	autoDeployment(Consumer<AutoDeployment.Builder> autoDeployment)	[Service-managed permissions] Describes whether StackSets automatically deploys to Organizations accounts that are added to a target organizational unit (OU).
StackSetSummary.Builder	autoDeployment(AutoDeployment autoDeployment)	[Service-managed permissions] Describes whether StackSets automatically deploys to Organizations accounts that are added to a target organizational unit (OU).
StackSetSummary.Builder	description(String description)	A description of the StackSet that you specify when the StackSet is created or updated.
StackSetSummary.Builder	driftStatus(String driftStatus)	Status of the StackSet's actual configuration compared to its expected template and parameter configuration.
StackSetSummary.Builder	driftStatus(StackDriftStatus driftStatus)	Status of the StackSet's actual configuration compared to its expected template and parameter configuration.
StackSetSummary.Builder	lastDriftCheckTimestamp(Instant lastDriftCheckTimestamp)	Most recent time when CloudFormation performed a drift detection operation on the StackSet.
default StackSetSummary.Builder	managedExecution(Consumer<ManagedExecution.Builder> managedExecution)	Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.
StackSetSummary.Builder	managedExecution(ManagedExecution managedExecution)	Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.
StackSetSummary.Builder	permissionModel(String permissionModel)	Describes how the IAM roles required for StackSet operations are created.
StackSetSummary.Builder	permissionModel(PermissionModels permissionModel)	Describes how the IAM roles required for StackSet operations are created.
StackSetSummary.Builder	stackSetId(String stackSetId)	The ID of the StackSet.
StackSetSummary.Builder	stackSetName(String stackSetName)	The name of the StackSet.
StackSetSummary.Builder	status(String status)	The status of the StackSet.
StackSetSummary.Builder	status(StackSetStatus status)	The status of the StackSet.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

stackSetName

StackSetSummary.Builder stackSetName(String stackSetName)

The name of the StackSet.

Parameters:

stackSetName - The name of the StackSet.

Returns:

Returns a reference to this object so that method calls can be chained together.

stackSetId

StackSetSummary.Builder stackSetId(String stackSetId)

The ID of the StackSet.

Parameters:

stackSetId - The ID of the StackSet.

Returns:

Returns a reference to this object so that method calls can be chained together.

description

StackSetSummary.Builder description(String description)

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

Parameters:

description - A description of the StackSet that you specify when the StackSet is created or updated.

Returns:

Returns a reference to this object so that method calls can be chained together.

status

StackSetSummary.Builder status(String status)

The status of the StackSet.

Parameters:

status - The status of the StackSet.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

StackSetStatus, StackSetStatus

status

StackSetSummary.Builder status(StackSetStatus status)

The status of the StackSet.

Parameters:

status - The status of the StackSet.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

StackSetStatus, StackSetStatus

autoDeployment

StackSetSummary.Builder autoDeployment(AutoDeployment autoDeployment)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

autoDeployment

default StackSetSummary.Builder autoDeployment(Consumer<AutoDeployment.Builder> autoDeployment)

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

This is a convenience method that creates an instance of the AutoDeployment.Builder avoiding the need to create one manually via AutoDeployment.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to autoDeployment(AutoDeployment).

Parameters:

autoDeployment - a consumer that will call methods on AutoDeployment.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

autoDeployment(AutoDeployment)

permissionModel

StackSetSummary.Builder permissionModel(String permissionModel)

Describes how the IAM roles required for StackSet 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 permissions.

• With service-managed permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by Organizations. For more information, see Activate trusted access for StackSets with Organizations.

Parameters:

permissionModel - Describes how the IAM roles required for StackSet 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 permissions.

• With service-managed permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by Organizations. For more information, see Activate trusted access for StackSets with Organizations.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

PermissionModels, PermissionModels

permissionModel

StackSetSummary.Builder permissionModel(PermissionModels permissionModel)

Describes how the IAM roles required for StackSet 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 permissions.

• With service-managed permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by Organizations. For more information, see Activate trusted access for StackSets with Organizations.

Parameters:

permissionModel - Describes how the IAM roles required for StackSet 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 permissions.

• With service-managed permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by Organizations. For more information, see Activate trusted access for StackSets with Organizations.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

PermissionModels, PermissionModels

driftStatus

StackSetSummary.Builder driftStatus(String driftStatus)

Status of the StackSet's actual configuration compared to its expected template and parameter configuration.

• DRIFTED: One or more of the stack instances belonging to the StackSet differs from the expected template and parameter configuration. A stack instance is considered to have drifted if one or more of the resources in the associated stack have drifted.

• NOT_CHECKED: CloudFormation hasn't checked the StackSet for drift.

• IN_SYNC: All the stack instances belonging to the StackSet match the expected template and parameter configuration.

• UNKNOWN: This value is reserved for future use.

Parameters:

driftStatus - Status of the StackSet's actual configuration compared to its expected template and parameter configuration.

• DRIFTED: One or more of the stack instances belonging to the StackSet differs from the expected template and parameter configuration. A stack instance is considered to have drifted if one or more of the resources in the associated stack have drifted.

• NOT_CHECKED: CloudFormation hasn't checked the StackSet for drift.

• IN_SYNC: All the stack instances belonging to the StackSet match the expected template and parameter configuration.

• UNKNOWN: This value is reserved for future use.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

StackDriftStatus, StackDriftStatus

driftStatus

StackSetSummary.Builder driftStatus(StackDriftStatus driftStatus)

Status of the StackSet's actual configuration compared to its expected template and parameter configuration.

• DRIFTED: One or more of the stack instances belonging to the StackSet differs from the expected template and parameter configuration. A stack instance is considered to have drifted if one or more of the resources in the associated stack have drifted.

• NOT_CHECKED: CloudFormation hasn't checked the StackSet for drift.

• IN_SYNC: All the stack instances belonging to the StackSet match the expected template and parameter configuration.

• UNKNOWN: This value is reserved for future use.

Parameters:

driftStatus - Status of the StackSet's actual configuration compared to its expected template and parameter configuration.

• DRIFTED: One or more of the stack instances belonging to the StackSet differs from the expected template and parameter configuration. A stack instance is considered to have drifted if one or more of the resources in the associated stack have drifted.

• NOT_CHECKED: CloudFormation hasn't checked the StackSet for drift.

• IN_SYNC: All the stack instances belonging to the StackSet match the expected template and parameter configuration.

• UNKNOWN: This value is reserved for future use.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

StackDriftStatus, StackDriftStatus

lastDriftCheckTimestamp

StackSetSummary.Builder lastDriftCheckTimestamp(Instant lastDriftCheckTimestamp)

Most recent time when CloudFormation performed a drift detection operation on the StackSet. This value will be NULL for any StackSet that drift detection hasn't yet been performed on.

Parameters:

lastDriftCheckTimestamp - Most recent time when CloudFormation performed a drift detection operation on the StackSet. This value will be NULL for any StackSet that drift detection hasn't yet been performed on.

Returns:

Returns a reference to this object so that method calls can be chained together.

managedExecution

StackSetSummary.Builder managedExecution(ManagedExecution managedExecution)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

managedExecution

default StackSetSummary.Builder managedExecution(Consumer<ManagedExecution.Builder> managedExecution)

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

This is a convenience method that creates an instance of the ManagedExecution.Builder avoiding the need to create one manually via ManagedExecution.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to managedExecution(ManagedExecution).

Parameters:

managedExecution - a consumer that will call methods on ManagedExecution.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

managedExecution(ManagedExecution)