Skip to content

set_type_configuration

Operation

set_type_configuration

set_type_configuration(request: SetTypeConfigurationInput | SetTypeConfigurationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[SetTypeConfigurationInputDict]) -> SetTypeConfigurationOutput

Specifies the configuration data for a CloudFormation extension, such as a resource or Hook, in the given account and Region.

For more information, see Edit configuration data for extensions in your account in the CloudFormation User Guide.

To view the current configuration data for an extension, refer to the ConfigurationSchema element of DescribeType.

Warning

It's strongly recommended that you use dynamic references to restrict sensitive configuration definitions, such as third-party credentials. For more information, see Specify values stored in other services using dynamic references in the CloudFormation User Guide.

For more information about setting the configuration data for resource types, see Defining the account-level configuration of an extension in the CloudFormation Command Line Interface (CLI) User Guide. For more information about setting the configuration data for Hooks, see the CloudFormation Hooks User Guide.

Parameters:

Name Type Description Default
request SetTypeConfigurationInput | SetTypeConfigurationInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[SetTypeConfigurationInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
SetTypeConfigurationOutput

An instance of SetTypeConfigurationOutput.

set_type_configuration async

set_type_configuration(request: SetTypeConfigurationInput | SetTypeConfigurationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[SetTypeConfigurationInputDict]) -> SetTypeConfigurationOutput

Specifies the configuration data for a CloudFormation extension, such as a resource or Hook, in the given account and Region.

For more information, see Edit configuration data for extensions in your account in the CloudFormation User Guide.

To view the current configuration data for an extension, refer to the ConfigurationSchema element of DescribeType.

Warning

It's strongly recommended that you use dynamic references to restrict sensitive configuration definitions, such as third-party credentials. For more information, see Specify values stored in other services using dynamic references in the CloudFormation User Guide.

For more information about setting the configuration data for resource types, see Defining the account-level configuration of an extension in the CloudFormation Command Line Interface (CLI) User Guide. For more information about setting the configuration data for Hooks, see the CloudFormation Hooks User Guide.

Parameters:

Name Type Description Default
request SetTypeConfigurationInput | SetTypeConfigurationInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[SetTypeConfigurationInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
SetTypeConfigurationOutput

An instance of SetTypeConfigurationOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

SetTypeConfigurationInputDict

Bases: TypedDict

Dictionary form of SetTypeConfigurationInput.

Attributes

configuration instance-attribute
configuration: Required[str]

The configuration data for the extension in this account and Region.

The configuration data must be formatted as JSON and validate against the extension's schema returned in the Schema response element of DescribeType.

configuration_alias instance-attribute
configuration_alias: str | None

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 instance-attribute
type: str | None

The type of extension.

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

type_arn instance-attribute
type_arn: str | None

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_name instance-attribute
type_name: str | None

The name of the extension.

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

SetTypeConfigurationInput dataclass

Bases: _SerdeShape

Dataclass for SetTypeConfigurationInput structure.

Attributes

configuration class-attribute instance-attribute
configuration: str | None = ...

The configuration data for the extension in this account and Region.

The configuration data must be formatted as JSON and validate against the extension's schema returned in the Schema response element of DescribeType.

configuration_alias class-attribute instance-attribute
configuration_alias: str | None = ...

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 class-attribute instance-attribute
type: str | None = ...

The type of extension.

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

type_arn class-attribute instance-attribute
type_arn: str | None = ...

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_name class-attribute instance-attribute
type_name: str | None = ...

The name of the extension.

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

Output

SetTypeConfigurationOutput dataclass

Bases: _SerdeShape

Dataclass for SetTypeConfigurationOutput structure.

Attributes

configuration_arn class-attribute instance-attribute
configuration_arn: str | None = ...

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

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

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.