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
  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",
}

See Also:

Instance Attribute Summary collapse

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

Returns:

  • (String) 


4328
4329
4330
4331
4332
4333
4334
4335
4336
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 4328

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

#execution_role_arn ⇒ String

The Amazon Resource Name (ARN) of the IAM execution role to use to register the type. If your resource type calls AWS 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 AWS APIs, and provision that execution role in your account. CloudFormation then assumes that execution role to provide your resource type with the appropriate credentials.

Returns:

  • (String) 


4328
4329
4330
4331
4332
4333
4334
4335
4336
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 4328

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

#logging_config ⇒ Types::LoggingConfig

Specifies logging configuration information for a type.

Returns:



4328
4329
4330
4331
4332
4333
4334
4335
4336
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 4328

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

#schema_handler_package ⇒ String

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

[1]: docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-cli-submit.html

Returns:

  • (String) 


4328
4329
4330
4331
4332
4333
4334
4335
4336
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 4328

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

#type ⇒ String

The kind of type.

Currently, the only valid value is ‘RESOURCE`.

Returns:

  • (String) 


4328
4329
4330
4331
4332
4333
4334
4335
4336
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 4328

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

#type_name ⇒ String

The name of the type being registered.

We recommend that type names adhere to the following pattern: company_or_organization::service::type.

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

* `Alexa`

  • ‘AMZN`

  • ‘Amazon`

  • ‘AWS`

  • ‘Custom`

  • ‘Dev`

</note>

Returns:

  • (String) 


4328
4329
4330
4331
4332
4333
4334
4335
4336
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 4328

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