software.amazon.awssdk.services.cloudcontrol.model

Class CreateResourceRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.cloudcontrol.model.CloudControlRequest

software.amazon.awssdk.services.cloudcontrol.model.CreateResourceRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateResourceRequest.Builder,CreateResourceRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateResourceRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateResourceRequest.Builder	builder()
String	clientToken() A unique identifier to ensure the idempotency of the resource request.
String	desiredState() Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	roleArn() The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role for Cloud Control API to use when performing this resource operation.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateResourceRequest.Builder>	serializableBuilderClass()
CreateResourceRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	typeName() The name of the resource type.
String	typeVersionId() For private resource types, the type version to use in this resource operation.

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

typeName

public final String typeName()

The name of the resource type.

Returns:

The name of the resource type.

typeVersionId

public final String typeVersionId()

For private resource types, the type version to use in this resource operation. If you do not specify a resource version, CloudFormation uses the default version.

Returns:

For private resource types, the type version to use in this resource operation. If you do not specify a resource version, CloudFormation uses the default version.

roleArn

public final String roleArn()

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role for Cloud Control API to use when performing this resource operation. The role specified must have the permissions required for this operation. The necessary permissions for each event handler are defined in the handlers section of the resource type definition schema.

If you do not specify a role, Cloud Control API uses a temporary session created using your Amazon Web Services user credentials.

For more information, see Specifying credentials in the Amazon Web Services Cloud Control API User Guide.

Returns:

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role for Cloud Control API to use when performing this resource operation. The role specified must have the permissions required for this operation. The necessary permissions for each event handler are defined in the handlers section of the resource type definition schema.

If you do not specify a role, Cloud Control API uses a temporary session created using your Amazon Web Services user credentials.

For more information, see Specifying credentials in the Amazon Web Services Cloud Control API User Guide.

clientToken

public final String clientToken()

A unique identifier to ensure the idempotency of the resource request. As a best practice, specify this token to ensure idempotency, so that Amazon Web Services Cloud Control API can accurately distinguish between request retries and new resource requests. You might retry a resource request to ensure that it was successfully received.

A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request.

If you do not specify a client token, one is generated for inclusion in the request.

For more information, see Ensuring resource operation requests are unique in the Amazon Web Services Cloud Control API User Guide.

Returns:

A unique identifier to ensure the idempotency of the resource request. As a best practice, specify this token to ensure idempotency, so that Amazon Web Services Cloud Control API can accurately distinguish between request retries and new resource requests. You might retry a resource request to ensure that it was successfully received.

A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request.

If you do not specify a client token, one is generated for inclusion in the request.

For more information, see Ensuring resource operation requests are unique in the Amazon Web Services Cloud Control API User Guide.

desiredState

public final String desiredState()

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

Specify the desired state as one of the following:

• A JSON blob

• A local path containing the desired state in JSON data format

For more information, see Composing the desired state of the resource in the Amazon Web Services Cloud Control API User Guide.

For more information about the properties of a specific resource, refer to the related topic for the resource in the Resource and property types reference in the CloudFormation Users Guide.

Returns:

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

Specify the desired state as one of the following:

• A JSON blob

• A local path containing the desired state in JSON data format

For more information, see Composing the desired state of the resource in the Amazon Web Services Cloud Control API User Guide.

For more information about the properties of a specific resource, refer to the related topic for the resource in the Resource and property types reference in the CloudFormation Users Guide.

toBuilder

public CreateResourceRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateResourceRequest.Builder,CreateResourceRequest>

Specified by:

toBuilder in class CloudControlRequest

builder

public static CreateResourceRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateResourceRequest.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