@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class RegisterTypeRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
RegisterTypeRequest() |
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.
|
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
public void setType(String type)
The kind of extension.
type
- The kind of extension.RegistryType
public String getType()
The kind of extension.
RegistryType
public RegisterTypeRequest withType(String type)
The kind of extension.
type
- The kind of extension.RegistryType
public RegisterTypeRequest withType(RegistryType type)
The kind of extension.
type
- The kind of extension.RegistryType
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
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
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
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
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
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
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.
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.
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.
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.
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.
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.
public void setLoggingConfig(LoggingConfig loggingConfig)
Specifies logging configuration information for an extension.
loggingConfig
- Specifies logging configuration information for an extension.public LoggingConfig getLoggingConfig()
Specifies logging configuration information for an extension.
public RegisterTypeRequest withLoggingConfig(LoggingConfig loggingConfig)
Specifies logging configuration information for an extension.
loggingConfig
- Specifies logging configuration information for an extension.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 principal (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.
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 principal (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.
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 principal (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.
For CloudFormation to assume the specified execution role, the role must contain a trust relationship
with the CloudFormation service principal (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.
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 principal (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.
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 principal (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.
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.
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.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.
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.
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.public String toString()
toString
in class Object
Object.toString()
public RegisterTypeRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()