Package software.amazon.awscdk.services.servicecatalog

Class CfnStackSetConstraint

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.servicecatalog.CfnStackSetConstraint
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:39.776Z") @Stability(Stable) public class CfnStackSetConstraint extends CfnResource implements IInspectable
A CloudFormation AWS::ServiceCatalog::StackSetConstraint.

Specifies a StackSet constraint.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.servicecatalog.*;
 CfnStackSetConstraint cfnStackSetConstraint = CfnStackSetConstraint.Builder.create(this, "MyCfnStackSetConstraint")
         .accountList(List.of("accountList"))
         .adminRole("adminRole")
         .description("description")
         .executionRole("executionRole")
         .portfolioId("portfolioId")
         .productId("productId")
         .regionList(List.of("regionList"))
         .stackInstanceControl("stackInstanceControl")
         // the properties below are optional
         .acceptLanguage("acceptLanguage")
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnStackSetConstraint

      protected CfnStackSetConstraint(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnStackSetConstraint

      protected CfnStackSetConstraint(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnStackSetConstraint

      @Stability(Stable) public CfnStackSetConstraint(@NotNull Construct scope, @NotNull String id, @NotNull CfnStackSetConstraintProps props)
      Create a new AWS::ServiceCatalog::StackSetConstraint.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getAccountList

      @Stability(Stable) @NotNull public List<String> getAccountList()
      One or more AWS accounts that will have access to the provisioned product.

    • setAccountList

      @Stability(Stable) public void setAccountList(@NotNull List<String> value)
      One or more AWS accounts that will have access to the provisioned product.

    • getAdminRole

      @Stability(Stable) @NotNull public String getAdminRole()
      AdminRole ARN.

    • setAdminRole

      @Stability(Stable) public void setAdminRole(@NotNull String value)
      AdminRole ARN.

    • getDescription

      @Stability(Stable) @NotNull public String getDescription()
      The description of the constraint.

    • setDescription

      @Stability(Stable) public void setDescription(@NotNull String value)
      The description of the constraint.

    • getExecutionRole

      @Stability(Stable) @NotNull public String getExecutionRole()
      ExecutionRole name.

    • setExecutionRole

      @Stability(Stable) public void setExecutionRole(@NotNull String value)
      ExecutionRole name.

    • getPortfolioId

      @Stability(Stable) @NotNull public String getPortfolioId()
      The portfolio identifier.

    • setPortfolioId

      @Stability(Stable) public void setPortfolioId(@NotNull String value)
      The portfolio identifier.

    • getProductId

      @Stability(Stable) @NotNull public String getProductId()
      The product identifier.

    • setProductId

      @Stability(Stable) public void setProductId(@NotNull String value)
      The product identifier.

    • getRegionList

      @Stability(Stable) @NotNull public List<String> getRegionList()
      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.

    • setRegionList

      @Stability(Stable) public void setRegionList(@NotNull List<String> value)
      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.

    • getStackInstanceControl

      @Stability(Stable) @NotNull public String getStackInstanceControl()
      Permission to create, update, and delete stack instances.

      Choose from ALLOWED and NOT_ALLOWED.

    • setStackInstanceControl

      @Stability(Stable) public void setStackInstanceControl(@NotNull String value)
      Permission to create, update, and delete stack instances.

      Choose from ALLOWED and NOT_ALLOWED.

    • getAcceptLanguage

      @Stability(Stable) @Nullable public String getAcceptLanguage()
      The language code.

      • jp - Japanese
      • zh - Chinese

    • setAcceptLanguage

      @Stability(Stable) public void setAcceptLanguage(@Nullable String value)
      The language code.

      • jp - Japanese
      • zh - Chinese