software.amazon.awscdk.services.servicecatalog

Class CfnStackSetConstraint

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.servicecatalog.CfnStackSetConstraint

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:42.096Z")
 @Stability(value=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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnStackSetConstraint.Builder A fluent builder for CfnStackSetConstraint.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnStackSetConstraint(software.constructs.Construct scope, String id, CfnStackSetConstraintProps props) Create a new `AWS::ServiceCatalog::StackSetConstraint`.
protected	CfnStackSetConstraint(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnStackSetConstraint(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAcceptLanguage() The language code.
List<String>	getAccountList() One or more AWS accounts that will have access to the provisioned product.
String	getAdminRole() AdminRole ARN.
protected Map<String,Object>	getCfnProperties()
String	getDescription() The description of the constraint.
String	getExecutionRole() ExecutionRole name.
String	getPortfolioId() The portfolio identifier.
String	getProductId() The product identifier.
List<String>	getRegionList() One or more AWS Regions where the provisioned product will be available.
String	getStackInstanceControl() Permission to create, update, and delete stack instances.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAcceptLanguage(String value) The language code.
void	setAccountList(List<String> value) One or more AWS accounts that will have access to the provisioned product.
void	setAdminRole(String value) AdminRole ARN.
void	setDescription(String value) The description of the constraint.
void	setExecutionRole(String value) ExecutionRole name.
void	setPortfolioId(String value) The portfolio identifier.
void	setProductId(String value) The product identifier.
void	setRegionList(List<String> value) One or more AWS Regions where the provisioned product will be available.
void	setStackInstanceControl(String value) Permission to create, update, and delete stack instances.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnStackSetConstraint

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

CfnStackSetConstraint

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

CfnStackSetConstraint

@Stability(value=Stable)
public CfnStackSetConstraint(@NotNull
                                                      software.constructs.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 Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getAccountList

@Stability(value=Stable)
 @NotNull
public List<String> getAccountList()

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

setAccountList

@Stability(value=Stable)
public void setAccountList(@NotNull
                                                    List<String> value)

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

getAdminRole

@Stability(value=Stable)
 @NotNull
public String getAdminRole()

AdminRole ARN.

setAdminRole

@Stability(value=Stable)
public void setAdminRole(@NotNull
                                                  String value)

AdminRole ARN.

getDescription

@Stability(value=Stable)
 @NotNull
public String getDescription()

The description of the constraint.

setDescription

@Stability(value=Stable)
public void setDescription(@NotNull
                                                    String value)

The description of the constraint.

getExecutionRole

@Stability(value=Stable)
 @NotNull
public String getExecutionRole()

ExecutionRole name.

setExecutionRole

@Stability(value=Stable)
public void setExecutionRole(@NotNull
                                                      String value)

ExecutionRole name.

getPortfolioId

@Stability(value=Stable)
 @NotNull
public String getPortfolioId()

The portfolio identifier.

setPortfolioId

@Stability(value=Stable)
public void setPortfolioId(@NotNull
                                                    String value)

The portfolio identifier.

getProductId

@Stability(value=Stable)
 @NotNull
public String getProductId()

The product identifier.

setProductId

@Stability(value=Stable)
public void setProductId(@NotNull
                                                  String value)

The product identifier.

getRegionList

@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getStackInstanceControl()

Permission to create, update, and delete stack instances.

Choose from ALLOWED and NOT_ALLOWED.

setStackInstanceControl

@Stability(value=Stable)
public void setStackInstanceControl(@NotNull
                                                             String value)

Permission to create, update, and delete stack instances.

Choose from ALLOWED and NOT_ALLOWED.

getAcceptLanguage

@Stability(value=Stable)
 @Nullable
public String getAcceptLanguage()

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

setAcceptLanguage

@Stability(value=Stable)
public void setAcceptLanguage(@Nullable
                                                       String value)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese