com.amazonaws.services.sagemaker.model.VpcConfig Maven / Gradle / Ivy
Show all versions of aws-java-sdk-sagemaker Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.sagemaker.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have
* access to. You can control access to and from your resources by configuring a VPC. For more information, see Give SageMaker Access to
* Resources in your Amazon VPC.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class VpcConfig implements Serializable, Cloneable, StructuredPojo {
/**
*
* The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is
* specified in the Subnets field.
*
*/
private java.util.List securityGroupIds;
/**
*
* 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.
*
*/
private java.util.List subnets;
/**
*
* The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is
* specified in the Subnets field.
*
*
* @return The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC
* that is specified in the Subnets field.
*/
public java.util.List getSecurityGroupIds() {
return 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.
*
*
* @param 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.
*/
public void setSecurityGroupIds(java.util.Collection securityGroupIds) {
if (securityGroupIds == null) {
this.securityGroupIds = null;
return;
}
this.securityGroupIds = new java.util.ArrayList(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.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setSecurityGroupIds(java.util.Collection)} or {@link #withSecurityGroupIds(java.util.Collection)} if you
* want to override the existing values.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public VpcConfig withSecurityGroupIds(String... securityGroupIds) {
if (this.securityGroupIds == null) {
setSecurityGroupIds(new java.util.ArrayList(securityGroupIds.length));
}
for (String ele : securityGroupIds) {
this.securityGroupIds.add(ele);
}
return this;
}
/**
*
* The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is
* specified in the Subnets field.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public VpcConfig withSecurityGroupIds(java.util.Collection securityGroupIds) {
setSecurityGroupIds(securityGroupIds);
return this;
}
/**
*
* 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.
*
*
* @return 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.
*/
public java.util.List getSubnets() {
return 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.
*
*
* @param 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.
*/
public void setSubnets(java.util.Collection subnets) {
if (subnets == null) {
this.subnets = null;
return;
}
this.subnets = new java.util.ArrayList(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.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setSubnets(java.util.Collection)} or {@link #withSubnets(java.util.Collection)} if you want to override
* the existing values.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public VpcConfig withSubnets(String... subnets) {
if (this.subnets == null) {
setSubnets(new java.util.ArrayList(subnets.length));
}
for (String ele : subnets) {
this.subnets.add(ele);
}
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public VpcConfig withSubnets(java.util.Collection subnets) {
setSubnets(subnets);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getSecurityGroupIds() != null)
sb.append("SecurityGroupIds: ").append(getSecurityGroupIds()).append(",");
if (getSubnets() != null)
sb.append("Subnets: ").append(getSubnets());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof VpcConfig == false)
return false;
VpcConfig other = (VpcConfig) obj;
if (other.getSecurityGroupIds() == null ^ this.getSecurityGroupIds() == null)
return false;
if (other.getSecurityGroupIds() != null && other.getSecurityGroupIds().equals(this.getSecurityGroupIds()) == false)
return false;
if (other.getSubnets() == null ^ this.getSubnets() == null)
return false;
if (other.getSubnets() != null && other.getSubnets().equals(this.getSubnets()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getSecurityGroupIds() == null) ? 0 : getSecurityGroupIds().hashCode());
hashCode = prime * hashCode + ((getSubnets() == null) ? 0 : getSubnets().hashCode());
return hashCode;
}
@Override
public VpcConfig clone() {
try {
return (VpcConfig) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.sagemaker.model.transform.VpcConfigMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}