Interface CreateConstraintRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateConstraintRequest.Builder,
,CreateConstraintRequest> SdkBuilder<CreateConstraintRequest.Builder,
,CreateConstraintRequest> SdkPojo
,SdkRequest.Builder
,ServiceCatalogRequest.Builder
- Enclosing class:
CreateConstraintRequest
-
Method Summary
Modifier and TypeMethodDescriptionacceptLanguage
(String acceptLanguage) The language code.description
(String description) The description of the constraint.idempotencyToken
(String idempotencyToken) A unique identifier that you provide to ensure idempotency.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.parameters
(String parameters) The constraint parameters, in JSON format.portfolioId
(String portfolioId) The portfolio identifier.The product identifier.The type of constraint.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
Methods inherited from interface software.amazon.awssdk.services.servicecatalog.model.ServiceCatalogRequest.Builder
build
-
Method Details
-
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
The portfolio identifier.
- Parameters:
portfolioId
- The portfolio identifier.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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 theLocalRoleName
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 aSTACKSET
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 ofALLOWED
orNOT_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 aSTACKSET
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 theLocalRoleName
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 aSTACKSET
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 ofALLOWED
orNOT_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 aSTACKSET
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
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
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
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 interfaceAwsRequest.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 interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-