AWS CloudFormation
User Guide (Version )

AWS::ServiceCatalog::StackSetConstraint

Specifies a StackSet constraint.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{ "Type" : "AWS::ServiceCatalog::StackSetConstraint", "Properties" : { "AcceptLanguage" : String, "AccountList" : [ String, ... ], "AdminRole" : String, "Description" : String, "ExecutionRole" : String, "PortfolioId" : String, "ProductId" : String, "RegionList" : [ String, ... ], "StackInstanceControl" : String } }

YAML

Type: AWS::ServiceCatalog::StackSetConstraint Properties: AcceptLanguage: String AccountList: - String AdminRole: String Description: String ExecutionRole: String PortfolioId: String ProductId: String RegionList: - String StackInstanceControl: String

Properties

AcceptLanguage

The language code.

  • en - English (default)

  • jp - Japanese

  • zh - Chinese

Required: No

Type: String

Maximum: 100

Update requires: No interruption

AccountList

One or more AWS accounts that will have access to the provisioned product.

Required: Yes

Type: List of String

Update requires: No interruption

AdminRole

AdminRole ARN

Required: Yes

Type: String

Update requires: No interruption

Description

The description of the constraint.

Required: Yes

Type: String

Maximum: 2000

Update requires: No interruption

ExecutionRole

ExecutionRole name

Required: Yes

Type: String

Update requires: No interruption

PortfolioId

The portfolio identifier.

Required: Yes

Type: String

Minimum: 1

Maximum: 100

Pattern: ^[a-zA-Z0-9_\-]*

Update requires: Replacement

ProductId

The product identifier.

Required: Yes

Type: String

Minimum: 1

Maximum: 100

Pattern: ^[a-zA-Z0-9_\-]*

Update requires: Replacement

RegionList

One or more AWS Regions where the provisioned product will be available.

Applicable only to a CFN_STACKSET provisioned product type.

The specified regions should be within the list of regions from the STACKSET constraint. To get the list of regions in the STACKSET constraint, use the DescribeProvisioningParameters operation.

If no values are specified, the default value is all regions from the STACKSET constraint.

Required: Yes

Type: List of String

Update requires: No interruption

StackInstanceControl

Permission to create, update, and delete stack instances. Choose from ALLOWED and NOT_ALLOWED.

Required: Yes

Type: String

Update requires: No interruption

Return Values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the identifier of the constraint.

For more information about using the Ref function, see Ref.