software.amazon.awssdk.services.servicecatalog.model

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 Summary

Modifier and Type	Method and Description
CreateConstraintRequest.Builder	acceptLanguage(String acceptLanguage) The language code.
CreateConstraintRequest.Builder	description(String description) The description of the constraint.
CreateConstraintRequest.Builder	idempotencyToken(String idempotencyToken) A unique identifier that you provide to ensure idempotency.
CreateConstraintRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
CreateConstraintRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
CreateConstraintRequest.Builder	parameters(String parameters) The constraint parameters, in JSON format.
CreateConstraintRequest.Builder	portfolioId(String portfolioId) The portfolio identifier.
CreateConstraintRequest.Builder	productId(String productId) The product identifier.
CreateConstraintRequest.Builder	type(String type) The type of constraint.

Methods inherited from interface software.amazon.awssdk.services.servicecatalog.model.ServiceCatalogRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

acceptLanguage

CreateConstraintRequest.Builder acceptLanguage(String acceptLanguage)

The language code.

• en - English (default)

• jp - Japanese

• zh - Chinese

Parameters:

acceptLanguage - The language code.

• en - English (default)

• 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

Specify the RoleArn property as follows:

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

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"]}

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 AWS 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

Specify the RoleArn property as follows:

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

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"]}

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 AWS 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

• STACKSET

• TEMPLATE

Parameters:

type - The type of constraint.

• LAUNCH

• NOTIFICATION

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