software.amazon.awscdk.services.servicecatalog

Class CfnStackSetConstraint

java.lang.Object

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

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:53.711Z")
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 interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

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

Methods inherited from class software.amazon.awscdk.core.CfnResource

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

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.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

public CfnStackSetConstraint(Construct scope,
                             java.lang.String id,
                             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

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getAccountList

public java.util.List<java.lang.String> getAccountList()

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

setAccountList

public void setAccountList(java.util.List<java.lang.String> value)

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

getAdminRole

public java.lang.String getAdminRole()

AdminRole ARN.

setAdminRole

public void setAdminRole(java.lang.String value)

AdminRole ARN.

getDescription

public java.lang.String getDescription()

The description of the constraint.

setDescription

public void setDescription(java.lang.String value)

The description of the constraint.

getExecutionRole

public java.lang.String getExecutionRole()

ExecutionRole name.

setExecutionRole

public void setExecutionRole(java.lang.String value)

ExecutionRole name.

getPortfolioId

public java.lang.String getPortfolioId()

The portfolio identifier.

setPortfolioId

public void setPortfolioId(java.lang.String value)

The portfolio identifier.

getProductId

public java.lang.String getProductId()

The product identifier.

setProductId

public void setProductId(java.lang.String value)

The product identifier.

getRegionList

public java.util.List<java.lang.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

public void setRegionList(java.util.List<java.lang.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

public java.lang.String getStackInstanceControl()

Permission to create, update, and delete stack instances.

Choose from ALLOWED and NOT_ALLOWED.

setStackInstanceControl

public void setStackInstanceControl(java.lang.String value)

Permission to create, update, and delete stack instances.

Choose from ALLOWED and NOT_ALLOWED.

getAcceptLanguage

public java.lang.String getAcceptLanguage()

The language code.

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

setAcceptLanguage

public void setAcceptLanguage(java.lang.String value)

The language code.

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