vpc_block_public_access_options

Creates, updates, deletes or gets a vpc_block_public_access_option resource or lists vpc_block_public_access_options in a region

Overview

Name	vpc_block_public_access_options
Type	Resource
Description	Resource Type definition for AWS::EC2::VPCBlockPublicAccessOptions
Id	awscc.ec2.vpc_block_public_access_options

Fields

Name	Datatype	Description
internet_gateway_block_mode	string	The desired Block Public Access mode for Internet Gateways in your account. We do not allow to create in a off mode as this is the default value
account_id	string	The identifier for the specified AWS account.
exclusions_allowed	string	Determines if exclusions are allowed. If you have enabled VPC BPA at the Organization level, exclusions may be not-allowed. Otherwise, they are allowed.
region	string	AWS region.

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

Methods

Name	Accessible by	Required Params
create_resource	INSERT	InternetGatewayBlockMode, region
delete_resource	DELETE	Identifier, region
update_resource	UPDATE	Identifier, PatchDocument, region
get_resource	SELECT	Identifier, region

SELECT examples

Gets all properties from an individual vpc_block_public_access_option.

SELECT
  region,
  internet_gateway_block_mode,
  account_id,
  exclusions_allowed
FROM awscc.ec2.vpc_block_public_access_options
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ account_id }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.ec2.vpc_block_public_access_options (
  InternetGatewayBlockMode,
  region
)
SELECT
  '{{ internet_gateway_block_mode }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.ec2.vpc_block_public_access_options (
  InternetGatewayBlockMode,
  region
)
SELECT
  '{{ internet_gateway_block_mode }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: vpc_block_public_access_option
    props:
      - name: internet_gateway_block_mode
        value: '{{ internet_gateway_block_mode }}'

UPDATE example

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

/*+ update */
UPDATE awscc.ec2.vpc_block_public_access_options
SET PatchDocument = string('{{ {
    "InternetGatewayBlockMode": internet_gateway_block_mode
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ account_id }}';

DELETE example

/*+ delete */
DELETE FROM awscc.ec2.vpc_block_public_access_options
WHERE
  Identifier = '{{ account_id }}' AND
  region = 'us-east-1';

Permissions

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

Create

ec2:DescribeVpcBlockPublicAccessOptions,
ec2:ModifyVpcBlockPublicAccessOptions

Read

ec2:DescribeVpcBlockPublicAccessOptions

Update

ec2:DescribeVpcBlockPublicAccessOptions,
ec2:ModifyVpcBlockPublicAccessOptions

Delete

ec2:DescribeVpcBlockPublicAccessOptions,
ec2:ModifyVpcBlockPublicAccessOptions