software.amazon.awscdk.services.servicecatalog

Class CfnLaunchRoleConstraint

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.CfnLaunchRoleConstraint

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.075Z")
 @Stability(value=Stable)
public class CfnLaunchRoleConstraint
extends CfnResource
implements IInspectable

A CloudFormation `AWS::ServiceCatalog::LaunchRoleConstraint`.

Specifies a launch 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.*;
 CfnLaunchRoleConstraint cfnLaunchRoleConstraint = CfnLaunchRoleConstraint.Builder.create(this, "MyCfnLaunchRoleConstraint")
         .portfolioId("portfolioId")
         .productId("productId")
         // the properties below are optional
         .acceptLanguage("acceptLanguage")
         .description("description")
         .localRoleName("localRoleName")
         .roleArn("roleArn")
         .build();
 

Nested Class Summary

Nested Classes

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

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
	CfnLaunchRoleConstraint(software.constructs.Construct scope, String id, CfnLaunchRoleConstraintProps props) Create a new `AWS::ServiceCatalog::LaunchRoleConstraint`.
protected	CfnLaunchRoleConstraint(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnLaunchRoleConstraint(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAcceptLanguage() The language code.
protected Map<String,Object>	getCfnProperties()
String	getDescription() The description of the constraint.
String	getLocalRoleName() You are required to specify either the `RoleArn` or the `LocalRoleName` but can't use both.
String	getPortfolioId() The portfolio identifier.
String	getProductId() The product identifier.
String	getRoleArn() The ARN of the launch role.
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	setDescription(String value) The description of the constraint.
void	setLocalRoleName(String value) You are required to specify either the `RoleArn` or the `LocalRoleName` but can't use both.
void	setPortfolioId(String value) The portfolio identifier.
void	setProductId(String value) The product identifier.
void	setRoleArn(String value) The ARN of the launch role.

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

CfnLaunchRoleConstraint

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

CfnLaunchRoleConstraint

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

CfnLaunchRoleConstraint

@Stability(value=Stable)
public CfnLaunchRoleConstraint(@NotNull
                                                        software.constructs.Construct scope,
                                                        @NotNull
                                                        String id,
                                                        @NotNull
                                                        CfnLaunchRoleConstraintProps props)

Create a new `AWS::ServiceCatalog::LaunchRoleConstraint`.

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

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.

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

getDescription

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

The description of the constraint.

setDescription

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

The description of the constraint.

getLocalRoleName

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

You are required to specify either the `RoleArn` or the `LocalRoleName` but can't use both.

If you specify the LocalRoleName property, when an account uses the launch constraint, the IAM role with that name in the account will be used. This allows launch-role constraints to be account-agnostic so the administrator can create fewer resources per shared account.

The given role name must exist in the account used to create the launch constraint and the account of the user who launches a product with this launch constraint.

setLocalRoleName

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

You are required to specify either the `RoleArn` or the `LocalRoleName` but can't use both.

If you specify the LocalRoleName property, when an account uses the launch constraint, the IAM role with that name in the account will be used. This allows launch-role constraints to be account-agnostic so the administrator can create fewer resources per shared account.

The given role name must exist in the account used to create the launch constraint and the account of the user who launches a product with this launch constraint.

getRoleArn

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

The ARN of the launch role.

You are required to specify RoleArn or LocalRoleName but can't use both.

setRoleArn

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

The ARN of the launch role.

You are required to specify RoleArn or LocalRoleName but can't use both.