software.amazon.awscdk.services.servicecatalog

Interface CfnLaunchRoleConstraintProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnLaunchRoleConstraintProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-08T16:00:26.904Z")
 @Stability(value=Stable)
public interface CfnLaunchRoleConstraintProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnLaunchRoleConstraint`.

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.*;
 CfnLaunchRoleConstraintProps cfnLaunchRoleConstraintProps = CfnLaunchRoleConstraintProps.builder()
         .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	Interface and Description
static class	CfnLaunchRoleConstraintProps.Builder A builder for CfnLaunchRoleConstraintProps
static class	CfnLaunchRoleConstraintProps.Jsii$Proxy An implementation for CfnLaunchRoleConstraintProps

Method Summary

Modifier and Type	Method and Description
static CfnLaunchRoleConstraintProps.Builder	builder()
default String	getAcceptLanguage() The language code.
default String	getDescription() The description of the constraint.
default 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.
default String	getRoleArn() The ARN of the launch role.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getPortfolioId

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

The portfolio identifier.

getProductId

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

The product identifier.

getAcceptLanguage

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

The language code.

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

getDescription

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

The description of the constraint.

getLocalRoleName

@Stability(value=Stable)
 @Nullable
default 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.

getRoleArn

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

The ARN of the launch role.

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

builder

@Stability(value=Stable)
static CfnLaunchRoleConstraintProps.Builder builder()

Returns:

a CfnLaunchRoleConstraintProps.Builder of CfnLaunchRoleConstraintProps