Class VpcBlockPublicAccessExclusion

java.lang.Object
software.amazon.awssdk.services.ec2.model.VpcBlockPublicAccessExclusion
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<VpcBlockPublicAccessExclusion.Builder,VpcBlockPublicAccessExclusion>
@Generated("software.amazon.awssdk:codegen") public final class VpcBlockPublicAccessExclusion extends Object implements SdkPojo, Serializable, ToCopyableBuilder<VpcBlockPublicAccessExclusion.Builder,VpcBlockPublicAccessExclusion>

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.

See Also:

  • Method Details

    • exclusionId

      public final String exclusionId()

      The ID of the exclusion.

      Returns:
      The ID of the exclusion.

    • internetGatewayExclusionMode

      public final InternetGatewayExclusionMode internetGatewayExclusionMode()

      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.

      If the service returns an enum value that is not available in the current SDK version, internetGatewayExclusionMode will return InternetGatewayExclusionMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from internetGatewayExclusionModeAsString().

      Returns:
      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.

      See Also:

    • internetGatewayExclusionModeAsString

      public final String internetGatewayExclusionModeAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, internetGatewayExclusionMode will return InternetGatewayExclusionMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from internetGatewayExclusionModeAsString().

      Returns:
      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.

      See Also:

    • resourceArn

      public final String resourceArn()

      The ARN of the exclusion.

      Returns:
      The ARN of the exclusion.

    • state

      public final VpcBlockPublicAccessExclusionState state()

      The state of the exclusion.

      If the service returns an enum value that is not available in the current SDK version, state will return VpcBlockPublicAccessExclusionState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      Returns:
      The state of the exclusion.
      See Also:

    • stateAsString

      public final String stateAsString()

      The state of the exclusion.

      If the service returns an enum value that is not available in the current SDK version, state will return VpcBlockPublicAccessExclusionState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      Returns:
      The state of the exclusion.
      See Also:

    • reason

      public final String reason()

      The reason for the current exclusion state.

      Returns:
      The reason for the current exclusion state.

    • creationTimestamp

      public final Instant creationTimestamp()

      When the exclusion was created.

      Returns:
      When the exclusion was created.

    • lastUpdateTimestamp

      public final Instant lastUpdateTimestamp()

      When the exclusion was last updated.

      Returns:
      When the exclusion was last updated.

    • deletionTimestamp

      public final Instant deletionTimestamp()

      When the exclusion was deleted.

      Returns:
      When the exclusion was deleted.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final List<Tag> tags()

      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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      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.

    • toBuilder

      public VpcBlockPublicAccessExclusion.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<VpcBlockPublicAccessExclusion.Builder,VpcBlockPublicAccessExclusion>
      Returns:
      a builder for type T

    • builder

      public static VpcBlockPublicAccessExclusion.Builder builder()

    • serializableBuilderClass

      public static Class<? extends VpcBlockPublicAccessExclusion.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.