AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cloudformation/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)


5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 5142

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. If your extension 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 extension handler, CloudFormation assumes this execution role to create a temporary session token, which it then passes to the extension handler, thereby supplying your extension with the appropriate credentials.

Returns:

  • (String)


5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 5142

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.



5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 5142

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.

The user registering the extension must be able to access the 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.

Returns:

  • (String)


5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 5142

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)


5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 5142

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 pattern: company_or_organization::service::type.

The following organization namespaces are reserved and cannot be used in your extension names:

  • Alexa

  • AMZN

  • Amazon

  • AWS

  • Custom

  • Dev

Returns:

  • (String)


5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 5142

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