com.amazonaws.services.sagemaker.model

Class CreateDomainRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.sagemaker.model.CreateDomainRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateDomainRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateDomainRequest()

Method Summary

Modifier and Type	Method and Description
CreateDomainRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getAppNetworkAccessType() Specifies the VPC used for non-EFS traffic.
String	getAppSecurityGroupManagement() The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode.
String	getAuthMode() The mode of authentication that members use to access the domain.
DefaultSpaceSettings	getDefaultSpaceSettings() The default settings used to create a space.
UserSettings	getDefaultUserSettings() The default settings to use to create a user profile when UserSettings isn't specified in the call to the CreateUserProfile API.
String	getDomainName() A name for the domain.
DomainSettings	getDomainSettings() A collection of Domain settings.
String	getHomeEfsFileSystemKmsKeyId() Deprecated.
String	getKmsKeyId() SageMaker uses Amazon Web Services KMS to encrypt EFS and EBS volumes attached to the domain with an Amazon Web Services managed key by default.
List<String>	getSubnetIds() The VPC subnets that the domain uses for communication.
List<Tag>	getTags() Tags to associated with the Domain.
String	getVpcId() The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.
int	hashCode()
void	setAppNetworkAccessType(String appNetworkAccessType) Specifies the VPC used for non-EFS traffic.
void	setAppSecurityGroupManagement(String appSecurityGroupManagement) The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode.
void	setAuthMode(String authMode) The mode of authentication that members use to access the domain.
void	setDefaultSpaceSettings(DefaultSpaceSettings defaultSpaceSettings) The default settings used to create a space.
void	setDefaultUserSettings(UserSettings defaultUserSettings) The default settings to use to create a user profile when UserSettings isn't specified in the call to the CreateUserProfile API.
void	setDomainName(String domainName) A name for the domain.
void	setDomainSettings(DomainSettings domainSettings) A collection of Domain settings.
void	setHomeEfsFileSystemKmsKeyId(String homeEfsFileSystemKmsKeyId) Deprecated.
void	setKmsKeyId(String kmsKeyId) SageMaker uses Amazon Web Services KMS to encrypt EFS and EBS volumes attached to the domain with an Amazon Web Services managed key by default.
void	setSubnetIds(Collection<String> subnetIds) The VPC subnets that the domain uses for communication.
void	setTags(Collection<Tag> tags) Tags to associated with the Domain.
void	setVpcId(String vpcId) The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.
String	toString() Returns a string representation of this object.
CreateDomainRequest	withAppNetworkAccessType(AppNetworkAccessType appNetworkAccessType) Specifies the VPC used for non-EFS traffic.
CreateDomainRequest	withAppNetworkAccessType(String appNetworkAccessType) Specifies the VPC used for non-EFS traffic.
CreateDomainRequest	withAppSecurityGroupManagement(AppSecurityGroupManagement appSecurityGroupManagement) The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode.
CreateDomainRequest	withAppSecurityGroupManagement(String appSecurityGroupManagement) The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode.
CreateDomainRequest	withAuthMode(AuthMode authMode) The mode of authentication that members use to access the domain.
CreateDomainRequest	withAuthMode(String authMode) The mode of authentication that members use to access the domain.
CreateDomainRequest	withDefaultSpaceSettings(DefaultSpaceSettings defaultSpaceSettings) The default settings used to create a space.
CreateDomainRequest	withDefaultUserSettings(UserSettings defaultUserSettings) The default settings to use to create a user profile when UserSettings isn't specified in the call to the CreateUserProfile API.
CreateDomainRequest	withDomainName(String domainName) A name for the domain.
CreateDomainRequest	withDomainSettings(DomainSettings domainSettings) A collection of Domain settings.
CreateDomainRequest	withHomeEfsFileSystemKmsKeyId(String homeEfsFileSystemKmsKeyId) Deprecated.
CreateDomainRequest	withKmsKeyId(String kmsKeyId) SageMaker uses Amazon Web Services KMS to encrypt EFS and EBS volumes attached to the domain with an Amazon Web Services managed key by default.
CreateDomainRequest	withSubnetIds(Collection<String> subnetIds) The VPC subnets that the domain uses for communication.
CreateDomainRequest	withSubnetIds(String... subnetIds) The VPC subnets that the domain uses for communication.
CreateDomainRequest	withTags(Collection<Tag> tags) Tags to associated with the Domain.
CreateDomainRequest	withTags(Tag... tags) Tags to associated with the Domain.
CreateDomainRequest	withVpcId(String vpcId) The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateDomainRequest

public CreateDomainRequest()

Method Detail

setDomainName

public void setDomainName(String domainName)

A name for the domain.

Parameters:

domainName - A name for the domain.

getDomainName

public String getDomainName()

A name for the domain.

Returns:

A name for the domain.

withDomainName

public CreateDomainRequest withDomainName(String domainName)

A name for the domain.

Parameters:

domainName - A name for the domain.

Returns:

Returns a reference to this object so that method calls can be chained together.

setAuthMode

public void setAuthMode(String authMode)

The mode of authentication that members use to access the domain.

Parameters:

authMode - The mode of authentication that members use to access the domain.

See Also:

AuthMode

getAuthMode

public String getAuthMode()

The mode of authentication that members use to access the domain.

Returns:

The mode of authentication that members use to access the domain.

See Also:

AuthMode

withAuthMode

public CreateDomainRequest withAuthMode(String authMode)

The mode of authentication that members use to access the domain.

Parameters:

authMode - The mode of authentication that members use to access the domain.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AuthMode

withAuthMode

public CreateDomainRequest withAuthMode(AuthMode authMode)

The mode of authentication that members use to access the domain.

Parameters:

authMode - The mode of authentication that members use to access the domain.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AuthMode

setDefaultUserSettings

public void setDefaultUserSettings(UserSettings defaultUserSettings)

The default settings to use to create a user profile when UserSettings isn't specified in the call to the CreateUserProfile API.

SecurityGroups is aggregated when specified in both calls. For all other settings in UserSettings, the values specified in CreateUserProfile take precedence over those specified in CreateDomain.

Parameters:

defaultUserSettings - The default settings to use to create a user profile when UserSettings isn't specified in the call to the CreateUserProfile API.

SecurityGroups is aggregated when specified in both calls. For all other settings in UserSettings, the values specified in CreateUserProfile take precedence over those specified in CreateDomain.

getDefaultUserSettings

public UserSettings getDefaultUserSettings()

The default settings to use to create a user profile when UserSettings isn't specified in the call to the CreateUserProfile API.

SecurityGroups is aggregated when specified in both calls. For all other settings in UserSettings, the values specified in CreateUserProfile take precedence over those specified in CreateDomain.

Returns:

The default settings to use to create a user profile when UserSettings isn't specified in the call to the CreateUserProfile API.

SecurityGroups is aggregated when specified in both calls. For all other settings in UserSettings, the values specified in CreateUserProfile take precedence over those specified in CreateDomain.

withDefaultUserSettings

public CreateDomainRequest withDefaultUserSettings(UserSettings defaultUserSettings)

The default settings to use to create a user profile when UserSettings isn't specified in the call to the CreateUserProfile API.

SecurityGroups is aggregated when specified in both calls. For all other settings in UserSettings, the values specified in CreateUserProfile take precedence over those specified in CreateDomain.

Parameters:

defaultUserSettings - The default settings to use to create a user profile when UserSettings isn't specified in the call to the CreateUserProfile API.

SecurityGroups is aggregated when specified in both calls. For all other settings in UserSettings, the values specified in CreateUserProfile take precedence over those specified in CreateDomain.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDomainSettings

public void setDomainSettings(DomainSettings domainSettings)

A collection of Domain settings.

Parameters:

domainSettings - A collection of Domain settings.

getDomainSettings

public DomainSettings getDomainSettings()

A collection of Domain settings.

Returns:

A collection of Domain settings.

withDomainSettings

public CreateDomainRequest withDomainSettings(DomainSettings domainSettings)

A collection of Domain settings.

Parameters:

domainSettings - A collection of Domain settings.

Returns:

Returns a reference to this object so that method calls can be chained together.

getSubnetIds

public List<String> getSubnetIds()

The VPC subnets that the domain uses for communication.

Returns:

The VPC subnets that the domain uses for communication.

setSubnetIds

public void setSubnetIds(Collection<String> subnetIds)

The VPC subnets that the domain uses for communication.

Parameters:

subnetIds - The VPC subnets that the domain uses for communication.

withSubnetIds

public CreateDomainRequest withSubnetIds(String... subnetIds)

The VPC subnets that the domain uses for communication.

NOTE: This method appends the values to the existing list (if any). Use setSubnetIds(java.util.Collection) or withSubnetIds(java.util.Collection) if you want to override the existing values.

Parameters:

subnetIds - The VPC subnets that the domain uses for communication.

Returns:

Returns a reference to this object so that method calls can be chained together.

withSubnetIds

public CreateDomainRequest withSubnetIds(Collection<String> subnetIds)

The VPC subnets that the domain uses for communication.

Parameters:

subnetIds - The VPC subnets that the domain uses for communication.

Returns:

Returns a reference to this object so that method calls can be chained together.

setVpcId

public void setVpcId(String vpcId)

The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.

Parameters:

vpcId - The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.

getVpcId

public String getVpcId()

The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.

Returns:

The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.

withVpcId

public CreateDomainRequest withVpcId(String vpcId)

The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.

Parameters:

vpcId - The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.

Returns:

Returns a reference to this object so that method calls can be chained together.

getTags

public List<Tag> getTags()

Tags to associated with the Domain. Each tag consists of a key and an optional value. Tag keys must be unique per resource. Tags are searchable using the Search API.

Tags that you specify for the Domain are also added to all Apps that the Domain launches.

Returns:

Tags to associated with the Domain. Each tag consists of a key and an optional value. Tag keys must be unique per resource. Tags are searchable using the Search API.

Tags that you specify for the Domain are also added to all Apps that the Domain launches.

setTags

public void setTags(Collection<Tag> tags)

Tags to associated with the Domain. Each tag consists of a key and an optional value. Tag keys must be unique per resource. Tags are searchable using the Search API.

Tags that you specify for the Domain are also added to all Apps that the Domain launches.

Parameters:

tags - Tags to associated with the Domain. Each tag consists of a key and an optional value. Tag keys must be unique per resource. Tags are searchable using the Search API.

Tags that you specify for the Domain are also added to all Apps that the Domain launches.

withTags

public CreateDomainRequest withTags(Tag... tags)

Tags to associated with the Domain. Each tag consists of a key and an optional value. Tag keys must be unique per resource. Tags are searchable using the Search API.

Tags that you specify for the Domain are also added to all Apps that the Domain launches.

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

Parameters:

tags - Tags to associated with the Domain. Each tag consists of a key and an optional value. Tag keys must be unique per resource. Tags are searchable using the Search API.

Tags that you specify for the Domain are also added to all Apps that the Domain launches.

Returns:

Returns a reference to this object so that method calls can be chained together.

withTags

public CreateDomainRequest withTags(Collection<Tag> tags)

Tags to associated with the Domain. Each tag consists of a key and an optional value. Tag keys must be unique per resource. Tags are searchable using the Search API.

Tags that you specify for the Domain are also added to all Apps that the Domain launches.

Parameters:

tags - Tags to associated with the Domain. Each tag consists of a key and an optional value. Tag keys must be unique per resource. Tags are searchable using the Search API.

Tags that you specify for the Domain are also added to all Apps that the Domain launches.

Returns:

Returns a reference to this object so that method calls can be chained together.

setAppNetworkAccessType

public void setAppNetworkAccessType(String appNetworkAccessType)

Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly.

• PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker, which allows direct internet access

• VpcOnly - All traffic is through the specified VPC and subnets

Parameters:

appNetworkAccessType - Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly.

• PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker, which allows direct internet access

• VpcOnly - All traffic is through the specified VPC and subnets

See Also:

AppNetworkAccessType

getAppNetworkAccessType

public String getAppNetworkAccessType()

Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly.

• PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker, which allows direct internet access

• VpcOnly - All traffic is through the specified VPC and subnets

Returns:

Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly.

• PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker, which allows direct internet access

• VpcOnly - All traffic is through the specified VPC and subnets

See Also:

AppNetworkAccessType

withAppNetworkAccessType

public CreateDomainRequest withAppNetworkAccessType(String appNetworkAccessType)

Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly.

• PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker, which allows direct internet access

• VpcOnly - All traffic is through the specified VPC and subnets

Parameters:

appNetworkAccessType - Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly.

• PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker, which allows direct internet access

• VpcOnly - All traffic is through the specified VPC and subnets

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AppNetworkAccessType

withAppNetworkAccessType

public CreateDomainRequest withAppNetworkAccessType(AppNetworkAccessType appNetworkAccessType)

Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly.

• PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker, which allows direct internet access

• VpcOnly - All traffic is through the specified VPC and subnets

Parameters:

appNetworkAccessType - Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly.

• PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker, which allows direct internet access

• VpcOnly - All traffic is through the specified VPC and subnets

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AppNetworkAccessType

setHomeEfsFileSystemKmsKeyId

@Deprecated
public void setHomeEfsFileSystemKmsKeyId(String homeEfsFileSystemKmsKeyId)

Deprecated.

Use KmsKeyId.

Parameters:

homeEfsFileSystemKmsKeyId - Use KmsKeyId.

getHomeEfsFileSystemKmsKeyId

@Deprecated
public String getHomeEfsFileSystemKmsKeyId()

Deprecated.

Use KmsKeyId.

Returns:

Use KmsKeyId.

withHomeEfsFileSystemKmsKeyId

@Deprecated
public CreateDomainRequest withHomeEfsFileSystemKmsKeyId(String homeEfsFileSystemKmsKeyId)

Deprecated.

Use KmsKeyId.

Parameters:

homeEfsFileSystemKmsKeyId - Use KmsKeyId.

Returns:

Returns a reference to this object so that method calls can be chained together.

setKmsKeyId

public void setKmsKeyId(String kmsKeyId)

SageMaker uses Amazon Web Services KMS to encrypt EFS and EBS volumes attached to the domain with an Amazon Web Services managed key by default. For more control, specify a customer managed key.

Parameters:

kmsKeyId - SageMaker uses Amazon Web Services KMS to encrypt EFS and EBS volumes attached to the domain with an Amazon Web Services managed key by default. For more control, specify a customer managed key.

getKmsKeyId

public String getKmsKeyId()

SageMaker uses Amazon Web Services KMS to encrypt EFS and EBS volumes attached to the domain with an Amazon Web Services managed key by default. For more control, specify a customer managed key.

Returns:

SageMaker uses Amazon Web Services KMS to encrypt EFS and EBS volumes attached to the domain with an Amazon Web Services managed key by default. For more control, specify a customer managed key.

withKmsKeyId

public CreateDomainRequest withKmsKeyId(String kmsKeyId)

SageMaker uses Amazon Web Services KMS to encrypt EFS and EBS volumes attached to the domain with an Amazon Web Services managed key by default. For more control, specify a customer managed key.

Parameters:

kmsKeyId - SageMaker uses Amazon Web Services KMS to encrypt EFS and EBS volumes attached to the domain with an Amazon Web Services managed key by default. For more control, specify a customer managed key.

Returns:

Returns a reference to this object so that method calls can be chained together.

setAppSecurityGroupManagement

public void setAppSecurityGroupManagement(String appSecurityGroupManagement)

The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode. Required when CreateDomain.AppNetworkAccessType is VPCOnly and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided. If setting up the domain for use with RStudio, this value must be set to Service.

Parameters:

appSecurityGroupManagement - The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode. Required when CreateDomain.AppNetworkAccessType is VPCOnly and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided. If setting up the domain for use with RStudio, this value must be set to Service .

See Also:

AppSecurityGroupManagement

getAppSecurityGroupManagement

public String getAppSecurityGroupManagement()

The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode. Required when CreateDomain.AppNetworkAccessType is VPCOnly and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided. If setting up the domain for use with RStudio, this value must be set to Service.

Returns:

The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode. Required when CreateDomain.AppNetworkAccessType is VPCOnly and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided. If setting up the domain for use with RStudio, this value must be set to Service.

See Also:

AppSecurityGroupManagement

withAppSecurityGroupManagement

public CreateDomainRequest withAppSecurityGroupManagement(String appSecurityGroupManagement)

The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode. Required when CreateDomain.AppNetworkAccessType is VPCOnly and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided. If setting up the domain for use with RStudio, this value must be set to Service.

Parameters:

appSecurityGroupManagement - The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode. Required when CreateDomain.AppNetworkAccessType is VPCOnly and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided. If setting up the domain for use with RStudio, this value must be set to Service .

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AppSecurityGroupManagement

withAppSecurityGroupManagement

public CreateDomainRequest withAppSecurityGroupManagement(AppSecurityGroupManagement appSecurityGroupManagement)

The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode. Required when CreateDomain.AppNetworkAccessType is VPCOnly and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided. If setting up the domain for use with RStudio, this value must be set to Service.

Parameters:

appSecurityGroupManagement - The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode. Required when CreateDomain.AppNetworkAccessType is VPCOnly and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided. If setting up the domain for use with RStudio, this value must be set to Service .

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AppSecurityGroupManagement

setDefaultSpaceSettings

public void setDefaultSpaceSettings(DefaultSpaceSettings defaultSpaceSettings)

The default settings used to create a space.

Parameters:

defaultSpaceSettings - The default settings used to create a space.

getDefaultSpaceSettings

public DefaultSpaceSettings getDefaultSpaceSettings()

The default settings used to create a space.

Returns:

The default settings used to create a space.

withDefaultSpaceSettings

public CreateDomainRequest withDefaultSpaceSettings(DefaultSpaceSettings defaultSpaceSettings)

The default settings used to create a space.

Parameters:

defaultSpaceSettings - The default settings used to create a space.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateDomainRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()