Package software.amazon.awscdk.services.servicecatalog

Class CfnLaunchRoleConstraint

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.CfnLaunchRoleConstraint
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.735Z") @Stability(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();

  • 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

    • CfnLaunchRoleConstraint

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

    • CfnLaunchRoleConstraint

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

    • CfnLaunchRoleConstraint

      @Stability(Stable) public CfnLaunchRoleConstraint(@NotNull 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 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

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

    • 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

    • getDescription

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

    • setDescription

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

    • getLocalRoleName

      @Stability(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(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(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(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.