Skip to content

SetTypeConfigurationInput

Source code in docs_src/capo_cloudformation/types/set_type_configuration_input.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
class SetTypeConfigurationInput(TypedDict, closed=True):
    type_arn: NotRequired["capo_cloudformation.types.type_arn.TypeArn"]
    """<p>The Amazon Resource Name (ARN) for the extension in this account and Region.</p> <p>For public extensions, this will be the ARN assigned when you call the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html">ActivateType</a> API operation in this account and Region. For private extensions, this will be the ARN assigned when you call the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html">RegisterType</a> API operation in this account and Region.</p> <p>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.</p>"""
    configuration: NotRequired[
        "capo_cloudformation.types.type_configuration.TypeConfiguration"
    ]
    """<p>The configuration data for the extension in this account and Region.</p> <p>The configuration data must be formatted as JSON and validate against the extension's schema returned in the <code>Schema</code> response element of <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html">DescribeType</a>.</p>"""
    configuration_alias: NotRequired[
        "capo_cloudformation.types.type_configuration_alias.TypeConfigurationAlias"
    ]
    """<p>An alias by which to refer to this extension configuration data.</p> <p>Conditional: Specifying a configuration alias is required when setting a configuration for a resource type extension.</p>"""
    type_name: NotRequired["capo_cloudformation.types.type_name.TypeName"]
    """<p>The name of the extension.</p> <p>Conditional: You must specify <code>ConfigurationArn</code>, or <code>Type</code> and <code>TypeName</code>.</p>"""
    type: NotRequired["capo_cloudformation.types.third_party_type.ThirdPartyType"]
    """<p>The type of extension.</p> <p>Conditional: You must specify <code>ConfigurationArn</code>, or <code>Type</code> and <code>TypeName</code>.</p>"""

configuration instance-attribute 

configuration: NotRequired[TypeConfiguration]

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: NotRequired[TypeConfigurationAlias]

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: NotRequired[ThirdPartyType]

The type of extension.

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

type_arn instance-attribute 

type_arn: NotRequired[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 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: NotRequired[TypeName]

The name of the extension.

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