com.amazonaws.services.cloudformation.model

Class RegisterTypeRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cloudformation.model.RegisterTypeRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class RegisterTypeRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
RegisterTypeRequest()

Method Summary

Modifier and Type	Method and Description
RegisterTypeRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getClientRequestToken() A unique identifier that acts as an idempotency key for this registration request.
String	getExecutionRoleArn() The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the extension.
LoggingConfig	getLoggingConfig() Specifies logging configuration information for an extension.
String	getSchemaHandlerPackage() A URL to the S3 bucket containing the extension project package that contains the necessary files for the extension you want to register.
String	getType() The kind of extension.
String	getTypeName() The name of the extension being registered.
int	hashCode()
void	setClientRequestToken(String clientRequestToken) A unique identifier that acts as an idempotency key for this registration request.
void	setExecutionRoleArn(String executionRoleArn) The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the extension.
void	setLoggingConfig(LoggingConfig loggingConfig) Specifies logging configuration information for an extension.
void	setSchemaHandlerPackage(String schemaHandlerPackage) A URL to the S3 bucket containing the extension project package that contains the necessary files for the extension you want to register.
void	setType(String type) The kind of extension.
void	setTypeName(String typeName) The name of the extension being registered.
String	toString() Returns a string representation of this object.
RegisterTypeRequest	withClientRequestToken(String clientRequestToken) A unique identifier that acts as an idempotency key for this registration request.
RegisterTypeRequest	withExecutionRoleArn(String executionRoleArn) The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the extension.
RegisterTypeRequest	withLoggingConfig(LoggingConfig loggingConfig) Specifies logging configuration information for an extension.
RegisterTypeRequest	withSchemaHandlerPackage(String schemaHandlerPackage) A URL to the S3 bucket containing the extension project package that contains the necessary files for the extension you want to register.
RegisterTypeRequest	withType(RegistryType type) The kind of extension.
RegisterTypeRequest	withType(String type) The kind of extension.
RegisterTypeRequest	withTypeName(String typeName) The name of the extension being registered.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RegisterTypeRequest

public RegisterTypeRequest()

Method Detail

setType

public void setType(String type)

The kind of extension.

Parameters:

type - The kind of extension.

See Also:

RegistryType

getType

public String getType()

The kind of extension.

Returns:

The kind of extension.

See Also:

RegistryType

withType

public RegisterTypeRequest withType(String type)

The kind of extension.

Parameters:

type - The kind of extension.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

RegistryType

withType

public RegisterTypeRequest withType(RegistryType type)

The kind of extension.

Parameters:

type - The kind of extension.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

RegistryType

setTypeName

public void setTypeName(String typeName)

The name of the extension being registered.

We suggest that extension names adhere to the following patterns:

• For resource types, company_or_organization::service::type.

• For modules, company_or_organization::service::type::MODULE.

• For hooks, MyCompany::Testing::MyTestHook.

The following organization namespaces are reserved and can't be used in your extension names:

• Alexa

• AMZN

• Amazon

• AWS

• Custom

• Dev

Parameters:

typeName - The name of the extension being registered.

We suggest that extension names adhere to the following patterns:

• For resource types, company_or_organization::service::type.

• For modules, company_or_organization::service::type::MODULE.

• For hooks, MyCompany::Testing::MyTestHook.

The following organization namespaces are reserved and can't be used in your extension names:

• Alexa

• AMZN

• Amazon

• AWS

• Custom

• Dev

getTypeName

public String getTypeName()

The name of the extension being registered.

We suggest that extension names adhere to the following patterns:

• For resource types, company_or_organization::service::type.

• For modules, company_or_organization::service::type::MODULE.

• For hooks, MyCompany::Testing::MyTestHook.

The following organization namespaces are reserved and can't be used in your extension names:

• Alexa

• AMZN

• Amazon

• AWS

• Custom

• Dev

Returns:

The name of the extension being registered.

We suggest that extension names adhere to the following patterns:

• For resource types, company_or_organization::service::type.

• For modules, company_or_organization::service::type::MODULE.

• For hooks, MyCompany::Testing::MyTestHook.

The following organization namespaces are reserved and can't be used in your extension names:

• Alexa

• AMZN

• Amazon

• AWS

• Custom

• Dev

withTypeName

public RegisterTypeRequest withTypeName(String typeName)

The name of the extension being registered.

We suggest that extension names adhere to the following patterns:

• For resource types, company_or_organization::service::type.

• For modules, company_or_organization::service::type::MODULE.

• For hooks, MyCompany::Testing::MyTestHook.

The following organization namespaces are reserved and can't be used in your extension names:

• Alexa

• AMZN

• Amazon

• AWS

• Custom

• Dev

Parameters:

typeName - The name of the extension being registered.

We suggest that extension names adhere to the following patterns:

• For resource types, company_or_organization::service::type.

• For modules, company_or_organization::service::type::MODULE.

• For hooks, MyCompany::Testing::MyTestHook.

The following organization namespaces are reserved and can't be used in your extension names:

• Alexa

• AMZN

• Amazon

• AWS

• Custom

• Dev

Returns:

Returns a reference to this object so that method calls can be chained together.

setSchemaHandlerPackage

public void setSchemaHandlerPackage(String schemaHandlerPackage)

A URL to the S3 bucket containing the extension project package that contains the necessary files for the extension you want to register.

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

The user registering the extension must be able to access the package in the S3 bucket. That's, 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 Identity and Access Management User Guide.

Parameters:

schemaHandlerPackage - A URL to the S3 bucket containing the extension project package that contains the necessary files for the extension you want to register.

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

The user registering the extension must be able to access the package in the S3 bucket. That's, 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 Identity and Access Management User Guide.

getSchemaHandlerPackage

public String getSchemaHandlerPackage()

A URL to the S3 bucket containing the extension project package that contains the necessary files for the extension you want to register.

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

The user registering the extension must be able to access the package in the S3 bucket. That's, 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 Identity and Access Management User Guide.

Returns:

A URL to the S3 bucket containing the extension project package that contains the necessary files for the extension you want to register.

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

The user registering the extension must be able to access the package in the S3 bucket. That's, 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 Identity and Access Management User Guide.

withSchemaHandlerPackage

public RegisterTypeRequest withSchemaHandlerPackage(String schemaHandlerPackage)

A URL to the S3 bucket containing the extension project package that contains the necessary files for the extension you want to register.

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

The user registering the extension must be able to access the package in the S3 bucket. That's, 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 Identity and Access Management User Guide.

Parameters:

schemaHandlerPackage - A URL to the S3 bucket containing the extension project package that contains the necessary files for the extension you want to register.

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

The user registering the extension must be able to access the package in the S3 bucket. That's, 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 Identity and Access Management User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

setLoggingConfig

public void setLoggingConfig(LoggingConfig loggingConfig)

Specifies logging configuration information for an extension.

Parameters:

loggingConfig - Specifies logging configuration information for an extension.

getLoggingConfig

public LoggingConfig getLoggingConfig()

Specifies logging configuration information for an extension.

Returns:

Specifies logging configuration information for an extension.

withLoggingConfig

public RegisterTypeRequest withLoggingConfig(LoggingConfig loggingConfig)

Specifies logging configuration information for an extension.

Parameters:

loggingConfig - Specifies logging configuration information for an extension.

Returns:

Returns a reference to this object so that method calls can be chained together.

setExecutionRoleArn

public void setExecutionRoleArn(String executionRoleArn)

The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the extension.

For CloudFormation to assume the specified execution role, the role must contain a trust relationship with the CloudFormation service principle (resources.cloudformation.amazonaws.com). For more information about adding trust relationships, see Modifying a role trust policy in the Identity and Access Management User Guide.

If your extension calls Amazon Web Services APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those Amazon Web Services APIs, and provision that execution role in your account. When CloudFormation needs to invoke the resource type handler, CloudFormation assumes this execution role to create a temporary session token, which it then passes to the resource type handler, thereby supplying your resource type with the appropriate credentials.

Parameters:

executionRoleArn - The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the extension.

For CloudFormation to assume the specified execution role, the role must contain a trust relationship with the CloudFormation service principle (resources.cloudformation.amazonaws.com). For more information about adding trust relationships, see Modifying a role trust policy in the Identity and Access Management User Guide.

If your extension calls Amazon Web Services APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those Amazon Web Services APIs, and provision that execution role in your account. When CloudFormation needs to invoke the resource type handler, CloudFormation assumes this execution role to create a temporary session token, which it then passes to the resource type handler, thereby supplying your resource type with the appropriate credentials.

getExecutionRoleArn

public String getExecutionRoleArn()

The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the extension.

For CloudFormation to assume the specified execution role, the role must contain a trust relationship with the CloudFormation service principle (resources.cloudformation.amazonaws.com). For more information about adding trust relationships, see Modifying a role trust policy in the Identity and Access Management User Guide.

If your extension calls Amazon Web Services APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those Amazon Web Services APIs, and provision that execution role in your account. When CloudFormation needs to invoke the resource type handler, CloudFormation assumes this execution role to create a temporary session token, which it then passes to the resource type handler, thereby supplying your resource type with the appropriate credentials.

Returns:

The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the extension.

For CloudFormation to assume the specified execution role, the role must contain a trust relationship with the CloudFormation service principle (resources.cloudformation.amazonaws.com). For more information about adding trust relationships, see Modifying a role trust policy in the Identity and Access Management User Guide.

If your extension calls Amazon Web Services APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those Amazon Web Services APIs, and provision that execution role in your account. When CloudFormation needs to invoke the resource type handler, CloudFormation assumes this execution role to create a temporary session token, which it then passes to the resource type handler, thereby supplying your resource type with the appropriate credentials.

withExecutionRoleArn

public RegisterTypeRequest withExecutionRoleArn(String executionRoleArn)

The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the extension.

For CloudFormation to assume the specified execution role, the role must contain a trust relationship with the CloudFormation service principle (resources.cloudformation.amazonaws.com). For more information about adding trust relationships, see Modifying a role trust policy in the Identity and Access Management User Guide.

If your extension calls Amazon Web Services APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those Amazon Web Services APIs, and provision that execution role in your account. When CloudFormation needs to invoke the resource type handler, CloudFormation assumes this execution role to create a temporary session token, which it then passes to the resource type handler, thereby supplying your resource type with the appropriate credentials.

Parameters:

executionRoleArn - The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the extension.

For CloudFormation to assume the specified execution role, the role must contain a trust relationship with the CloudFormation service principle (resources.cloudformation.amazonaws.com). For more information about adding trust relationships, see Modifying a role trust policy in the Identity and Access Management User Guide.

If your extension calls Amazon Web Services APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those Amazon Web Services APIs, and provision that execution role in your account. When CloudFormation needs to invoke the resource type handler, CloudFormation assumes this execution role to create a temporary session token, which it then passes to the resource type handler, thereby supplying your resource type with the appropriate credentials.

Returns:

Returns a reference to this object so that method calls can be chained together.

setClientRequestToken

public void setClientRequestToken(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 an extension from the same registration request, even if the request is submitted multiple times.

Parameters:

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 an extension from the same registration request, even if the request is submitted multiple times.

getClientRequestToken

public String getClientRequestToken()

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 an extension from the same registration 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 an extension from the same registration request, even if the request is submitted multiple times.

withClientRequestToken

public RegisterTypeRequest withClientRequestToken(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 an extension from the same registration request, even if the request is submitted multiple times.

Parameters:

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 an extension from the same registration request, even if the request is submitted multiple times.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public RegisterTypeRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()