Package software.amazon.awssdk.services.sagemaker.model

Class VpcConfig

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.VpcConfig

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<VpcConfig.Builder,VpcConfig>

@Generated("software.amazon.awssdk:codegen")
public final class VpcConfig
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<VpcConfig.Builder,VpcConfig>

Specifies a VPC that your training jobs and hosted models have access to. Control access to and from your training and model containers by configuring the VPC. For more information, see Protect Endpoints by Using an Amazon Virtual Private Cloud and Protect Training Jobs by Using an Amazon Virtual Private Cloud.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	VpcConfig.Builder

Method Summary

Modifier and Type	Method	Description
static VpcConfig.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSecurityGroupIds()	For responses, this returns true if the service returned a value for the SecurityGroupIds property.
boolean	hasSubnets()	For responses, this returns true if the service returned a value for the Subnets property.
List<SdkField<?>>	sdkFields()
List<String>	securityGroupIds()	The VPC security group IDs, in the form sg-xxxxxxxx.
static Class<? extends VpcConfig.Builder>	serializableBuilderClass()
List<String>	subnets()	The ID of the subnets in the VPC to which you want to connect your training job or model.
VpcConfig.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

hasSecurityGroupIds

public final boolean hasSecurityGroupIds()

For responses, this returns true if the service returned a value for the SecurityGroupIds 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.

securityGroupIds

public final List<String> securityGroupIds()

The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.

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

Returns:

The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.

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

The ID of the subnets in the VPC to which you want to connect your training job or model. For information about the availability of specific instance types, see Supported Instance Types and Availability Zones.

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:

The ID of the subnets in the VPC to which you want to connect your training job or model. For information about the availability of specific instance types, see Supported Instance Types and Availability Zones.

toBuilder

public VpcConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<VpcConfig.Builder,VpcConfig>

builder

public static VpcConfig.Builder builder()

serializableBuilderClass

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