DomainSettings (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.sagemaker.model.DomainSettings

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DomainSettings
extends Object
implements Serializable, Cloneable, StructuredPojo
```
A collection of settings that apply to the SageMaker Domain. These settings are specified through the CreateDomain API call.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DomainSettings()

Constructors
Constructor and Description
`DomainSettings()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DomainSettings`	`clone()`
`boolean`	`equals(Object obj)`
`AmazonQSettings`	`getAmazonQSettings()` A collection of settings that configure the Amazon Q experience within the domain.
`DockerSettings`	`getDockerSettings()` A collection of settings that configure the domain's Docker interaction.
`String`	`getExecutionRoleIdentityConfig()` The configuration for attaching a SageMaker user profile name to the execution role as a sts:SourceIdentity key.
`RStudioServerProDomainSettings`	`getRStudioServerProDomainSettings()` A collection of settings that configure the `RStudioServerPro` Domain-level app.
`List<String>`	`getSecurityGroupIds()` The security groups for the Amazon Virtual Private Cloud that the `Domain` uses for communication between Domain-level apps and user apps.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAmazonQSettings(AmazonQSettings amazonQSettings)` A collection of settings that configure the Amazon Q experience within the domain.
`void`	`setDockerSettings(DockerSettings dockerSettings)` A collection of settings that configure the domain's Docker interaction.
`void`	`setExecutionRoleIdentityConfig(String executionRoleIdentityConfig)` The configuration for attaching a SageMaker user profile name to the execution role as a sts:SourceIdentity key.
`void`	`setRStudioServerProDomainSettings(RStudioServerProDomainSettings rStudioServerProDomainSettings)` A collection of settings that configure the `RStudioServerPro` Domain-level app.
`void`	`setSecurityGroupIds(Collection<String> securityGroupIds)` The security groups for the Amazon Virtual Private Cloud that the `Domain` uses for communication between Domain-level apps and user apps.
`String`	`toString()` Returns a string representation of this object.
`DomainSettings`	`withAmazonQSettings(AmazonQSettings amazonQSettings)` A collection of settings that configure the Amazon Q experience within the domain.
`DomainSettings`	`withDockerSettings(DockerSettings dockerSettings)` A collection of settings that configure the domain's Docker interaction.
`DomainSettings`	`withExecutionRoleIdentityConfig(ExecutionRoleIdentityConfig executionRoleIdentityConfig)` The configuration for attaching a SageMaker user profile name to the execution role as a sts:SourceIdentity key.
`DomainSettings`	`withExecutionRoleIdentityConfig(String executionRoleIdentityConfig)` The configuration for attaching a SageMaker user profile name to the execution role as a sts:SourceIdentity key.
`DomainSettings`	`withRStudioServerProDomainSettings(RStudioServerProDomainSettings rStudioServerProDomainSettings)` A collection of settings that configure the `RStudioServerPro` Domain-level app.
`DomainSettings`	`withSecurityGroupIds(Collection<String> securityGroupIds)` The security groups for the Amazon Virtual Private Cloud that the `Domain` uses for communication between Domain-level apps and user apps.
`DomainSettings`	`withSecurityGroupIds(String... securityGroupIds)` The security groups for the Amazon Virtual Private Cloud that the `Domain` uses for communication between Domain-level apps and user apps.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DomainSettings
```
public DomainSettings()
```
- Method Detail
  - getSecurityGroupIds
```
public List<String> getSecurityGroupIds()
```
    The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.
    
    Returns:
    
    The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.
  - setSecurityGroupIds
```
public void setSecurityGroupIds(Collection<String> securityGroupIds)
```
    The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.
    
    Parameters:
    
    securityGroupIds - The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.
  - withSecurityGroupIds
```
public DomainSettings withSecurityGroupIds(String... securityGroupIds)
```
    The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.
    
    NOTE: This method appends the values to the existing list (if any). Use setSecurityGroupIds(java.util.Collection) or withSecurityGroupIds(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    securityGroupIds - The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withSecurityGroupIds
```
public DomainSettings withSecurityGroupIds(Collection<String> securityGroupIds)
```
    The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.
    
    Parameters:
    
    securityGroupIds - The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRStudioServerProDomainSettings
```
public void setRStudioServerProDomainSettings(RStudioServerProDomainSettings rStudioServerProDomainSettings)
```
    A collection of settings that configure the RStudioServerPro Domain-level app.
    
    Parameters:
    
    rStudioServerProDomainSettings - A collection of settings that configure the RStudioServerPro Domain-level app.
  - getRStudioServerProDomainSettings
```
public RStudioServerProDomainSettings getRStudioServerProDomainSettings()
```
    A collection of settings that configure the RStudioServerPro Domain-level app.
    
    Returns:
    
    A collection of settings that configure the RStudioServerPro Domain-level app.
  - withRStudioServerProDomainSettings
```
public DomainSettings withRStudioServerProDomainSettings(RStudioServerProDomainSettings rStudioServerProDomainSettings)
```
    A collection of settings that configure the RStudioServerPro Domain-level app.
    
    Parameters:
    
    rStudioServerProDomainSettings - A collection of settings that configure the RStudioServerPro Domain-level app.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setExecutionRoleIdentityConfig
```
public void setExecutionRoleIdentityConfig(String executionRoleIdentityConfig)
```
    The configuration for attaching a SageMaker user profile name to the execution role as a sts:SourceIdentity key.
    
    Parameters:
    
    executionRoleIdentityConfig - The configuration for attaching a SageMaker user profile name to the execution role as a sts:SourceIdentity key.
    
    See Also:
    
    ExecutionRoleIdentityConfig
  - getExecutionRoleIdentityConfig
```
public String getExecutionRoleIdentityConfig()
```
    The configuration for attaching a SageMaker user profile name to the execution role as a sts:SourceIdentity key.
    
    Returns:
    
    The configuration for attaching a SageMaker user profile name to the execution role as a sts:SourceIdentity key.
    
    See Also:
    
    ExecutionRoleIdentityConfig
  - withExecutionRoleIdentityConfig
```
public DomainSettings withExecutionRoleIdentityConfig(String executionRoleIdentityConfig)
```
    The configuration for attaching a SageMaker user profile name to the execution role as a sts:SourceIdentity key.
    
    Parameters:
    
    executionRoleIdentityConfig - The configuration for attaching a SageMaker user profile name to the execution role as a sts:SourceIdentity key.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ExecutionRoleIdentityConfig
  - withExecutionRoleIdentityConfig
```
public DomainSettings withExecutionRoleIdentityConfig(ExecutionRoleIdentityConfig executionRoleIdentityConfig)
```
    The configuration for attaching a SageMaker user profile name to the execution role as a sts:SourceIdentity key.
    
    Parameters:
    
    executionRoleIdentityConfig - The configuration for attaching a SageMaker user profile name to the execution role as a sts:SourceIdentity key.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ExecutionRoleIdentityConfig
  - setDockerSettings
```
public void setDockerSettings(DockerSettings dockerSettings)
```
    A collection of settings that configure the domain's Docker interaction.
    
    Parameters:
    
    dockerSettings - A collection of settings that configure the domain's Docker interaction.
  - getDockerSettings
```
public DockerSettings getDockerSettings()
```
    A collection of settings that configure the domain's Docker interaction.
    
    Returns:
    
    A collection of settings that configure the domain's Docker interaction.
  - withDockerSettings
```
public DomainSettings withDockerSettings(DockerSettings dockerSettings)
```
    A collection of settings that configure the domain's Docker interaction.
    
    Parameters:
    
    dockerSettings - A collection of settings that configure the domain's Docker interaction.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAmazonQSettings
```
public void setAmazonQSettings(AmazonQSettings amazonQSettings)
```
    A collection of settings that configure the Amazon Q experience within the domain. The AuthMode that you use to create the domain must be SSO.
    
    Parameters:
    
    amazonQSettings - A collection of settings that configure the Amazon Q experience within the domain. The AuthMode that you use to create the domain must be SSO.
  - getAmazonQSettings
```
public AmazonQSettings getAmazonQSettings()
```
    A collection of settings that configure the Amazon Q experience within the domain. The AuthMode that you use to create the domain must be SSO.
    
    Returns:
    
    A collection of settings that configure the Amazon Q experience within the domain. The AuthMode that you use to create the domain must be SSO.
  - withAmazonQSettings
```
public DomainSettings withAmazonQSettings(AmazonQSettings amazonQSettings)
```
    A collection of settings that configure the Amazon Q experience within the domain. The AuthMode that you use to create the domain must be SSO.
    
    Parameters:
    
    amazonQSettings - A collection of settings that configure the Amazon Q experience within the domain. The AuthMode that you use to create the domain must be SSO.
    
    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 DomainSettings clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.792

Class DomainSettings

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DomainSettings

Method Detail

getSecurityGroupIds

setSecurityGroupIds

withSecurityGroupIds

withSecurityGroupIds

setRStudioServerProDomainSettings

getRStudioServerProDomainSettings

withRStudioServerProDomainSettings

setExecutionRoleIdentityConfig

getExecutionRoleIdentityConfig

withExecutionRoleIdentityConfig

withExecutionRoleIdentityConfig

setDockerSettings

getDockerSettings

withDockerSettings

setAmazonQSettings

getAmazonQSettings

withAmazonQSettings

toString

equals

hashCode

clone

marshall