software.amazon.awssdk.services.cloudformation.model

Class RegisterTypeRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.cloudformation.model.CloudFormationRequest

software.amazon.awssdk.services.cloudformation.model.RegisterTypeRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<RegisterTypeRequest.Builder,RegisterTypeRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RegisterTypeRequest.Builder

Method Summary

Modifier and Type	Method and Description
static RegisterTypeRequest.Builder	builder()
String	clientRequestToken() A unique identifier that acts as an idempotency key for this registration request.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	executionRoleArn() The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the resource provider.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
LoggingConfig	loggingConfig() Specifies logging configuration information for a type.
String	schemaHandlerPackage() A url to the S3 bucket containing the schema handler package that contains the schema, event handlers, and associated files for the type you want to register.
List<SdkField<?>>	sdkFields()
static Class<? extends RegisterTypeRequest.Builder>	serializableBuilderClass()
RegisterTypeRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
RegistryType	type() The kind of type.
String	typeAsString() The kind of type.
String	typeName() The name of the type being registered.

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

type

public final RegistryType type()

The kind of type.

Currently, the only valid value is RESOURCE.

If the service returns an enum value that is not available in the current SDK version, type will return RegistryType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The kind of type.

Currently, the only valid value is RESOURCE.

See Also:

RegistryType

typeAsString

public final String typeAsString()

The kind of type.

Currently, the only valid value is RESOURCE.

If the service returns an enum value that is not available in the current SDK version, type will return RegistryType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The kind of type.

Currently, the only valid value is RESOURCE.

See Also:

RegistryType

typeName

public final String typeName()

The name of the type being registered.

We recommend that type names adhere to the following pattern: company_or_organization::service::type.

The following organization namespaces are reserved and cannot be used in your resource type names:

• Alexa

• AMZN

• Amazon

• AWS

• Custom

• Dev

Returns:

The name of the type being registered.

We recommend that type names adhere to the following pattern: company_or_organization::service::type.

The following organization namespaces are reserved and cannot be used in your resource type names:

• Alexa

• AMZN

• Amazon

• AWS

• Custom

• Dev

schemaHandlerPackage

public final String schemaHandlerPackage()

A url to the S3 bucket containing the schema handler package that contains the schema, event handlers, and associated files for the type you want to register.

For information on generating a schema handler package for the type you want to register, see submit in the CloudFormation CLI User Guide.

The user registering the resource provider type must be able to access the the schema handler package in the S3 bucket. That is, the user needs to have GetObject permissions for the schema handler package. For more information, see Actions, Resources, and Condition Keys for Amazon S3 in the AWS Identity and Access Management User Guide.

Returns:

A url to the S3 bucket containing the schema handler package that contains the schema, event handlers, and associated files for the type you want to register.

For information on generating a schema handler package for the type you want to register, see submit in the CloudFormation CLI User Guide.

The user registering the resource provider type must be able to access the the schema handler package in the S3 bucket. That is, the user needs to have GetObject permissions for the schema handler package. For more information, see Actions, Resources, and Condition Keys for Amazon S3 in the AWS Identity and Access Management User Guide.

loggingConfig

public final LoggingConfig loggingConfig()

Specifies logging configuration information for a type.

Returns:

Specifies logging configuration information for a type.

executionRoleArn

public final String executionRoleArn()

The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the resource provider. If your resource type calls AWS APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those AWS APIs, and provision that execution role in your account. When CloudFormation needs to invoke the resource provider handler, CloudFormation assumes this execution role to create a temporary session token, which it then passes to the resource provider handler, thereby supplying your resource provider with the appropriate credentials.

Returns:

The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the resource provider. If your resource type calls AWS APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those AWS APIs, and provision that execution role in your account. When CloudFormation needs to invoke the resource provider handler, CloudFormation assumes this execution role to create a temporary session token, which it then passes to the resource provider handler, thereby supplying your resource provider with the appropriate credentials.

clientRequestToken

public final String clientRequestToken()

A unique identifier that acts as an idempotency key for this registration request. Specifying a client request token prevents CloudFormation from generating more than one version of a type from the same registeration request, even if the request is submitted multiple times.

Returns:

A unique identifier that acts as an idempotency key for this registration request. Specifying a client request token prevents CloudFormation from generating more than one version of a type from the same registeration request, even if the request is submitted multiple times.

toBuilder

public RegisterTypeRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RegisterTypeRequest.Builder,RegisterTypeRequest>

Specified by:

toBuilder in class CloudFormationRequest

builder

public static RegisterTypeRequest.Builder builder()

serializableBuilderClass

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