Class: Aws::CloudFormation::Types::SetTypeConfigurationInput

Inherits:

Struct

• Object
• Struct
• Aws::CloudFormation::Types::SetTypeConfigurationInput

Includes:

Structure

Defined in:

lib/aws-sdk-cloudformation/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #configuration ⇒ String

  The configuration data for the extension, in this account and Region.

• #configuration_alias ⇒ String

  An alias by which to refer to this extension configuration data.

• #type ⇒ String

  The type of extension.

• #type_arn ⇒ String

  The Amazon Resource Name (ARN) for the extension, in this account and Region.

• #type_name ⇒ String

  The name of the extension.

Instance Attribute Details

#configuration ⇒ String

The configuration data for the extension, in this account and Region.

The configuration data must be formatted as JSON, and validate against the schema returned in the ‘ConfigurationSchema` response element of [DescribeType]. For more information, see [Defining the account-level configuration of an extension] in the *CloudFormation Command Line Interface (CLI) User Guide*.

[1]: docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html [2]: docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-model.html#resource-type-howto-configuration

Returns:

• (String)

# File 'lib/aws-sdk-cloudformation/types.rb', line 7779

class SetTypeConfigurationInput < Struct.new(
  :type_arn,
  :configuration,
  :configuration_alias,
  :type_name,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#configuration_alias ⇒ String

An alias by which to refer to this extension configuration data.

Conditional: Specifying a configuration alias is required when setting a configuration for a resource type extension.

Returns:

• (String)

# File 'lib/aws-sdk-cloudformation/types.rb', line 7779

class SetTypeConfigurationInput < Struct.new(
  :type_arn,
  :configuration,
  :configuration_alias,
  :type_name,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The type of extension.

Conditional: You must specify ‘ConfigurationArn`, or `Type` and `TypeName`.

Returns:

• (String)

# File 'lib/aws-sdk-cloudformation/types.rb', line 7779

class SetTypeConfigurationInput < Struct.new(
  :type_arn,
  :configuration,
  :configuration_alias,
  :type_name,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#type_arn ⇒ String

The Amazon Resource Name (ARN) for the extension, in this account and Region.

For public extensions, this will be the ARN assigned when you call the [ActivateType] API operation in this account and Region. For private extensions, this will be the ARN assigned when you call the

RegisterType][2

API operation in this account and Region.

Do not include the extension versions suffix at the end of the ARN. You can set the configuration for an extension, but not for a specific extension version.

[1]: docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html [2]: docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html

Returns:

• (String)

# File 'lib/aws-sdk-cloudformation/types.rb', line 7779

class SetTypeConfigurationInput < Struct.new(
  :type_arn,
  :configuration,
  :configuration_alias,
  :type_name,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#type_name ⇒ String

The name of the extension.

Conditional: You must specify ‘ConfigurationArn`, or `Type` and `TypeName`.

Returns:

• (String)

# File 'lib/aws-sdk-cloudformation/types.rb', line 7779

class SetTypeConfigurationInput < Struct.new(
  :type_arn,
  :configuration,
  :configuration_alias,
  :type_name,
  :type)
  SENSITIVE = []
  include Aws::Structure
end