Skip to content

ConfigurationProfile

Source code in docs_src/capo_appconfig/types/configuration_profile.py
class ConfigurationProfile(TypedDict, closed=True):
    application_id: NotRequired["capo_appconfig.types.id.Id"]
    """<p>The application ID.</p>"""
    id: NotRequired["capo_appconfig.types.id.Id"]
    """<p>The configuration profile ID.</p>"""
    name: NotRequired["capo_appconfig.types.long_name.LongName"]
    """<p>The name of the configuration profile.</p>"""
    description: NotRequired["capo_appconfig.types.description.Description"]
    """<p>The configuration profile description.</p>"""
    location_uri: NotRequired["capo_appconfig.types.uri.Uri"]
    """<p>The URI location of the configuration.</p>"""
    retrieval_role_arn: NotRequired["capo_appconfig.types.role_arn.RoleArn"]
    """<p>The ARN of an IAM role with permission to access the configuration at the specified <code>LocationUri</code>.</p>"""
    validators: NotRequired["capo_appconfig.types.validator_list.ValidatorList"]
    """<p>A list of methods for validating the configuration.</p>"""
    type: NotRequired[
        "capo_appconfig.types.configuration_profile_type.ConfigurationProfileType"
    ]
    """<p>The type of configurations contained in the profile. AppConfig supports <code>feature flags</code> and <code>freeform</code> configurations. We recommend you create feature flag configurations to enable or disable new features and freeform configurations to distribute configurations to an application. When calling this API, enter one of the following values for <code>Type</code>:</p> <p> <code>AWS.AppConfig.FeatureFlags</code> </p> <p> <code>AWS.Freeform</code> </p>"""
    kms_key_arn: NotRequired["capo_appconfig.types.arn.Arn"]
    """<p>The Amazon Resource Name of the Key Management Service key to encrypt new configuration data versions in the AppConfig hosted configuration store. This attribute is only used for <code>hosted</code> configuration types. To encrypt data managed in other configuration stores, see the documentation for how to specify an KMS key for that particular service.</p>"""
    kms_key_identifier: NotRequired[
        "capo_appconfig.types.kms_key_identifier.KmsKeyIdentifier"
    ]
    """<p>The Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.</p>"""

application_id instance-attribute

application_id: NotRequired[Id]

The application ID.

description instance-attribute

description: NotRequired[Description]

The configuration profile description.

id instance-attribute

id: NotRequired[Id]

The configuration profile ID.

kms_key_arn instance-attribute

kms_key_arn: NotRequired[Arn]

The Amazon Resource Name of the Key Management Service key to encrypt new configuration data versions in the AppConfig hosted configuration store. This attribute is only used for hosted configuration types. To encrypt data managed in other configuration stores, see the documentation for how to specify an KMS key for that particular service.

kms_key_identifier instance-attribute

kms_key_identifier: NotRequired[KmsKeyIdentifier]

The Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.

location_uri instance-attribute

location_uri: NotRequired[Uri]

The URI location of the configuration.

name instance-attribute

name: NotRequired[LongName]

The name of the configuration profile.

retrieval_role_arn instance-attribute

retrieval_role_arn: NotRequired[RoleArn]

The ARN of an IAM role with permission to access the configuration at the specified LocationUri.

type instance-attribute

type: NotRequired[ConfigurationProfileType]

The type of configurations contained in the profile. AppConfig supports feature flags and freeform configurations. We recommend you create feature flag configurations to enable or disable new features and freeform configurations to distribute configurations to an application. When calling this API, enter one of the following values for Type:

AWS.AppConfig.FeatureFlags

AWS.Freeform

validators instance-attribute

validators: NotRequired[ValidatorList]

A list of methods for validating the configuration.