snapshot_block_public_accesses

Creates, updates, deletes or gets a snapshot_block_public_access resource or lists snapshot_block_public_accesses in a region

Overview

Name	snapshot_block_public_accesses
Type	Resource
Description	Resource Type definition for AWS::EC2::SnapshotBlockPublicAccess
Id	awscc.ec2.snapshot_block_public_accesses

Fields

get (all properties)

Name	Datatype	Description
state	string	The state of EBS Snapshot Block Public Access.
account_id	string	The identifier for the specified AWS account.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
account_id	string	The identifier for the specified AWS account.
region	string	AWS region.

For more information, see AWS::EC2::SnapshotBlockPublicAccess.

Methods

Name	Resource	Accessible by	Required Params
create_resource	snapshot_block_public_accesses	INSERT	State, region
delete_resource	snapshot_block_public_accesses	DELETE	Identifier, region
update_resource	snapshot_block_public_accesses	UPDATE	Identifier, PatchDocument, region
list_resources	snapshot_block_public_accesses_list_only	SELECT	region
get_resource	snapshot_block_public_accesses	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual snapshot_block_public_access.

SELECT
  region,
  state,
  account_id
FROM awscc.ec2.snapshot_block_public_accesses
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ account_id }}';

list (identifiers only)

Lists all snapshot_block_public_accesses in a region.

SELECT
  region,
  account_id
FROM awscc.ec2.snapshot_block_public_accesses_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.ec2.snapshot_block_public_accesses (
  State,
  region
)
SELECT
  '{{ state }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.ec2.snapshot_block_public_accesses (
  State,
  region
)
SELECT
  '{{ state }}',
  '{{ 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: snapshot_block_public_access
  props:
    - name: state
      value: '{{ state }}'

UPDATE example

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

/*+ update */
UPDATE awscc.ec2.snapshot_block_public_accesses
SET PatchDocument = string('{{ {
    "State": state
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ account_id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.ec2.snapshot_block_public_accesses
WHERE
  Identifier = '{{ account_id }}' 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 snapshot_block_public_accesses resource, the following permissions are required:

Create

ec2:EnableSnapshotBlockPublicAccess,
ec2:GetSnapshotBlockPublicAccessState

Read

ec2:GetSnapshotBlockPublicAccessState

Update

ec2:EnableSnapshotBlockPublicAccess,
ec2:GetSnapshotBlockPublicAccessState

Delete

ec2:DisableSnapshotBlockPublicAccess,
ec2:GetSnapshotBlockPublicAccessState

List

ec2:GetSnapshotBlockPublicAccessState