hosted_configuration_versions

Creates, updates, deletes or gets a hosted_configuration_version resource or lists hosted_configuration_versions in a region

Overview

Name	hosted_configuration_versions
Type	Resource
Description	Resource Type definition for AWS::AppConfig::HostedConfigurationVersion
Id	awscc.appconfig.hosted_configuration_versions

Fields

get (all properties)

Name	Datatype	Description
configuration_profile_id	string	The configuration profile ID.
description	string	A description of the hosted configuration version.
content_type	string	A standard MIME type describing the format of the configuration content.
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.
content	string	The content of the configuration or the configuration data.
version_label	string	A user-defined label for an AWS AppConfig hosted configuration version.
application_id	string	The application ID.
version_number	string	Current version number of hosted configuration version.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
configuration_profile_id	string	The configuration profile ID.
application_id	string	The application ID.
version_number	string	Current version number of hosted configuration version.
region	string	AWS region.

For more information, see AWS::AppConfig::HostedConfigurationVersion.

Methods

Name	Resource	Accessible by	Required Params
create_resource	hosted_configuration_versions	INSERT	ApplicationId, ConfigurationProfileId, Content, ContentType, region
delete_resource	hosted_configuration_versions	DELETE	Identifier, region
list_resources	hosted_configuration_versions_list_only	SELECT	region
get_resource	hosted_configuration_versions	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual hosted_configuration_version.

SELECT
  region,
  configuration_profile_id,
  description,
  content_type,
  latest_version_number,
  content,
  version_label,
  application_id,
  version_number
FROM awscc.appconfig.hosted_configuration_versions
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ application_id }}|{{ configuration_profile_id }}|{{ version_number }}';

list (identifiers only)

Lists all hosted_configuration_versions in a region.

SELECT
  region,
  application_id,
  configuration_profile_id,
  version_number
FROM awscc.appconfig.hosted_configuration_versions_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.appconfig.hosted_configuration_versions (
  ConfigurationProfileId,
  ContentType,
  Content,
  ApplicationId,
  region
)
SELECT
  '{{ configuration_profile_id }}',
  '{{ content_type }}',
  '{{ content }}',
  '{{ application_id }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.appconfig.hosted_configuration_versions (
  ConfigurationProfileId,
  Description,
  ContentType,
  LatestVersionNumber,
  Content,
  VersionLabel,
  ApplicationId,
  region
)
SELECT
  '{{ configuration_profile_id }}',
  '{{ description }}',
  '{{ content_type }}',
  '{{ latest_version_number }}',
  '{{ content }}',
  '{{ version_label }}',
  '{{ application_id }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: hosted_configuration_version
  props:
    - name: configuration_profile_id
      value: '{{ configuration_profile_id }}'
    - name: description
      value: '{{ description }}'
    - name: content_type
      value: '{{ content_type }}'
    - name: latest_version_number
      value: '{{ latest_version_number }}'
    - name: content
      value: '{{ content }}'
    - name: version_label
      value: '{{ version_label }}'
    - name: application_id
      value: '{{ application_id }}'

DELETE example

/*+ delete */
DELETE FROM awscc.appconfig.hosted_configuration_versions
WHERE
  Identifier = '{{ application_id }}|{{ configuration_profile_id }}|{{ version_number }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

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

Read

appconfig:GetHostedConfigurationVersion

Create

appconfig:CreateHostedConfigurationVersion

List

appconfig:ListHostedConfigurationVersions

Delete

appconfig:DeleteHostedConfigurationVersion