configuration_profile
Gets an individual configuration_profile
resource
Overview
Name | configuration_profile |
Type | Resource |
Description | configuration_profile |
Id | awscc.appconfig.configuration_profile |
Fields
Name | Datatype | Description |
---|---|---|
location_uri | string | A URI to locate the configuration. You can specify the AWS AppConfig hosted configuration store, Systems Manager (SSM) document, an SSM Parameter Store parameter, or an Amazon S3 object. |
type | string | The type of configurations contained in the profile. When calling this API, enter one of the following values for Type: AWS.AppConfig.FeatureFlags, AWS.Freeform |
description | string | A description of the configuration profile. |
validators | array | A list of methods for validating the configuration. |
retrieval_role_arn | string | The ARN of an IAM role with permission to access the configuration at the specified LocationUri. |
configuration_profile_id | string | The configuration profile ID |
application_id | string | The application ID. |
tags | array | Metadata to assign to the configuration profile. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define. |
name | string | A name for the configuration profile. |
kms_key_identifier | string | The AWS Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated. |
kms_key_arn | string | The Amazon Resource Name of the AWS Key Management Service key to encrypt new configuration data versions in the AWS 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 AWS KMS key for that particular service. |
region | string | AWS region. |
Methods
Currently only SELECT
is supported for this resource resource.
Example
SELECT
region,
location_uri,
type,
description,
validators,
retrieval_role_arn,
configuration_profile_id,
application_id,
tags,
name,
kms_key_identifier,
kms_key_arn
FROM awscc.appconfig.configuration_profile
WHERE data__Identifier = '<ApplicationId>|<ConfigurationProfileId>';
Permissions
To operate on the configuration_profile
resource, the following permissions are required:
Read
appconfig:GetConfigurationProfile,
appconfig:ListTagsForResource
Update
appconfig:UpdateConfigurationProfile,
appconfig:TagResource,
appconfig:UntagResource,
iam:PassRole
Delete
appconfig:DeleteConfigurationProfile