CloudFormation / Client / set_type_configuration

set_type_configuration#

CloudFormation.Client.set_type_configuration(**kwargs)#

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

Request Syntax

response = client.set_type_configuration(
    TypeArn='string',
    Configuration='string',
    ConfigurationAlias='string',
    TypeName='string',
    Type='RESOURCE'|'MODULE'|'HOOK'
)
Parameters:

  • TypeArn (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 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 (string) –

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

  • ConfigurationAlias (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.

  • TypeName (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.

Return type:

dict

Returns:

Response Syntax

{
    'ConfigurationArn': 'string'
}

Response Structure

  • (dict) –

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

Exceptions