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
Nameand differentRevisionvalues.At this time, App Runner supports only one revision per name.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceVpcConnector.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VpcConnector.Builderbuilder()InstantcreatedAt()The time when the VPC connector was created.InstantdeletedAt()The time when the VPC connector was deleted.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasSecurityGroups()For responses, this returns true if the service returned a value for the SecurityGroups property.booleanhasSubnets()For responses, this returns true if the service returned a value for the Subnets property.Map<String,SdkField<?>>sdkFieldNameToField()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()VpcConnectorStatusstatus()The current state of the VPC connector.StringstatusAsString()The current state of the VPC connector.List<String>subnets()A list of IDs of subnets that App Runner uses for your service.VpcConnector.BuildertoBuilder()StringtoString()Returns a string representation of this object.StringvpcConnectorArn()The Amazon Resource Name (ARN) of this VPC connector.StringvpcConnectorName()The customer-provided VPC connector name.IntegervpcConnectorRevision()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 sameName.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 sameName.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 theisEmpty()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 theisEmpty()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,
statuswill returnVpcConnectorStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- 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,
statuswill returnVpcConnectorStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- 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:
toBuilderin interfaceToCopyableBuilder<VpcConnector.Builder,VpcConnector>
-
builder
public static VpcConnector.Builder builder()
-
serializableBuilderClass
public static Class<? extends VpcConnector.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-