SetTypeConfiguration

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 AWS CloudFormation Command Line Interface (CLI) User Guide.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 204800.

Pattern: [\s\S]+

Required: Yes

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: ^[a-zA-Z0-9]{1,256}$

Required: No

The type of extension.

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

Type: String

Valid Values: RESOURCE | MODULE | HOOK

Required: No

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

Type: String

Length Constraints: Maximum length of 1024.

Pattern: arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/.+

Required: No

The name of the extension.

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

Type: String

Length Constraints: Minimum length of 10. Maximum length of 204.

Pattern: [A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}(::MODULE){0,1}

Required: No

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

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

Type: String

Length Constraints: Maximum length of 1024.

Pattern: arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type-configuration/.+

An error occurred during a CloudFormation registry operation.

HTTP Status Code: 400

The specified extension doesn't exist in the CloudFormation registry.

HTTP Status Code: 404