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("software.amazon.awssdk:codegen")
public final class CreateConstraintRequest
extends ServiceCatalogRequest
implements ToCopyableBuilder<CreateConstraintRequest.Builder,CreateConstraintRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface CreateConstraintRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`acceptLanguage()`	The language code.
`static CreateConstraintRequest.Builder`	`builder()`
`String`	`description()`	The description of the constraint.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`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.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateConstraintRequest.Builder>`	`serializableBuilderClass()`
`CreateConstraintRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`String`	`type()`	The type of constraint.

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

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - acceptLanguage
```
public final String acceptLanguage()
```
    The language code.
    
    jp - Japanese
    
    zh - Chinese
    Returns:
    
    The language code.
    
    jp - Japanese
    
    zh - Chinese
  - portfolioId
```
public final String portfolioId()
```
    The portfolio identifier.
    
    Returns:
    
    The portfolio identifier.
  - productId
```
public final String productId()
```
    The product identifier.
    
    Returns:
    
    The product identifier.
  - parameters
```
public final 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.
    
    Returns:
    
    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.
  - type
```
public final String type()
```
    The type of constraint.
    
    LAUNCH
    
    NOTIFICATION
    
    RESOURCE_UPDATE
    
    STACKSET
    
    TEMPLATE
    Returns:
    
    The type of constraint.
    
    LAUNCH
    
    NOTIFICATION
    
    RESOURCE_UPDATE
    
    STACKSET
    
    TEMPLATE
  - description
```
public final String description()
```
    The description of the constraint.
    
    Returns:
    
    The description of the constraint.
  - idempotencyToken
```
public final 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateConstraintRequest.Builder,CreateConstraintRequest>
    
    Specified by:
    
    toBuilder in class ServiceCatalogRequest
  - builder
```
public static CreateConstraintRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateConstraintRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class CreateConstraintRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

acceptLanguage

portfolioId

productId

parameters

type

description

idempotencyToken

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField