[ aws . cloudformation ]

set-type-configuration

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 DescribeType . For more information, see Configuring extensions at the account level in the CloudFormation User Guide .

Warning

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 .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  set-type-configuration
[--type-arn <value>]
--configuration <value>
[--configuration-alias <value>]
[--type-name <value>]
[--type <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--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 activate the type 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.

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

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

--type-name (string)

The name of the extension.

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

--type (string)

The type of extension.

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

Possible values:

• RESOURCE

• MODULE

• HOOK

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

To configure data

The following set-type-configuration example specifies the configuration data for a registered CloudFormation extension, in the given account and Region.

aws cloudformation set-type-configuration \
    --region us-west-2 \
    --type RESOURCE \
    --type-name Example::Test::Type \
    --configuration-alias default \
    --configuration "{\"CredentialKey\": \"testUserCredential\"}"

Output:

{
    "ConfigurationArn": "arn:aws:cloudformation:us-west-2:123456789012:type-configuration/resource/Example-Test-Type/default"
}

For more information, see Using the AWS CloudFormation registry in the AWS CloudFormation User Guide.

Output

ConfigurationArn -> (string)

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

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