Interface CreateConstraintRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateConstraintRequest.Builder,CreateConstraintRequest>, SdkBuilder<CreateConstraintRequest.Builder,CreateConstraintRequest>, SdkPojo, SdkRequest.Builder, ServiceCatalogRequest.Builder
Enclosing class:
CreateConstraintRequest
public static interface CreateConstraintRequest.Builder extends ServiceCatalogRequest.Builder, SdkPojo, CopyableBuilder<CreateConstraintRequest.Builder,CreateConstraintRequest>

  • Method Details

    • acceptLanguage

      CreateConstraintRequest.Builder acceptLanguage(String acceptLanguage)

      The language code.

      • jp - Japanese

      • zh - Chinese

      Parameters:
      acceptLanguage - The language code.

      • jp - Japanese

      • zh - Chinese

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • portfolioId

      CreateConstraintRequest.Builder portfolioId(String portfolioId)

      The portfolio identifier.

      Parameters:
      portfolioId - The portfolio identifier.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • productId

      CreateConstraintRequest.Builder productId(String productId)

      The product identifier.

      Parameters:
      productId - The product identifier.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • parameters

      CreateConstraintRequest.Builder parameters(String parameters)

      The constraint parameters, in JSON format. The syntax depends on the constraint type as follows:

      LAUNCH

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

      Specify the RoleArn property as follows:

      {"RoleArn" : "arn:aws:iam::123456789012:role/LaunchRole"}

      Specify the LocalRoleName property as follows:

      {"LocalRoleName": "SCBasicLaunchRole"}

      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.

      You cannot have both a LAUNCH and a STACKSET constraint.

      You also cannot have more than one LAUNCH constraint on a product and portfolio.

      NOTIFICATION

      Specify the NotificationArns property as follows:

      {"NotificationArns" : ["arn:aws:sns:us-east-1:123456789012:Topic"]}

      RESOURCE_UPDATE

      Specify the TagUpdatesOnProvisionedProduct property as follows:

      {"Version":"2.0","Properties":{"TagUpdateOnProvisionedProduct":"String"}}

      The TagUpdatesOnProvisionedProduct property accepts a string value of ALLOWED or NOT_ALLOWED.

      STACKSET

      Specify the Parameters property as follows:

      {"Version": "String", "Properties": {"AccountList": [ "String" ], "RegionList": [ "String" ], "AdminRole": "String", "ExecutionRole": "String"}}

      You cannot have both a LAUNCH and a STACKSET constraint.

      You also cannot have more than one STACKSET constraint on a product and portfolio.

      Products with a STACKSET constraint will launch an CloudFormation stack set.

      TEMPLATE

      Specify the Rules property. For more information, see Template Constraint Rules.

      Parameters:
      parameters - The constraint parameters, in JSON format. The syntax depends on the constraint type as follows:

      LAUNCH

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

      Specify the RoleArn property as follows:

      {"RoleArn" : "arn:aws:iam::123456789012:role/LaunchRole"}

      Specify the LocalRoleName property as follows:

      {"LocalRoleName": "SCBasicLaunchRole"}

      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.

      You cannot have both a LAUNCH and a STACKSET constraint.

      You also cannot have more than one LAUNCH constraint on a product and portfolio.

      NOTIFICATION

      Specify the NotificationArns property as follows:

      {"NotificationArns" : ["arn:aws:sns:us-east-1:123456789012:Topic"]}

      RESOURCE_UPDATE

      Specify the TagUpdatesOnProvisionedProduct property as follows:

      {"Version":"2.0","Properties":{"TagUpdateOnProvisionedProduct":"String"}}

      The TagUpdatesOnProvisionedProduct property accepts a string value of ALLOWED or NOT_ALLOWED.

      STACKSET

      Specify the Parameters property as follows:

      {"Version": "String", "Properties": {"AccountList": [ "String" ], "RegionList": [ "String" ], "AdminRole": "String", "ExecutionRole": "String"}}

      You cannot have both a LAUNCH and a STACKSET constraint.

      You also cannot have more than one STACKSET constraint on a product and portfolio.

      Products with a STACKSET constraint will launch an CloudFormation stack set.

      TEMPLATE

      Specify the Rules property. For more information, see Template Constraint Rules.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • type

      CreateConstraintRequest.Builder type(String type)

      The type of constraint.

      • LAUNCH

      • NOTIFICATION

      • RESOURCE_UPDATE

      • STACKSET

      • TEMPLATE

      Parameters:
      type - The type of constraint.

      • LAUNCH

      • NOTIFICATION

      • RESOURCE_UPDATE

      • STACKSET

      • TEMPLATE

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      CreateConstraintRequest.Builder description(String description)

      The description of the constraint.

      Parameters:
      description - The description of the constraint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • idempotencyToken

      CreateConstraintRequest.Builder idempotencyToken(String idempotencyToken)

      A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

      Parameters:
      idempotencyToken - A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      CreateConstraintRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateConstraintRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.