Class VpcConfiguration

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

Contains the details of a VPC configuration, including its connection settings, resolution mode, and current lifecycle status.

See Also:

  • Method Details

    • vpcConfigurationId

      public final String vpcConfigurationId()

      The unique identifier of the VPC configuration.

      Returns:
      The unique identifier of the VPC configuration.

    • status

      public final VpcConfigurationStatus status()

      The current lifecycle status of the VPC configuration.

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

      Returns:
      The current lifecycle status of the VPC configuration.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current lifecycle status of the VPC configuration.

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

      Returns:
      The current lifecycle status of the VPC configuration.
      See Also:

    • statusMessage

      public final String statusMessage()

      Additional detail about the current status, such as the cause of a CREATE_FAILED or DELETE_FAILED status.

      Returns:
      Additional detail about the current status, such as the cause of a CREATE_FAILED or DELETE_FAILED status.

    • vpcId

      public final String vpcId()

      The identifier of the VPC that the knowledge base connects through to reach the resource.

      Returns:
      The identifier of the VPC that the knowledge base connects through to reach the resource.

    • hasSubnetIds

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

    • subnetIds

      public final List<String> subnetIds()

      The subnets that the knowledge base uses to connect to the resource.

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

      Returns:
      The subnets that the knowledge base uses to connect to the resource.

    • resourceTarget

      public final String resourceTarget()

      The private IPv4 address or DNS name of the resource.

      Returns:
      The private IPv4 address or DNS name of the resource.

    • port

      public final Integer port()

      The port on which the resource is reached.

      Returns:
      The port on which the resource is reached.

    • protocol

      public final VpcProtocol protocol()

      The protocol used to connect to the resource.

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

      Returns:
      The protocol used to connect to the resource.
      See Also:

    • protocolAsString

      public final String protocolAsString()

      The protocol used to connect to the resource.

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

      Returns:
      The protocol used to connect to the resource.
      See Also:

    • resolutionMode

      public final VpcResolutionMode resolutionMode()

      Specifies how the resource target is resolved.

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

      Returns:
      Specifies how the resource target is resolved.
      See Also:

    • resolutionModeAsString

      public final String resolutionModeAsString()

      Specifies how the resource target is resolved.

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

      Returns:
      Specifies how the resource target is resolved.
      See Also:

    • hostHeader

      public final String hostHeader()

      The HTTP Host header value sent when invoking the resource, if configured.

      Returns:
      The HTTP Host header value sent when invoking the resource, if configured.

    • tlsServerName

      public final String tlsServerName()

      The expected TLS server name that the service matches against the Subject Alternative Names on the resource's TLS certificate. Present when protocol is HTTPS.

      Returns:
      The expected TLS server name that the service matches against the Subject Alternative Names on the resource's TLS certificate. Present when protocol is HTTPS.

    • name

      public final String name()

      The human-readable name of the VPC configuration, if provided.

      Returns:
      The human-readable name of the VPC configuration, if provided.

    • description

      public final String description()

      The description of the VPC configuration, if provided.

      Returns:
      The description of the VPC configuration, if provided.

    • createdAt

      public final Instant createdAt()

      The time at which the VPC configuration was created.

      Returns:
      The time at which the VPC configuration was created.

    • updatedAt

      public final Instant updatedAt()

      The time at which the VPC configuration was last updated.

      Returns:
      The time at which the VPC configuration was last updated.

    • toBuilder

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

    • builder

      public static VpcConfiguration.Builder builder()

    • serializableBuilderClass

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