configuration_profiles

Creates, updates, deletes or gets a configuration_profile resource or lists configuration_profiles in a region

Overview

Name	configuration_profiles
Type	Resource
Description	An example resource schema demonstrating some basic constructs and validation rules.
Id	aws.appconfig.configuration_profiles

Fields

Name	Datatype	Description
configuration_profile_id	string	The configuration profile ID
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
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.
description	string	A description of the configuration profile.
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.
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.
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.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	LocationUri, ApplicationId, Name, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all configuration_profiles in a region.

SELECT
region,
configuration_profile_id,
location_uri,
type,
kms_key_identifier,
description,
kms_key_arn,
validators,
retrieval_role_arn,
application_id,
tags,
name
FROM aws.appconfig.configuration_profiles
WHERE region = 'us-east-1';

Gets all properties from an individual configuration_profile.

SELECT
region,
configuration_profile_id,
location_uri,
type,
kms_key_identifier,
description,
kms_key_arn,
validators,
retrieval_role_arn,
application_id,
tags,
name
FROM aws.appconfig.configuration_profiles
WHERE region = 'us-east-1' AND data__Identifier = '<ApplicationId>|<ConfigurationProfileId>';

INSERT example

Use the following StackQL query and manifest file to create a new configuration_profile resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.appconfig.configuration_profiles (
 LocationUri,
 ApplicationId,
 Name,
 region
)
SELECT 
'{{ LocationUri }}',
 '{{ ApplicationId }}',
 '{{ Name }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.appconfig.configuration_profiles (
 LocationUri,
 Type,
 KmsKeyIdentifier,
 Description,
 Validators,
 RetrievalRoleArn,
 ApplicationId,
 Tags,
 Name,
 region
)
SELECT 
 '{{ LocationUri }}',
 '{{ Type }}',
 '{{ KmsKeyIdentifier }}',
 '{{ Description }}',
 '{{ Validators }}',
 '{{ RetrievalRoleArn }}',
 '{{ ApplicationId }}',
 '{{ Tags }}',
 '{{ Name }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: configuration_profile
    props:
      - name: LocationUri
        value: '{{ LocationUri }}'
      - name: Type
        value: '{{ Type }}'
      - name: KmsKeyIdentifier
        value: '{{ KmsKeyIdentifier }}'
      - name: Description
        value: '{{ Description }}'
      - name: Validators
        value:
          - Type: '{{ Type }}'
            Content: '{{ Content }}'
      - name: RetrievalRoleArn
        value: '{{ RetrievalRoleArn }}'
      - name: ApplicationId
        value: '{{ ApplicationId }}'
      - name: Tags
        value:
          - Value: '{{ Value }}'
            Key: '{{ Key }}'
      - name: Name
        value: '{{ Name }}'

DELETE example

/*+ delete */
DELETE FROM aws.appconfig.configuration_profiles
WHERE data__Identifier = '<ApplicationId|ConfigurationProfileId>'
AND region = 'us-east-1';

Permissions

To operate on the configuration_profiles resource, the following permissions are required:

Read

appconfig:GetConfigurationProfile,
appconfig:ListTagsForResource

Create

appconfig:CreateConfigurationProfile,
appconfig:GetConfigurationProfile,
appconfig:TagResource,
appconfig:ListTagsForResource,
iam:PassRole

Update

appconfig:UpdateConfigurationProfile,
appconfig:TagResource,
appconfig:UntagResource,
iam:PassRole

List

appconfig:ListConfigurationProfiles

Delete

appconfig:DeleteConfigurationProfile