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

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 SetTypeConfigurationInput data as a hash:

{
  type_arn: "TypeArn",
  configuration: "TypeConfiguration", # required
  configuration_alias: "TypeConfigurationAlias",
  type_name: "TypeName",
  type: "RESOURCE", # accepts RESOURCE, MODULE
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#configurationString

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 [API_DescribeType](AWSCloudFormation/latest/APIReference/API_DescribeType.html). For more information, see [Defining account-level configuration data for an extension] in the *CloudFormation CLI User Guide*.

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

Returns:

  • (String)

6614
6615
6616
6617
6618
6619
6620
6621
6622
# File 'lib/aws-sdk-cloudformation/types.rb', line 6614

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

#configuration_aliasString

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)

6614
6615
6616
6617
6618
6619
6620
6621
6622
# File 'lib/aws-sdk-cloudformation/types.rb', line 6614

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

#typeString

The type of extension.

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

Returns:

  • (String)

6614
6615
6616
6617
6618
6619
6620
6621
6622
# File 'lib/aws-sdk-cloudformation/types.rb', line 6614

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

#type_arnString

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

For public extensions, this will be the ARN assigned when you

activate the type][1

in this account and region. For private

extensions, this will be the ARN assigned when you [register the type] 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)

6614
6615
6616
6617
6618
6619
6620
6621
6622
# File 'lib/aws-sdk-cloudformation/types.rb', line 6614

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

#type_nameString

The name of the extension.

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

Returns:

  • (String)

6614
6615
6616
6617
6618
6619
6620
6621
6622
# File 'lib/aws-sdk-cloudformation/types.rb', line 6614

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