AWS::EC2::VPCBlockPublicAccessOptions - AWS CloudFormation
SyntaxPropertiesReturn values

AWS::EC2::VPCBlockPublicAccessOptions

VPC Block Public Access (BPA) enables you to block resources in VPCs and subnets that you own in a Region from reaching or being reached from the internet through internet gateways and egress-only internet gateways. To learn more about VPC BPA, see Block public access to VPCs and subnets in the Amazon VPC User Guide.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::EC2::VPCBlockPublicAccessOptions",
  "Properties" : {
      "InternetGatewayBlockMode" : String
    }
}

YAML

Type: AWS::EC2::VPCBlockPublicAccessOptions
Properties:
  InternetGatewayBlockMode: String

Properties

InternetGatewayBlockMode

The desired VPC Block Public Access mode for internet gateways in your account. We do not allow you to create this resource type in an "off" mode since off is the default value.

  • block-bidirectional: Block all traffic to and from internet gateways and egress-only internet gateways in this Region (except for excluded VPCs and subnets).

  • block-ingress: Block all internet traffic to the VPCs in this Region (except for VPCs or subnets which are excluded). Only traffic to and from NAT gateways and egress-only internet gateways is allowed because these gateways only allow outbound connections to be established.

Required: Yes

Type: String

Allowed values: block-bidirectional | block-ingress

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns your account ID.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

AccountId

The ID of the AWS account.