Class: Aws::CloudFormation::Types::RegisterTypeInput

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cloudformation/types.rb

Overview

Note:

When making an API call, you may pass RegisterTypeInput data as a hash:

{
  type: "RESOURCE", # accepts RESOURCE, MODULE
  type_name: "TypeName", # required
  schema_handler_package: "S3Url", # required
  logging_config: {
    log_role_arn: "RoleArn", # required
    log_group_name: "LogGroupName", # required
  },
  execution_role_arn: "RoleArn",
  client_request_token: "RequestToken",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_request_tokenString

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 registeration request, even if the request is submitted multiple times.

Returns:

  • (String)

5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
# File 'lib/aws-sdk-cloudformation/types.rb', line 5978

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_arnString

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 on adding trust relationships, see [Modifying a role trust policy](IAM/latest/UserGuide/roles-managingrole-editing-console.html#roles-managingrole_edit-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.

Returns:

  • (String)

5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
# File 'lib/aws-sdk-cloudformation/types.rb', line 5978

class RegisterTypeInput < Struct.new(
  :type,
  :type_name,
  :schema_handler_package,
  :logging_config,
  :execution_role_arn,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#logging_configTypes::LoggingConfig

Specifies logging configuration information for an extension.


5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
# File 'lib/aws-sdk-cloudformation/types.rb', line 5978

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_packageString

A url to the S3 bucket containing the extension project package that contains the neccessary files for the extension you want to register.

For information on 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 is, 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

Returns:

  • (String)

5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
# File 'lib/aws-sdk-cloudformation/types.rb', line 5978

class RegisterTypeInput < Struct.new(
  :type,
  :type_name,
  :schema_handler_package,
  :logging_config,
  :execution_role_arn,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#typeString

The kind of extension.

Returns:

  • (String)

5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
# File 'lib/aws-sdk-cloudformation/types.rb', line 5978

class RegisterTypeInput < Struct.new(
  :type,
  :type_name,
  :schema_handler_package,
  :logging_config,
  :execution_role_arn,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#type_nameString

The name of the extension being registered.

We recommend that extension names adhere to the following patterns:

  • For resource types, *company_or_organization*::service::type.

  • For modules, *company_or_organization*::service::type::MODULE.

<note markdown=“1”> The following organization namespaces are reserved and cannot be used in your extension names:

* `Alexa`
  • `AMZN`

  • `Amazon`

  • `AWS`

  • `Custom`

  • `Dev`

</note>

Returns:

  • (String)

5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
# File 'lib/aws-sdk-cloudformation/types.rb', line 5978

class RegisterTypeInput < Struct.new(
  :type,
  :type_name,
  :schema_handler_package,
  :logging_config,
  :execution_role_arn,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end