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(value="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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	VpcConnector.Builder

Method Summary

Modifier and Type	Method and Description
static VpcConnector.Builder	builder()
Instant	createdAt() The time when the VPC connector was created.
Instant	deletedAt() The time when the VPC connector was deleted.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSecurityGroups() For responses, this returns true if the service returned a value for the SecurityGroups property.
boolean	hasSubnets() For responses, this returns true if the service returned a value for the Subnets property.
List<SdkField<?>>	sdkFields()
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.
static Class<? extends VpcConnector.Builder>	serializableBuilderClass()
VpcConnectorStatus	status() The current state of the VPC connector.
String	statusAsString() The current state of the VPC connector.
List<String>	subnets() A list of IDs of subnets that App Runner uses for your service.
VpcConnector.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	vpcConnectorArn() The Amazon Resource Name (ARN) of this VPC connector.
String	vpcConnectorName() The customer-provided VPC connector name.
Integer	vpcConnectorRevision() The revision of this VPC connector.

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

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:

VpcConnectorStatus

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:

VpcConnectorStatus

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()

Specified by:

toBuilder in interface ToCopyableBuilder<VpcConnector.Builder,VpcConnector>

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)

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo