Skip to content

Set Type Configuration

cloudformation_set_type_configuration R Documentation

Specifies the configuration data for a registered CloudFormation extension, in the given account and Region

Description

Specifies the configuration data for a registered CloudFormation extension, in the given account and Region.

To view the current configuration data for an extension, refer to the ConfigurationSchema element of describe_type. For more information, see Configuring extensions at the account level in the CloudFormation User Guide.

It's strongly recommended that you use dynamic references to restrict sensitive configuration definitions, such as third-party credentials. For more details on dynamic references, see Using dynamic references to specify template values in the CloudFormation User Guide.

Usage

cloudformation_set_type_configuration(TypeArn, Configuration,
  ConfigurationAlias, TypeName, Type)

Arguments

TypeArn

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 activate_type API operation in this account and Region. For private extensions, this will be the ARN assigned when you call the register_type 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.

Configuration

[required] 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 describe_type. For more information, see Defining account-level configuration data for an extension in the CloudFormation CLI User Guide.

ConfigurationAlias

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.

TypeName

The name of the extension.

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

Type

The type of extension.

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

Value

A list with the following syntax: 

list(
  ConfigurationArn = "string"
)

Request syntax

svc$set_type_configuration(
  TypeArn = "string",
  Configuration = "string",
  ConfigurationAlias = "string",
  TypeName = "string",
  Type = "RESOURCE"|"MODULE"|"HOOK"
)