public static interface RegisterTypeRequest.Builder extends CloudFormationRequest.Builder, SdkPojo, CopyableBuilder<RegisterTypeRequest.Builder,RegisterTypeRequest>
| Modifier and Type | Method and Description |
|---|---|
RegisterTypeRequest.Builder |
clientRequestToken(String clientRequestToken)
A unique identifier that acts as an idempotency key for this registration request.
|
RegisterTypeRequest.Builder |
executionRoleArn(String executionRoleArn)
The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the extension.
|
default RegisterTypeRequest.Builder |
loggingConfig(Consumer<LoggingConfig.Builder> loggingConfig)
Specifies logging configuration information for an extension.
|
RegisterTypeRequest.Builder |
loggingConfig(LoggingConfig loggingConfig)
Specifies logging configuration information for an extension.
|
RegisterTypeRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
RegisterTypeRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
RegisterTypeRequest.Builder |
schemaHandlerPackage(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.Builder |
type(RegistryType type)
The kind of extension.
|
RegisterTypeRequest.Builder |
type(String type)
The kind of extension.
|
RegisterTypeRequest.Builder |
typeName(String typeName)
The name of the extension being registered.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildRegisterTypeRequest.Builder type(String type)
The kind of extension.
type - The kind of extension.RegistryType,
RegistryTypeRegisterTypeRequest.Builder type(RegistryType type)
The kind of extension.
type - The kind of extension.RegistryType,
RegistryTypeRegisterTypeRequest.Builder typeName(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
RegisterTypeRequest.Builder schemaHandlerPackage(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.
RegisterTypeRequest.Builder loggingConfig(LoggingConfig loggingConfig)
Specifies logging configuration information for an extension.
loggingConfig - Specifies logging configuration information for an extension.default RegisterTypeRequest.Builder loggingConfig(Consumer<LoggingConfig.Builder> loggingConfig)
Specifies logging configuration information for an extension.
This is a convenience method that creates an instance of theLoggingConfig.Builder avoiding the need
to create one manually via LoggingConfig.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to loggingConfig(LoggingConfig).
loggingConfig - a consumer that will call methods on LoggingConfig.BuilderloggingConfig(LoggingConfig)RegisterTypeRequest.Builder executionRoleArn(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.
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.
RegisterTypeRequest.Builder clientRequestToken(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.RegisterTypeRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderRegisterTypeRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2022. All rights reserved.