policies

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

Overview

Name	policies
Type	Resource
Id	aws.resiliencehubv2.policies

Fields

The following fields are returned by SELECT queries:

get_policy

Name	Datatype	Description
name	string	Resource name (used in ARN — no spaces allowed). (pattern: <code>[A-Za-z0-9][A-Za-z0-9_-]{1,59}</code>)
associated_service_count	integer	The number of services associated with this policy.
availability_slo	object	Defines the availability service level objective (SLO) for a resilience policy.
created_at	string (date-time)	The timestamp when the policy was created.
data_recovery	object	Defines data recovery targets for a resilience policy.
description	string	Resource description for services and policies.
kms_key_id	string	KMS key identifier — accepts key ID, key ARN, alias name, or alias ARN.
multi_az	object	Defines the multi-AZ disaster recovery targets for a resilience policy.
multi_region	object	Defines the multi-Region disaster recovery targets for a resilience policy.
policy_arn	string	ARN identifier. (pattern: <code>arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+.-]{0,1023}</code>)
tags	object
updated_at	string (date-time)	The timestamp when the policy was last updated.

list_policies

Name	Datatype	Description
name	string	Resource name (used in ARN — no spaces allowed). (pattern: <code>[A-Za-z0-9][A-Za-z0-9_-]{1,59}</code>)
associated_service_count	integer	The number of services associated with this policy.
availability_slo	object	Defines the availability service level objective (SLO) for a resilience policy.
created_at	string (date-time)	The timestamp when the policy was created.
data_recovery	object	Defines data recovery targets for a resilience policy.
multi_az	object	Defines the multi-AZ disaster recovery targets for a resilience policy.
multi_region	object	Defines the multi-Region disaster recovery targets for a resilience policy.
policy_arn	string	ARN identifier. (pattern: <code>arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+.-]{0,1023}</code>)
updated_at	string (date-time)	The timestamp when the policy was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_policy	select	policyArn, region		Retrieves a resilience policy by ARN.
list_policies	select	region	maxResults, nextToken	Lists resilience policies.
create_policy	insert	region, name		Creates a resilience policy that defines availability and disaster recovery requirements.
update_policy	update	region, policyArn		Updates an existing resilience policy.
delete_policy	delete	region		Deletes a resilience policy.

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
policyArn	string
region	string	AWS region (default: us-east-1)
maxResults	integer
nextToken	string

SELECT examples

get_policy

Retrieves a resilience policy by ARN.

SELECT
name,
associated_service_count,
availability_slo,
created_at,
data_recovery,
description,
kms_key_id,
multi_az,
multi_region,
policy_arn,
tags,
updated_at
FROM aws.resiliencehubv2.policies
WHERE policyArn = '{{ policyArn }}' -- required
AND region = '{{ region }}' -- required
;

list_policies

Lists resilience policies.

SELECT
name,
associated_service_count,
availability_slo,
created_at,
data_recovery,
multi_az,
multi_region,
policy_arn,
updated_at
FROM aws.resiliencehubv2.policies
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_policy

Creates a resilience policy that defines availability and disaster recovery requirements.

INSERT INTO aws.resiliencehubv2.policies (
name,
description,
availabilitySlo,
multiAz,
multiRegion,
dataRecovery,
kmsKeyId,
tags,
clientToken,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ description }}',
'{{ availabilitySlo }}',
'{{ multiAz }}',
'{{ multiRegion }}',
'{{ dataRecovery }}',
'{{ kmsKeyId }}',
'{{ tags }}',
'{{ clientToken }}',
'{{ region }}'
RETURNING
policy
;

Manifest

# Description fields are for documentation purposes
- name: policies
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the policies resource.
  - name: name
    value: "{{ name }}"
    description: |
      Resource name (used in ARN — no spaces allowed).
  - name: description
    value: "{{ description }}"
    description: |
      Resource description for services and policies.
  - name: availabilitySlo
    description: |
      Defines the availability service level objective (SLO) for a resilience policy.
    value:
      target: {{ target }}
  - name: multiAz
    description: |
      Defines the multi-AZ disaster recovery targets for a resilience policy.
    value:
      rtoInMinutes: {{ rtoInMinutes }}
      rpoInMinutes: {{ rpoInMinutes }}
      disasterRecoveryApproach: "{{ disasterRecoveryApproach }}"
  - name: multiRegion
    description: |
      Defines the multi-Region disaster recovery targets for a resilience policy.
    value:
      rtoInMinutes: {{ rtoInMinutes }}
      rpoInMinutes: {{ rpoInMinutes }}
      disasterRecoveryApproach: "{{ disasterRecoveryApproach }}"
  - name: dataRecovery
    description: |
      Defines data recovery targets for a resilience policy.
    value:
      timeBetweenBackupsInMinutes: {{ timeBetweenBackupsInMinutes }}
  - name: kmsKeyId
    value: "{{ kmsKeyId }}"
    description: |
      KMS key identifier — accepts key ID, key ARN, alias name, or alias ARN.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: clientToken
    value: "{{ clientToken }}"
    description: |
      Idempotency token.

UPDATE examples

update_policy

Updates an existing resilience policy.

UPDATE aws.resiliencehubv2.policies
SET 
policyArn = '{{ policyArn }}',
description = '{{ description }}',
availabilitySlo = '{{ availabilitySlo }}',
multiAz = '{{ multiAz }}',
multiRegion = '{{ multiRegion }}',
dataRecovery = '{{ dataRecovery }}'
WHERE 
region = '{{ region }}' --required
AND policyArn = '{{ policyArn }}' --required
RETURNING
policy;

DELETE examples

delete_policy

Deletes a resilience policy.

DELETE FROM aws.resiliencehubv2.policies
WHERE region = '{{ region }}' --required
;