Package software.amazon.awscdk

Interface CfnGuardHook.StackRolesProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnGuardHook.StackRolesProperty.Jsii$Proxy

Enclosing class:

CfnGuardHook

@Stability(Stable)
public static interface CfnGuardHook.StackRolesProperty
extends software.amazon.jsii.JsiiSerializable

Specifies the stack roles for the StackFilters property type to include or exclude specific stacks from Hook invocations based on their associated IAM roles.

For more information, see AWS CloudFormation Hooks stack level filters .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 StackRolesProperty stackRolesProperty = StackRolesProperty.builder()
         .exclude(List.of("exclude"))
         .include(List.of("include"))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-stackroles.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnGuardHook.StackRolesProperty.Builder	A builder for CfnGuardHook.StackRolesProperty
static final class	CfnGuardHook.StackRolesProperty.Jsii$Proxy	An implementation for CfnGuardHook.StackRolesProperty

Method Summary

Modifier and Type	Method	Description
static CfnGuardHook.StackRolesProperty.Builder	builder()
default List<String>	getExclude()	The IAM role ARNs for stacks you want to exclude.
default List<String>	getInclude()	The IAM role ARNs to target stacks associated with these roles.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getExclude

@Stability(Stable)
@Nullable
default List<String> getExclude()

The IAM role ARNs for stacks you want to exclude.

The Hook will be invoked on all stacks except those initiated by the specified roles.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-stackroles.html#cfn-cloudformation-guardhook-stackroles-exclude

getInclude

@Stability(Stable)
@Nullable
default List<String> getInclude()

The IAM role ARNs to target stacks associated with these roles.

Only stack operations initiated by these roles will invoke the Hook.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-stackroles.html#cfn-cloudformation-guardhook-stackroles-include

builder

@Stability(Stable)
static CfnGuardHook.StackRolesProperty.Builder builder()

Returns:

a CfnGuardHook.StackRolesProperty.Builder of CfnGuardHook.StackRolesProperty