You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing RegisterTypeInput as input to an Aws::Client method, you can use a vanilla 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) —

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

    The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the resource provider.

#logging_config ⇒ Types::LoggingConfig

Specifies logging configuration information for a type.

Returns:

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

The user registering the resource provider type must be able to access the the schema handler 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) —

    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.

#type ⇒ String

The kind of type.

Currently, the only valid value is RESOURCE.

Possible values:

  • RESOURCE

Returns:

  • (String) —

    The kind of type.

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

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

  • Alexa

  • AMZN

  • Amazon

  • AWS

  • Custom

  • Dev

Returns:

  • (String) —

    The name of the type being registered.