software.amazon.awssdk.services.apigateway.model

Class CreateVpcLinkResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.apigateway.model.ApiGatewayResponse

software.amazon.awssdk.services.apigateway.model.CreateVpcLinkResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateVpcLinkResponse.Builder,CreateVpcLinkResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateVpcLinkResponse
extends ApiGatewayResponse
implements ToCopyableBuilder<CreateVpcLinkResponse.Builder,CreateVpcLinkResponse>

An API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC).

To enable access to a resource in an Amazon Virtual Private Cloud through Amazon API Gateway, you, as an API developer, create a VpcLink resource targeted for one or more network load balancers of the VPC and then integrate an API method with a private integration that uses the VpcLink. The private integration has an integration type of HTTP or HTTP_PROXY and has a connection type of VPC_LINK. The integration uses the connectionId property to identify the VpcLink used.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateVpcLinkResponse.Builder

Method Summary

Modifier and Type	Method and Description
static CreateVpcLinkResponse.Builder	builder()
String	description() The description of the VPC link.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasTargetArns() Returns true if the TargetArns property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
String	id() The identifier of the VpcLink.
String	name() The name used to label and identify the VPC link.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateVpcLinkResponse.Builder>	serializableBuilderClass()
VpcLinkStatus	status() The status of the VPC link.
String	statusAsString() The status of the VPC link.
String	statusMessage() A description about the VPC link status.
Map<String,String>	tags() The collection of tags.
List<String>	targetArns() The ARN of the network load balancer of the VPC targeted by the VPC link.
CreateVpcLinkResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.apigateway.model.ApiGatewayResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

id

public final String id()

The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.

Returns:

The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.

name

public final String name()

The name used to label and identify the VPC link.

Returns:

The name used to label and identify the VPC link.

description

public final String description()

The description of the VPC link.

Returns:

The description of the VPC link.

hasTargetArns

public final boolean hasTargetArns()

Returns true if the TargetArns property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

targetArns

public final List<String> targetArns()

The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner.

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

You can use hasTargetArns() to see if a value was sent in this field.

Returns:

The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner.

status

public final VpcLinkStatus status()

The status of the VPC link. The valid values are AVAILABLE, PENDING, DELETING, or FAILED. Deploying an API will wait if the status is PENDING and will fail if the status is DELETING.

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

Returns:

The status of the VPC link. The valid values are AVAILABLE, PENDING, DELETING, or FAILED. Deploying an API will wait if the status is PENDING and will fail if the status is DELETING.

See Also:

VpcLinkStatus

statusAsString

public final String statusAsString()

The status of the VPC link. The valid values are AVAILABLE, PENDING, DELETING, or FAILED. Deploying an API will wait if the status is PENDING and will fail if the status is DELETING.

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

Returns:

The status of the VPC link. The valid values are AVAILABLE, PENDING, DELETING, or FAILED. Deploying an API will wait if the status is PENDING and will fail if the status is DELETING.

See Also:

VpcLinkStatus

statusMessage

public final String statusMessage()

A description about the VPC link status.

Returns:

A description about the VPC link status.

hasTags

public final boolean hasTags()

Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

tags

public final Map<String,String> tags()

The collection of tags. Each tag element is associated with a given resource.

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

You can use hasTags() to see if a value was sent in this field.

Returns:

The collection of tags. Each tag element is associated with a given resource.

toBuilder

public CreateVpcLinkResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateVpcLinkResponse.Builder,CreateVpcLinkResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static CreateVpcLinkResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo