Class VpcPeeringConnection

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

Represents a peering connection between a VPC on one of your Amazon Web Services accounts and the VPC for your Amazon GameLift Servers fleets. This record may be for an active peering connection or a pending connection that has not yet been established.

Related actions

All APIs by task

See Also:

  • Method Details

    • fleetId

      public final String fleetId()

      A unique identifier for the fleet. This ID determines the ID of the Amazon GameLift Servers VPC for your fleet.

      Returns:
      A unique identifier for the fleet. This ID determines the ID of the Amazon GameLift Servers VPC for your fleet.

    • fleetArn

      public final String fleetArn()

      The Amazon Resource Name (ARN) associated with the GameLift fleet resource for this connection.

      Returns:
      The Amazon Resource Name (ARN) associated with the GameLift fleet resource for this connection.

    • ipV4CidrBlock

      public final String ipV4CidrBlock()

      CIDR block of IPv4 addresses assigned to the VPC peering connection for the GameLift VPC. The peered VPC also has an IPv4 CIDR block associated with it; these blocks cannot overlap or the peering connection cannot be created.

      Returns:
      CIDR block of IPv4 addresses assigned to the VPC peering connection for the GameLift VPC. The peered VPC also has an IPv4 CIDR block associated with it; these blocks cannot overlap or the peering connection cannot be created.

    • vpcPeeringConnectionId

      public final String vpcPeeringConnectionId()

      A unique identifier that is automatically assigned to the connection record. This ID is referenced in VPC peering connection events, and is used when deleting a connection.

      Returns:
      A unique identifier that is automatically assigned to the connection record. This ID is referenced in VPC peering connection events, and is used when deleting a connection.

    • status

      public final VpcPeeringConnectionStatus status()

      The status information about the connection. Status indicates if a connection is pending, successful, or failed.

      Returns:
      The status information about the connection. Status indicates if a connection is pending, successful, or failed.

    • peerVpcId

      public final String peerVpcId()

      A unique identifier for a VPC with resources to be accessed by your Amazon GameLift Servers fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the Amazon Web Services Management Console. Learn more about VPC peering in VPC Peering with Amazon GameLift Servers Fleets.

      Returns:
      A unique identifier for a VPC with resources to be accessed by your Amazon GameLift Servers fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the Amazon Web Services Management Console. Learn more about VPC peering in VPC Peering with Amazon GameLift Servers Fleets.

    • gameLiftVpcId

      public final String gameLiftVpcId()

      A unique identifier for the VPC that contains the Amazon GameLift Servers fleet for this connection. This VPC is managed by Amazon GameLift Servers and does not appear in your Amazon Web Services account.

      Returns:
      A unique identifier for the VPC that contains the Amazon GameLift Servers fleet for this connection. This VPC is managed by Amazon GameLift Servers and does not appear in your Amazon Web Services account.

    • toBuilder

      public VpcPeeringConnection.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<VpcPeeringConnection.Builder,VpcPeeringConnection>
      Returns:
      a builder for type T

    • builder

      public static VpcPeeringConnection.Builder builder()

    • serializableBuilderClass

      public static Class<? extends VpcPeeringConnection.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.