Class: Aws::CloudFormation::Types::RegisterTypeInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::CloudFormation::Types::RegisterTypeInput
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-cloudformation/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#client_request_token ⇒ String
A unique identifier that acts as an idempotency key for this registration request.
-
#execution_role_arn ⇒ String
The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the extension.
-
#logging_config ⇒ Types::LoggingConfig
Specifies logging configuration information for an extension.
-
#schema_handler_package ⇒ String
A URL to the S3 bucket containing the extension project package that contains the necessary files for the extension you want to register.
-
#type ⇒ String
The kind of extension.
-
#type_name ⇒ String
The name of the extension being registered.
Instance Attribute Details
#client_request_token ⇒ String
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.
6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 6498 class RegisterTypeInput < Struct.new( :type, :type_name, :schema_handler_package, :logging_config, :execution_role_arn, :client_request_token) SENSITIVE = [] include Aws::Structure end |
#execution_role_arn ⇒ String
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 <a href=“https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html”>IAM execution role</a> 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.
6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 6498 class RegisterTypeInput < Struct.new( :type, :type_name, :schema_handler_package, :logging_config, :execution_role_arn, :client_request_token) SENSITIVE = [] include Aws::Structure end |
#logging_config ⇒ Types::LoggingConfig
Specifies logging configuration information for an extension.
6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 6498 class RegisterTypeInput < Struct.new( :type, :type_name, :schema_handler_package, :logging_config, :execution_role_arn, :client_request_token) SENSITIVE = [] include Aws::Structure end |
#schema_handler_package ⇒ String
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*.
<note markdown=“1”> The user registering the extension must be able to access the package in the S3 bucket. That’s, the user needs to have
- GetObject][2
-
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*.
</note>
[1]: docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-cli-submit.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html [3]: docs.aws.amazon.com/IAM/latest/UserGuide/list_amazons3.html
6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 6498 class RegisterTypeInput < Struct.new( :type, :type_name, :schema_handler_package, :logging_config, :execution_role_arn, :client_request_token) SENSITIVE = [] include Aws::Structure end |
#type ⇒ String
The kind of extension.
6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 6498 class RegisterTypeInput < Struct.new( :type, :type_name, :schema_handler_package, :logging_config, :execution_role_arn, :client_request_token) SENSITIVE = [] include Aws::Structure end |
#type_name ⇒ String
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.
<note markdown=“1”> The following organization namespaces are reserved and can’t be used in your extension names:
* `Alexa`
-
‘AMZN`
-
‘Amazon`
-
‘AWS`
-
‘Custom`
-
‘Dev`
</note>
6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 6498 class RegisterTypeInput < Struct.new( :type, :type_name, :schema_handler_package, :logging_config, :execution_role_arn, :client_request_token) SENSITIVE = [] include Aws::Structure end |