vpc_block_public_access_exclusions

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

Overview

Name	vpc_block_public_access_exclusions
Type	Resource
Id	aws.ec2.vpc_block_public_access_exclusions

Fields

The following fields are returned by SELECT queries:

describe_vpc_block_public_access_exclusions

Name	Datatype	Description
creation_timestamp	string	When the exclusion was created.
deletion_timestamp	string	When the exclusion was deleted.
exclusion_id	string	The ID of the exclusion.
internet_gateway_exclusion_mode	string	The exclusion mode for internet gateway traffic. allow-bidirectional: Allow all internet traffic to and from the excluded VPCs and subnets. allow-egress: Allow outbound internet traffic from the excluded VPCs and subnets. Block inbound internet traffic to the excluded VPCs and subnets. Only applies when VPC Block Public Access is set to Bidirectional.
last_update_timestamp	string	When the exclusion was last updated.
reason	string	The reason for the current exclusion state.
resource_arn	string	The ARN of the exclusion.
state	string	The state of the exclusion.
tags	string	tag - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_vpc_block_public_access_exclusions	select	region	DryRun, Filter, ExclusionId, NextToken, MaxResults	Describe VPC Block Public Access (BPA) exclusions. A VPC BPA exclusion is a mode that can be applied to a single VPC or subnet that exempts it from the account’s BPA mode and will allow bidirectional or egress-only access. You can create BPA exclusions for VPCs and subnets even when BPA is not enabled on the account to ensure that there is no traffic disruption to the exclusions when VPC BPA is turned on. To learn more about VPC BPA, see Block public access to VPCs and subnets in the Amazon VPC User Guide.
create_vpc_block_public_access_exclusion	insert	InternetGatewayExclusionMode, region	DryRun, SubnetId, VpcId, TagSpecification	Create a VPC Block Public Access (BPA) exclusion. A VPC BPA exclusion is a mode that can be applied to a single VPC or subnet that exempts it from the account’s BPA mode and will allow bidirectional or egress-only access. You can create BPA exclusions for VPCs and subnets even when BPA is not enabled on the account to ensure that there is no traffic disruption to the exclusions when VPC BPA is turned on. To learn more about VPC BPA, see Block public access to VPCs and subnets in the Amazon VPC User Guide.
modify_vpc_block_public_access_exclusion	update	ExclusionId, InternetGatewayExclusionMode, region	DryRun	Modify VPC Block Public Access (BPA) exclusions. A VPC BPA exclusion is a mode that can be applied to a single VPC or subnet that exempts it from the account’s BPA mode and will allow bidirectional or egress-only access. You can create BPA exclusions for VPCs and subnets even when BPA is not enabled on the account to ensure that there is no traffic disruption to the exclusions when VPC BPA is turned on.
delete_vpc_block_public_access_exclusion	delete	ExclusionId, region	DryRun	Delete a VPC Block Public Access (BPA) exclusion. A VPC BPA exclusion is a mode that can be applied to a single VPC or subnet that exempts it from the account’s BPA mode and will allow bidirectional or egress-only access. You can create BPA exclusions for VPCs and subnets even when BPA is not enabled on the account to ensure that there is no traffic disruption to the exclusions when VPC BPA is turned on. To learn more about VPC BPA, see Block public access to VPCs and subnets in the Amazon VPC User Guide.

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
ExclusionId	string	The ID of the exclusion.
InternetGatewayExclusionMode	string	The exclusion mode for internet gateway traffic. allow-bidirectional: Allow all internet traffic to and from the excluded VPCs and subnets. allow-egress: Allow outbound internet traffic from the excluded VPCs and subnets. Block inbound internet traffic to the excluded VPCs and subnets. Only applies when VPC Block Public Access is set to Bidirectional.
region	string	AWS region (default: us-east-1)
DryRun	boolean	Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
ExclusionId	array	IDs of exclusions.
Filter	array	Filters for the request: resource-arn - The Amazon Resource Name (ARN) of a exclusion. internet-gateway-exclusion-mode - The mode of a VPC BPA exclusion. Possible values: allow-bidirectional | allow-egress. state - The state of VPC BPA. Possible values: create-in-progress | create-complete | update-in-progress | update-complete | delete-in-progress | deleted-complete | disable-in-progress | disable-complete tag - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. tag-value: The value of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific value, regardless of the tag key.
MaxResults	integer	The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
NextToken	string	The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
SubnetId	string	A subnet ID.
TagSpecification	array	tag - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
VpcId	string	A VPC ID.

SELECT examples

describe_vpc_block_public_access_exclusions

Describe VPC Block Public Access (BPA) exclusions. A VPC BPA exclusion is a mode that can be applied to a single VPC or subnet that exempts it from the account’s BPA mode and will allow bidirectional or egress-only access. You can create BPA exclusions for VPCs and subnets even when BPA is not enabled on the account to ensure that there is no traffic disruption to the exclusions when VPC BPA is turned on. To learn more about VPC BPA, see Block public access to VPCs and subnets in the Amazon VPC User Guide.

SELECT
creation_timestamp,
deletion_timestamp,
exclusion_id,
internet_gateway_exclusion_mode,
last_update_timestamp,
reason,
resource_arn,
state,
tags
FROM aws.ec2.vpc_block_public_access_exclusions
WHERE region = '{{ region }}' -- required
AND DryRun = '{{ DryRun }}'
AND Filter = '{{ Filter }}'
AND ExclusionId = '{{ ExclusionId }}'
AND NextToken = '{{ NextToken }}'
AND MaxResults = '{{ MaxResults }}'
;

INSERT examples

create_vpc_block_public_access_exclusion

Create a VPC Block Public Access (BPA) exclusion. A VPC BPA exclusion is a mode that can be applied to a single VPC or subnet that exempts it from the account’s BPA mode and will allow bidirectional or egress-only access. You can create BPA exclusions for VPCs and subnets even when BPA is not enabled on the account to ensure that there is no traffic disruption to the exclusions when VPC BPA is turned on. To learn more about VPC BPA, see Block public access to VPCs and subnets in the Amazon VPC User Guide.

INSERT INTO aws.ec2.vpc_block_public_access_exclusions (
InternetGatewayExclusionMode,
region,
DryRun,
SubnetId,
VpcId,
TagSpecification
)
SELECT 
'{{ InternetGatewayExclusionMode }}',
'{{ region }}',
'{{ DryRun }}',
'{{ SubnetId }}',
'{{ VpcId }}',
'{{ TagSpecification }}'
RETURNING
creation_timestamp,
deletion_timestamp,
exclusion_id,
internet_gateway_exclusion_mode,
last_update_timestamp,
reason,
resource_arn,
state,
tags
;

Manifest

# Description fields are for documentation purposes
- name: vpc_block_public_access_exclusions
props:
  - name: InternetGatewayExclusionMode
    value: "{{ InternetGatewayExclusionMode }}"
    description: Required parameter for the vpc_block_public_access_exclusions resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the vpc_block_public_access_exclusions resource.
  - name: DryRun
    value: {{ DryRun }}
    description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
    description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
  - name: SubnetId
    value: "{{ SubnetId }}"
    description: A subnet ID.
    description: A subnet ID.
  - name: VpcId
    value: "{{ VpcId }}"
    description: A VPC ID.
    description: A VPC ID.
  - name: TagSpecification
    value: "{{ TagSpecification }}"
    description: tag - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
    description: tag - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

UPDATE examples

modify_vpc_block_public_access_exclusion

Modify VPC Block Public Access (BPA) exclusions. A VPC BPA exclusion is a mode that can be applied to a single VPC or subnet that exempts it from the account’s BPA mode and will allow bidirectional or egress-only access. You can create BPA exclusions for VPCs and subnets even when BPA is not enabled on the account to ensure that there is no traffic disruption to the exclusions when VPC BPA is turned on.

UPDATE aws.ec2.vpc_block_public_access_exclusions
SET 
-- No updatable properties
WHERE 
ExclusionId = '{{ ExclusionId }}' --required
AND InternetGatewayExclusionMode = '{{ InternetGatewayExclusionMode }}' --required
AND region = '{{ region }}' --required
AND DryRun = {{ DryRun}}
RETURNING
creation_timestamp,
deletion_timestamp,
exclusion_id,
internet_gateway_exclusion_mode,
last_update_timestamp,
reason,
resource_arn,
state,
tags;

DELETE examples

delete_vpc_block_public_access_exclusion

Delete a VPC Block Public Access (BPA) exclusion. A VPC BPA exclusion is a mode that can be applied to a single VPC or subnet that exempts it from the account’s BPA mode and will allow bidirectional or egress-only access. You can create BPA exclusions for VPCs and subnets even when BPA is not enabled on the account to ensure that there is no traffic disruption to the exclusions when VPC BPA is turned on. To learn more about VPC BPA, see Block public access to VPCs and subnets in the Amazon VPC User Guide.

DELETE FROM aws.ec2.vpc_block_public_access_exclusions
WHERE ExclusionId = '{{ ExclusionId }}' --required
AND region = '{{ region }}' --required
AND DryRun = '{{ DryRun }}'
;