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	aws.arczonalshift.zonal_autoshift_configurations

Fields

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

Methods

Name	Accessible by	Required Params
create_resource	INSERT	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 zonal_autoshift_configurations in a region.

SELECT
region,
zonal_autoshift_status,
practice_run_configuration,
resource_identifier
FROM aws.arczonalshift.zonal_autoshift_configurations
WHERE region = 'us-east-1';

Gets all properties from an individual zonal_autoshift_configuration.

SELECT
region,
zonal_autoshift_status,
practice_run_configuration,
resource_identifier
FROM aws.arczonalshift.zonal_autoshift_configurations
WHERE region = 'us-east-1' AND data__Identifier = '<ResourceIdentifier>';

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 aws.arczonalshift.zonal_autoshift_configurations (
 ZonalAutoshiftStatus,
 PracticeRunConfiguration,
 ResourceIdentifier,
 region
)
SELECT 
'{{ ZonalAutoshiftStatus }}',
 '{{ PracticeRunConfiguration }}',
 '{{ ResourceIdentifier }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.arczonalshift.zonal_autoshift_configurations (
 ZonalAutoshiftStatus,
 PracticeRunConfiguration,
 ResourceIdentifier,
 region
)
SELECT 
 '{{ ZonalAutoshiftStatus }}',
 '{{ PracticeRunConfiguration }}',
 '{{ ResourceIdentifier }}',
 '{{ 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: ZonalAutoshiftStatus
        value: '{{ ZonalAutoshiftStatus }}'
      - name: PracticeRunConfiguration
        value:
          BlockingAlarms:
            - Type: '{{ Type }}'
              AlarmIdentifier: '{{ AlarmIdentifier }}'
          OutcomeAlarms:
            - null
          BlockedDates:
            - '{{ BlockedDates[0] }}'
          BlockedWindows:
            - '{{ BlockedWindows[0] }}'
      - name: ResourceIdentifier
        value: '{{ ResourceIdentifier }}'

DELETE example

/*+ delete */
DELETE FROM aws.arczonalshift.zonal_autoshift_configurations
WHERE data__Identifier = '<ResourceIdentifier>'
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