Class VpcBlockPublicAccessOptions
- java.lang.Object
-
- software.amazon.awssdk.services.ec2.model.VpcBlockPublicAccessOptions
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<VpcBlockPublicAccessOptions.Builder,VpcBlockPublicAccessOptions>
@Generated("software.amazon.awssdk:codegen") public final class VpcBlockPublicAccessOptions extends Object implements SdkPojo, Serializable, ToCopyableBuilder<VpcBlockPublicAccessOptions.Builder,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.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
VpcBlockPublicAccessOptions.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description String
awsAccountId()
An Amazon Web Services account ID.String
awsRegion()
An Amazon Web Services Region.static VpcBlockPublicAccessOptions.Builder
builder()
boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
VpcBlockPublicAccessExclusionsAllowed
exclusionsAllowed()
Determines if exclusions are allowed.String
exclusionsAllowedAsString()
Determines if exclusions are allowed.<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
InternetGatewayBlockMode
internetGatewayBlockMode()
The current mode of VPC BPA.String
internetGatewayBlockModeAsString()
The current mode of VPC BPA.Instant
lastUpdateTimestamp()
The last time the VPC BPA mode was updated.ManagedBy
managedBy()
The entity that manages the state of VPC BPA.String
managedByAsString()
The entity that manages the state of VPC BPA.String
reason()
The reason for the current state.Map<String,SdkField<?>>
sdkFieldNameToField()
List<SdkField<?>>
sdkFields()
static Class<? extends VpcBlockPublicAccessOptions.Builder>
serializableBuilderClass()
VpcBlockPublicAccessState
state()
The current state of VPC BPA.String
stateAsString()
The current state of VPC BPA.VpcBlockPublicAccessOptions.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
awsAccountId
public final String awsAccountId()
An Amazon Web Services account ID.
- Returns:
- An Amazon Web Services account ID.
-
awsRegion
public final String awsRegion()
An Amazon Web Services Region.
- Returns:
- An Amazon Web Services Region.
-
state
public final VpcBlockPublicAccessState state()
The current state of VPC BPA.
If the service returns an enum value that is not available in the current SDK version,
state
will returnVpcBlockPublicAccessState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The current state of VPC BPA.
- See Also:
VpcBlockPublicAccessState
-
stateAsString
public final String stateAsString()
The current state of VPC BPA.
If the service returns an enum value that is not available in the current SDK version,
state
will returnVpcBlockPublicAccessState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The current state of VPC BPA.
- See Also:
VpcBlockPublicAccessState
-
internetGatewayBlockMode
public final InternetGatewayBlockMode internetGatewayBlockMode()
The current mode of VPC BPA.
-
off
: VPC BPA is not enabled and traffic is allowed to and from internet gateways and egress-only internet gateways in this Region. -
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.
If the service returns an enum value that is not available in the current SDK version,
internetGatewayBlockMode
will returnInternetGatewayBlockMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominternetGatewayBlockModeAsString()
.- Returns:
- The current mode of VPC BPA.
-
off
: VPC BPA is not enabled and traffic is allowed to and from internet gateways and egress-only internet gateways in this Region. -
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.
-
- See Also:
InternetGatewayBlockMode
-
-
internetGatewayBlockModeAsString
public final String internetGatewayBlockModeAsString()
The current mode of VPC BPA.
-
off
: VPC BPA is not enabled and traffic is allowed to and from internet gateways and egress-only internet gateways in this Region. -
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.
If the service returns an enum value that is not available in the current SDK version,
internetGatewayBlockMode
will returnInternetGatewayBlockMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominternetGatewayBlockModeAsString()
.- Returns:
- The current mode of VPC BPA.
-
off
: VPC BPA is not enabled and traffic is allowed to and from internet gateways and egress-only internet gateways in this Region. -
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.
-
- See Also:
InternetGatewayBlockMode
-
-
reason
public final String reason()
The reason for the current state.
- Returns:
- The reason for the current state.
-
lastUpdateTimestamp
public final Instant lastUpdateTimestamp()
The last time the VPC BPA mode was updated.
- Returns:
- The last time the VPC BPA mode was updated.
-
managedBy
public final ManagedBy managedBy()
The entity that manages the state of VPC BPA. Possible values include:
-
account
- The state is managed by the account. -
declarative-policy
- The state is managed by a declarative policy and can't be modified by the account.
If the service returns an enum value that is not available in the current SDK version,
managedBy
will returnManagedBy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommanagedByAsString()
.- Returns:
- The entity that manages the state of VPC BPA. Possible values include:
-
account
- The state is managed by the account. -
declarative-policy
- The state is managed by a declarative policy and can't be modified by the account.
-
- See Also:
ManagedBy
-
-
managedByAsString
public final String managedByAsString()
The entity that manages the state of VPC BPA. Possible values include:
-
account
- The state is managed by the account. -
declarative-policy
- The state is managed by a declarative policy and can't be modified by the account.
If the service returns an enum value that is not available in the current SDK version,
managedBy
will returnManagedBy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommanagedByAsString()
.- Returns:
- The entity that manages the state of VPC BPA. Possible values include:
-
account
- The state is managed by the account. -
declarative-policy
- The state is managed by a declarative policy and can't be modified by the account.
-
- See Also:
ManagedBy
-
-
exclusionsAllowed
public final VpcBlockPublicAccessExclusionsAllowed exclusionsAllowed()
Determines if exclusions are allowed. If you have enabled VPC BPA at the Organization level, exclusions may be
not-allowed
. Otherwise, they areallowed
.If the service returns an enum value that is not available in the current SDK version,
exclusionsAllowed
will returnVpcBlockPublicAccessExclusionsAllowed.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromexclusionsAllowedAsString()
.- Returns:
- Determines if exclusions are allowed. If you have enabled VPC BPA at the Organization level, exclusions may be
not-allowed
. Otherwise, they areallowed
. - See Also:
VpcBlockPublicAccessExclusionsAllowed
-
exclusionsAllowedAsString
public final String exclusionsAllowedAsString()
Determines if exclusions are allowed. If you have enabled VPC BPA at the Organization level, exclusions may be
not-allowed
. Otherwise, they areallowed
.If the service returns an enum value that is not available in the current SDK version,
exclusionsAllowed
will returnVpcBlockPublicAccessExclusionsAllowed.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromexclusionsAllowedAsString()
.- Returns:
- Determines if exclusions are allowed. If you have enabled VPC BPA at the Organization level, exclusions may be
not-allowed
. Otherwise, they areallowed
. - See Also:
VpcBlockPublicAccessExclusionsAllowed
-
toBuilder
public VpcBlockPublicAccessOptions.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<VpcBlockPublicAccessOptions.Builder,VpcBlockPublicAccessOptions>
-
builder
public static VpcBlockPublicAccessOptions.Builder builder()
-
serializableBuilderClass
public static Class<? extends VpcBlockPublicAccessOptions.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
-
-