Package software.amazon.awssdk.services.apprunner.model

Class VpcConnector

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

Describes an App Runner VPC connector resource. A VPC connector describes the Amazon Virtual Private Cloud (Amazon VPC) that an App Runner service is associated with, and the subnets and security group that are used.

Multiple revisions of a connector might have the same Name and different Revision values.

At this time, App Runner supports only one revision per name.

See Also:

  • Method Details

    • vpcConnectorName

      public final String vpcConnectorName()

      The customer-provided VPC connector name.

      Returns:
      The customer-provided VPC connector name.

    • vpcConnectorArn

      public final String vpcConnectorArn()

      The Amazon Resource Name (ARN) of this VPC connector.

      Returns:
      The Amazon Resource Name (ARN) of this VPC connector.

    • vpcConnectorRevision

      public final Integer vpcConnectorRevision()

      The revision of this VPC connector. It's unique among all the active connectors ("Status": "ACTIVE") that share the same Name.

      At this time, App Runner supports only one revision per name.

      Returns:
      The revision of this VPC connector. It's unique among all the active connectors ( "Status": "ACTIVE") that share the same Name.

      At this time, App Runner supports only one revision per name.

    • hasSubnets

      public final boolean hasSubnets()
      For responses, this returns true if the service returned a value for the Subnets 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.

    • subnets

      public final List<String> subnets()

      A list of IDs of subnets that App Runner uses for your service. All IDs are of subnets of a single Amazon VPC.

      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 hasSubnets() method.

      Returns:
      A list of IDs of subnets that App Runner uses for your service. All IDs are of subnets of a single Amazon VPC.

    • hasSecurityGroups

      public final boolean hasSecurityGroups()
      For responses, this returns true if the service returned a value for the SecurityGroups 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.

    • securityGroups

      public final List<String> securityGroups()

      A list of IDs of security groups that App Runner uses for access to Amazon Web Services resources under the specified subnets. If not specified, App Runner uses the default security group of the Amazon VPC. The default security group allows all outbound traffic.

      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 hasSecurityGroups() method.

      Returns:
      A list of IDs of security groups that App Runner uses for access to Amazon Web Services resources under the specified subnets. If not specified, App Runner uses the default security group of the Amazon VPC. The default security group allows all outbound traffic.

    • status

      public final VpcConnectorStatus status()

      The current state of the VPC connector. If the status of a connector revision is INACTIVE, it was deleted and can't be used. Inactive connector revisions are permanently removed some time after they are deleted.

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

      Returns:
      The current state of the VPC connector. If the status of a connector revision is INACTIVE, it was deleted and can't be used. Inactive connector revisions are permanently removed some time after they are deleted.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current state of the VPC connector. If the status of a connector revision is INACTIVE, it was deleted and can't be used. Inactive connector revisions are permanently removed some time after they are deleted.

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

      Returns:
      The current state of the VPC connector. If the status of a connector revision is INACTIVE, it was deleted and can't be used. Inactive connector revisions are permanently removed some time after they are deleted.
      See Also:

    • createdAt

      public final Instant createdAt()

      The time when the VPC connector was created. It's in Unix time stamp format.

      Returns:
      The time when the VPC connector was created. It's in Unix time stamp format.

    • deletedAt

      public final Instant deletedAt()

      The time when the VPC connector was deleted. It's in Unix time stamp format.

      Returns:
      The time when the VPC connector was deleted. It's in Unix time stamp format.

    • toBuilder

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

    • builder

      public static VpcConnector.Builder builder()

    • serializableBuilderClass

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