hosted_configuration_versions

Creates, updates, deletes, gets or lists a hosted_configuration_versions resource.

Overview

Name	hosted_configuration_versions
Type	Resource
Id	aws.appconfig.hosted_configuration_versions

Fields

The following fields are returned by SELECT queries:

get_hosted_configuration_version

Name	Datatype	Description
application_id	string	The application ID. (pattern: <code>[a-z0-9]{4,7}</code>)
configuration_profile_id	string	The configuration profile ID. (pattern: <code>[a-z0-9]{4,7}</code>)
content	string (byte)	The content of the configuration or the configuration data.
content_type	string	A standard MIME type describing the format of the configuration content. For more information, see Content-Type.
description	string	A description of the configuration.
kms_key_arn	string	The Amazon Resource Name of the Key Management Service key that was used to encrypt this specific version of the configuration data in the AppConfig hosted configuration store. (pattern: <code>arn:(aws[a-zA-Z-]*)?:[a-z]+:((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+</code>)
version_label	string	A user-defined label for an AppConfig hosted configuration version. (pattern: <code>.[^0-9].</code>)
version_number	integer	The configuration version.

list_hosted_configuration_versions

Name	Datatype	Description
application_id	string	The application ID. (pattern: <code>[a-z0-9]{4,7}</code>)
configuration_profile_id	string	The configuration profile ID. (pattern: <code>[a-z0-9]{4,7}</code>)
content_type	string	A standard MIME type describing the format of the configuration content. For more information, see Content-Type.
description	string	A description of the configuration.
kms_key_arn	string	The Amazon Resource Name of the Key Management Service key that was used to encrypt this specific version of the configuration data in the AppConfig hosted configuration store. (pattern: <code>arn:(aws[a-zA-Z-]*)?:[a-z]+:((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+</code>)
version_label	string	A user-defined label for an AppConfig hosted configuration version. (pattern: <code>.[^0-9].</code>)
version_number	integer	The configuration version.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_hosted_configuration_version	select	application_id, configuration_profile_id, version_number, region		Retrieves information about a specific configuration version.
list_hosted_configuration_versions	select	application_id, configuration_profile_id, region	max_results, next_token, version_label	Lists configurations stored in the AppConfig hosted configuration store by version.
create_hosted_configuration_version	insert	application_id, configuration_profile_id, Content-Type, region	Description, Latest-Version-Number, VersionLabel	Creates a new configuration in the AppConfig hosted configuration store. If you're creating a feature flag, we recommend you familiarize yourself with the JSON schema for feature flag data. For more information, see Type reference for AWS.AppConfig.FeatureFlags in the AppConfig User Guide.
delete_hosted_configuration_version	delete	application_id, configuration_profile_id, version_number, region		Deletes a version of a configuration from the AppConfig hosted configuration store.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
Content-Type	string	A standard MIME type describing the format of the configuration content. For more information, see Content-Type.
application_id	string	The application ID.
configuration_profile_id	string	The configuration profile ID.
region	string	AWS region (default: us-east-1)
version_number	integer	The versions number to delete.
Description	string	A description of the configuration. Due to HTTP limitations, this field only supports ASCII characters.
Latest-Version-Number	integer	An optional locking token used to prevent race conditions from overwriting configuration updates when creating a new version. To ensure your data is not overwritten when creating multiple hosted configuration versions in rapid succession, specify the version number of the latest hosted configuration version.
VersionLabel	string	An optional, user-defined label for the AppConfig hosted configuration version. This value must contain at least one non-numeric character. For example, "v2.2.0".
max_results	integer	The maximum number of items to return for this call. If MaxResults is not provided in the call, AppConfig returns the maximum of 50. The call also returns a token that you can specify in a subsequent call to get the next set of results.
next_token	string	A token to start the list. Use this token to get the next set of results.
version_label	string	An optional filter that can be used to specify the version label of an AppConfig hosted configuration version. This parameter supports filtering by prefix using a wildcard, for example "v2*". If you don't specify an asterisk at the end of the value, only an exact match is returned.

SELECT examples

get_hosted_configuration_version

Retrieves information about a specific configuration version.

SELECT
application_id,
configuration_profile_id,
content,
content_type,
description,
kms_key_arn,
version_label,
version_number
FROM aws.appconfig.hosted_configuration_versions
WHERE application_id = '{{ application_id }}' -- required
AND configuration_profile_id = '{{ configuration_profile_id }}' -- required
AND version_number = '{{ version_number }}' -- required
AND region = '{{ region }}' -- required
;

list_hosted_configuration_versions

Lists configurations stored in the AppConfig hosted configuration store by version.

SELECT
application_id,
configuration_profile_id,
content_type,
description,
kms_key_arn,
version_label,
version_number
FROM aws.appconfig.hosted_configuration_versions
WHERE application_id = '{{ application_id }}' -- required
AND configuration_profile_id = '{{ configuration_profile_id }}' -- required
AND region = '{{ region }}' -- required
AND max_results = '{{ max_results }}'
AND next_token = '{{ next_token }}'
AND version_label = '{{ version_label }}'
;

INSERT examples

create_hosted_configuration_version

Creates a new configuration in the AppConfig hosted configuration store. If you're creating a feature flag, we recommend you familiarize yourself with the JSON schema for feature flag data. For more information, see Type reference for AWS.AppConfig.FeatureFlags in the AppConfig User Guide.

INSERT INTO aws.appconfig.hosted_configuration_versions (
Content,
application_id,
configuration_profile_id,
`Content-Type`,
region,
Description,
`Latest-Version-Number`,
VersionLabel
)
SELECT 
'{{ Content }}',
'{{ application_id }}',
'{{ configuration_profile_id }}',
'{{ Content-Type }}',
'{{ region }}',
'{{ Description }}',
'{{ Latest-Version-Number }}',
'{{ VersionLabel }}'
RETURNING
application_id,
configuration_profile_id,
content,
content_type,
description,
kms_key_arn,
version_label,
version_number
;

Manifest

# Description fields are for documentation purposes
- name: hosted_configuration_versions
props:
  - name: application_id
    value: "{{ application_id }}"
    description: Required parameter for the hosted_configuration_versions resource.
  - name: configuration_profile_id
    value: "{{ configuration_profile_id }}"
    description: Required parameter for the hosted_configuration_versions resource.
  - name: Content-Type
    value: "{{ Content-Type }}"
    description: Required parameter for the hosted_configuration_versions resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the hosted_configuration_versions resource.
  - name: Content
    value: "{{ Content }}"
  - name: Description
    value: "{{ Description }}"
    description: A description of the configuration. Due to HTTP limitations, this field only supports ASCII characters.
    description: A description of the configuration. Due to HTTP limitations, this field only supports ASCII characters.
  - name: Latest-Version-Number
    value: {{ Latest-Version-Number }}
    description: An optional locking token used to prevent race conditions from overwriting configuration updates when creating a new version. To ensure your data is not overwritten when creating multiple hosted configuration versions in rapid succession, specify the version number of the latest hosted configuration version.
    description: An optional locking token used to prevent race conditions from overwriting configuration updates when creating a new version. To ensure your data is not overwritten when creating multiple hosted configuration versions in rapid succession, specify the version number of the latest hosted configuration version.
  - name: VersionLabel
    value: "{{ VersionLabel }}"
    description: An optional, user-defined label for the AppConfig hosted configuration version. This value must contain at least one non-numeric character. For example, "v2.2.0".
    description: An optional, user-defined label for the AppConfig hosted configuration version. This value must contain at least one non-numeric character. For example, "v2.2.0".

DELETE examples

delete_hosted_configuration_version

Deletes a version of a configuration from the AppConfig hosted configuration store.

DELETE FROM aws.appconfig.hosted_configuration_versions
WHERE application_id = '{{ application_id }}' --required
AND configuration_profile_id = '{{ configuration_profile_id }}' --required
AND version_number = '{{ version_number }}' --required
AND region = '{{ region }}' --required
;