zonal_autoshift_configurations

Creates, updates, deletes or gets a zonal_autoshift_configuration resource or lists zonal_autoshift_configurations in a region

Overview

Name	zonal_autoshift_configurations
Type	Resource
Description	Definition of AWS::ARCZonalShift::ZonalAutoshiftConfiguration Resource Type
Id	awscc.arczonalshift.zonal_autoshift_configurations

Fields

get (all properties)

Name	Datatype	Description
zonal_autoshift_status	string
▶practice_run_configuration	object
resource_identifier	string
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
resource_identifier	string
region	string	AWS region.

For more information, see AWS::ARCZonalShift::ZonalAutoshiftConfiguration.

Methods

Name	Resource	Accessible by	Required Params
create_resource	zonal_autoshift_configurations	INSERT	region
delete_resource	zonal_autoshift_configurations	DELETE	Identifier, region
update_resource	zonal_autoshift_configurations	UPDATE	Identifier, PatchDocument, region
list_resources	zonal_autoshift_configurations_list_only	SELECT	region
get_resource	zonal_autoshift_configurations	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual zonal_autoshift_configuration.

SELECT
  region,
  zonal_autoshift_status,
  practice_run_configuration,
  resource_identifier
FROM awscc.arczonalshift.zonal_autoshift_configurations
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ resource_identifier }}';

list (identifiers only)

Lists all zonal_autoshift_configurations in a region.

SELECT
  region,
  resource_identifier
FROM awscc.arczonalshift.zonal_autoshift_configurations_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.arczonalshift.zonal_autoshift_configurations (
  ZonalAutoshiftStatus,
  PracticeRunConfiguration,
  ResourceIdentifier,
  region
)
SELECT
  '{{ zonal_autoshift_status }}',
  '{{ practice_run_configuration }}',
  '{{ resource_identifier }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.arczonalshift.zonal_autoshift_configurations (
  ZonalAutoshiftStatus,
  PracticeRunConfiguration,
  ResourceIdentifier,
  region
)
SELECT
  '{{ zonal_autoshift_status }}',
  '{{ practice_run_configuration }}',
  '{{ resource_identifier }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: zonal_autoshift_configuration
    props:
      - name: zonal_autoshift_status
        value: '{{ zonal_autoshift_status }}'
      - name: practice_run_configuration
        value:
          blocking_alarms:
            - type: '{{ type }}'
              alarm_identifier: '{{ alarm_identifier }}'
          outcome_alarms:
            - null
          blocked_dates:
            - '{{ blocked_dates[0] }}'
          blocked_windows:
            - '{{ blocked_windows[0] }}'
      - name: resource_identifier
        value: '{{ resource_identifier }}'

UPDATE example

Use the following StackQL query and manifest file to update a zonal_autoshift_configuration resource, using stack-deploy.

/*+ update */
UPDATE awscc.arczonalshift.zonal_autoshift_configurations
SET PatchDocument = string('{{ {
    "ZonalAutoshiftStatus": zonal_autoshift_status,
    "PracticeRunConfiguration": practice_run_configuration
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ resource_identifier }}';

DELETE example

/*+ delete */
DELETE FROM awscc.arczonalshift.zonal_autoshift_configurations
WHERE
  Identifier = '{{ resource_identifier }}' AND
  region = 'us-east-1';

Permissions

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

Create

arc-zonal-shift:CreatePracticeRunConfiguration,
arc-zonal-shift:GetManagedResource,
arc-zonal-shift:UpdateZonalAutoshiftConfiguration,
cloudwatch:DescribeAlarms,
iam:CreateServiceLinkedRole

Read

arc-zonal-shift:GetManagedResource

Update

arc-zonal-shift:GetManagedResource,
arc-zonal-shift:UpdatePracticeRunConfiguration,
arc-zonal-shift:UpdateZonalAutoshiftConfiguration,
cloudwatch:DescribeAlarms

Delete

arc-zonal-shift:DeletePracticeRunConfiguration,
arc-zonal-shift:GetManagedResource,
arc-zonal-shift:UpdateZonalAutoshiftConfiguration

List

arc-zonal-shift:ListManagedResources