@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 resource provider.
|
LoggingConfig |
getLoggingConfig()
Specifies logging configuration information for a type.
|
String |
getSchemaHandlerPackage()
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.
|
String |
getType()
The kind of type.
|
String |
getTypeName()
The name of the type 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 resource provider.
|
void |
setLoggingConfig(LoggingConfig loggingConfig)
Specifies logging configuration information for a type.
|
void |
setSchemaHandlerPackage(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.
|
void |
setType(String type)
The kind of type.
|
void |
setTypeName(String typeName)
The name of the type 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 resource provider.
|
RegisterTypeRequest |
withLoggingConfig(LoggingConfig loggingConfig)
Specifies logging configuration information for a type.
|
RegisterTypeRequest |
withSchemaHandlerPackage(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.
|
RegisterTypeRequest |
withType(RegistryType type)
The kind of type.
|
RegisterTypeRequest |
withType(String type)
The kind of type.
|
RegisterTypeRequest |
withTypeName(String typeName)
The name of the type 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 type.
Currently, the only valid value is RESOURCE
.
type
- The kind of type.
Currently, the only valid value is RESOURCE
.
RegistryType
public String getType()
The kind of type.
Currently, the only valid value is RESOURCE
.
Currently, the only valid value is RESOURCE
.
RegistryType
public RegisterTypeRequest withType(String type)
The kind of type.
Currently, the only valid value is RESOURCE
.
type
- The kind of type.
Currently, the only valid value is RESOURCE
.
RegistryType
public RegisterTypeRequest withType(RegistryType type)
The kind of type.
Currently, the only valid value is RESOURCE
.
type
- The kind of type.
Currently, the only valid value is RESOURCE
.
RegistryType
public void setTypeName(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
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
public String getTypeName()
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
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
public RegisterTypeRequest withTypeName(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
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
public void setSchemaHandlerPackage(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.
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.
public String getSchemaHandlerPackage()
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.
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.
public RegisterTypeRequest withSchemaHandlerPackage(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.
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.
public void setLoggingConfig(LoggingConfig loggingConfig)
Specifies logging configuration information for a type.
loggingConfig
- Specifies logging configuration information for a type.public LoggingConfig getLoggingConfig()
Specifies logging configuration information for a type.
public RegisterTypeRequest withLoggingConfig(LoggingConfig loggingConfig)
Specifies logging configuration information for a type.
loggingConfig
- Specifies logging configuration information for a type.public void setExecutionRoleArn(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.
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.public String getExecutionRoleArn()
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.
public RegisterTypeRequest withExecutionRoleArn(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.
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.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 a type from the same registeration 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 a type from the same
registeration 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 a type from the same registeration 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 a type from the same registeration 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 a type from the same
registeration 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()