software.amazon.awssdk.services.servicecatalog.model

Class CreateConstraintRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.servicecatalog.model.ServiceCatalogRequest

software.amazon.awssdk.services.servicecatalog.model.CreateConstraintRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateConstraintRequest.Builder,CreateConstraintRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateConstraintRequest
extends ServiceCatalogRequest
implements ToCopyableBuilder<CreateConstraintRequest.Builder,CreateConstraintRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateConstraintRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	acceptLanguage() The language code.
static CreateConstraintRequest.Builder	builder()
String	description() The description of the constraint.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
String	idempotencyToken() A unique identifier that you provide to ensure idempotency.
String	parameters() The constraint parameters, in JSON format.
String	portfolioId() The portfolio identifier.
String	productId() The product identifier.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateConstraintRequest.Builder>	serializableBuilderClass()
CreateConstraintRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	type() The type of constraint.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

acceptLanguage

public String acceptLanguage()

The language code.

• en - English (default)

• jp - Japanese

• zh - Chinese

Returns:

The language code.

• en - English (default)

• jp - Japanese

• zh - Chinese

portfolioId

public String portfolioId()

The portfolio identifier.

Returns:

The portfolio identifier.

productId

public String productId()

The product identifier.

Returns:

The product identifier.

parameters

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

Returns:

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.

type

public String type()

The type of constraint.

• LAUNCH

• NOTIFICATION

• STACKSET

• TEMPLATE

Returns:

The type of constraint.

• LAUNCH

• NOTIFICATION

• STACKSET

• TEMPLATE

description

public String description()

The description of the constraint.

Returns:

The description of the constraint.

idempotencyToken

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

Returns:

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.

toBuilder

public CreateConstraintRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CreateConstraintRequest.Builder,CreateConstraintRequest>

Specified by:

toBuilder in class ServiceCatalogRequest

Returns:

a builder for type T

builder

public static CreateConstraintRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateConstraintRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.