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 resource
provider.
|
default RegisterTypeRequest.Builder |
loggingConfig(Consumer<LoggingConfig.Builder> loggingConfig)
Specifies logging configuration information for a type.
|
RegisterTypeRequest.Builder |
loggingConfig(LoggingConfig loggingConfig)
Specifies logging configuration information for a type.
|
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 schema handler package that contains the schema, event handlers, and
associated files for the type you want to register.
|
RegisterTypeRequest.Builder |
type(RegistryType type)
The kind of type.
|
RegisterTypeRequest.Builder |
type(String type)
The kind of type.
|
RegisterTypeRequest.Builder |
typeName(String typeName)
The name of the type being registered.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildRegisterTypeRequest.Builder type(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,
RegistryTypeRegisterTypeRequest.Builder type(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,
RegistryTypeRegisterTypeRequest.Builder typeName(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
RegisterTypeRequest.Builder schemaHandlerPackage(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.
RegisterTypeRequest.Builder loggingConfig(LoggingConfig loggingConfig)
Specifies logging configuration information for a type.
loggingConfig - Specifies logging configuration information for a type.default RegisterTypeRequest.Builder loggingConfig(Consumer<LoggingConfig.Builder> loggingConfig)
Specifies logging configuration information for a type.
This is a convenience 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 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.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 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.RegisterTypeRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderRegisterTypeRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2020. All rights reserved.