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

Returns:

  • (String)


4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 4713

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 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.

Returns:

  • (String)


4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 4713

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 a type.



4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 4713

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 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.

As part of registering a resource provider type, CloudFormation must be able to access the S3 bucket which contains the schema handler package for that resource provider. For more information, see IAM Permissions for Registering a Resource Provider in the AWS CloudFormation User Guide.

Returns:

  • (String)


4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 4713

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 type.

Currently, the only valid value is RESOURCE.

Returns:

  • (String)


4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 4713

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 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

Returns:

  • (String)


4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 4713

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