software.amazon.awssdk.services.sagemaker.model

Class DescribeDomainResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.sagemaker.model.SageMakerResponse

software.amazon.awssdk.services.sagemaker.model.DescribeDomainResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeDomainResponse.Builder,DescribeDomainResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeDomainResponse
extends SageMakerResponse
implements ToCopyableBuilder<DescribeDomainResponse.Builder,DescribeDomainResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeDomainResponse.Builder

Method Summary

Modifier and Type	Method and Description
AppNetworkAccessType	appNetworkAccessType() Specifies the VPC used for non-EFS traffic.
String	appNetworkAccessTypeAsString() Specifies the VPC used for non-EFS traffic.
AppSecurityGroupManagement	appSecurityGroupManagement() The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode.
String	appSecurityGroupManagementAsString() The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode.
AuthMode	authMode() The domain's authentication mode.
String	authModeAsString() The domain's authentication mode.
static DescribeDomainResponse.Builder	builder()
Instant	creationTime() The creation time.
UserSettings	defaultUserSettings() Settings which are applied to UserProfiles in this domain if settings are not explicitly specified in a given UserProfile.
String	domainArn() The domain's Amazon Resource Name (ARN).
String	domainId() The domain ID.
String	domainName() The domain name.
DomainSettings	domainSettings() A collection of Domain settings.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	failureReason() The failure reason.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSubnetIds() For responses, this returns true if the service returned a value for the SubnetIds property.
String	homeEfsFileSystemId() The ID of the Amazon Elastic File System (EFS) managed by this Domain.
String	homeEfsFileSystemKmsKeyId() Deprecated. This property is deprecated, use KmsKeyId instead.
String	kmsKeyId() The Amazon Web Services KMS customer managed key used to encrypt the EFS volume attached to the domain.
Instant	lastModifiedTime() The last modified time.
List<SdkField<?>>	sdkFields()
String	securityGroupIdForDomainBoundary() The ID of the security group that authorizes traffic between the RSessionGateway apps and the RStudioServerPro app.
static Class<? extends DescribeDomainResponse.Builder>	serializableBuilderClass()
String	singleSignOnManagedApplicationInstanceId() The IAM Identity Center managed application instance ID.
DomainStatus	status() The status.
String	statusAsString() The status.
List<String>	subnetIds() The VPC subnets that Studio uses for communication.
DescribeDomainResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	url() The domain's URL.
String	vpcId() The ID of the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.

Methods inherited from class software.amazon.awssdk.services.sagemaker.model.SageMakerResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

domainArn

public final String domainArn()

The domain's Amazon Resource Name (ARN).

Returns:

The domain's Amazon Resource Name (ARN).

domainId

public final String domainId()

The domain ID.

Returns:

The domain ID.

domainName

public final String domainName()

The domain name.

Returns:

The domain name.

homeEfsFileSystemId

public final String homeEfsFileSystemId()

The ID of the Amazon Elastic File System (EFS) managed by this Domain.

Returns:

The ID of the Amazon Elastic File System (EFS) managed by this Domain.

singleSignOnManagedApplicationInstanceId

public final String singleSignOnManagedApplicationInstanceId()

The IAM Identity Center managed application instance ID.

Returns:

The IAM Identity Center managed application instance ID.

status

public final DomainStatus status()

The status.

If the service returns an enum value that is not available in the current SDK version, status will return DomainStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The status.

See Also:

DomainStatus

statusAsString

public final String statusAsString()

The status.

If the service returns an enum value that is not available in the current SDK version, status will return DomainStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The status.

See Also:

DomainStatus

creationTime

public final Instant creationTime()

The creation time.

Returns:

The creation time.

lastModifiedTime

public final Instant lastModifiedTime()

The last modified time.

Returns:

The last modified time.

failureReason

public final String failureReason()

The failure reason.

Returns:

The failure reason.

authMode

public final AuthMode authMode()

The domain's authentication mode.

If the service returns an enum value that is not available in the current SDK version, authMode will return AuthMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authModeAsString().

Returns:

The domain's authentication mode.

See Also:

AuthMode

authModeAsString

public final String authModeAsString()

The domain's authentication mode.

If the service returns an enum value that is not available in the current SDK version, authMode will return AuthMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authModeAsString().

Returns:

The domain's authentication mode.

See Also:

AuthMode

defaultUserSettings

public final UserSettings defaultUserSettings()

Settings which are applied to UserProfiles in this domain if settings are not explicitly specified in a given UserProfile.

Returns:

Settings which are applied to UserProfiles in this domain if settings are not explicitly specified in a given UserProfile.

appNetworkAccessType

public final 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 Studio traffic is through the specified VPC and subnets

If the service returns an enum value that is not available in the current SDK version, appNetworkAccessType will return AppNetworkAccessType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from appNetworkAccessTypeAsString().

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 Studio traffic is through the specified VPC and subnets

See Also:

AppNetworkAccessType

appNetworkAccessTypeAsString

public final String appNetworkAccessTypeAsString()

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 Studio traffic is through the specified VPC and subnets

If the service returns an enum value that is not available in the current SDK version, appNetworkAccessType will return AppNetworkAccessType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from appNetworkAccessTypeAsString().

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 Studio traffic is through the specified VPC and subnets

See Also:

AppNetworkAccessType

homeEfsFileSystemKmsKeyId

@Deprecated
public final String homeEfsFileSystemKmsKeyId()

Deprecated. This property is deprecated, use KmsKeyId instead.

Use KmsKeyId.

Returns:

Use KmsKeyId.

hasSubnetIds

public final boolean hasSubnetIds()

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

subnetIds

public final List<String> subnetIds()

The VPC subnets that Studio uses for communication.

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

Returns:

The VPC subnets that Studio uses for communication.

url

public final String url()

The domain's URL.

Returns:

The domain's URL.

vpcId

public final String vpcId()

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

Returns:

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

kmsKeyId

public final String kmsKeyId()

The Amazon Web Services KMS customer managed key used to encrypt the EFS volume attached to the domain.

Returns:

The Amazon Web Services KMS customer managed key used to encrypt the EFS volume attached to the domain.

domainSettings

public final DomainSettings domainSettings()

A collection of Domain settings.

Returns:

A collection of Domain settings.

appSecurityGroupManagement

public final 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 the service returns an enum value that is not available in the current SDK version, appSecurityGroupManagement will return AppSecurityGroupManagement.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from appSecurityGroupManagementAsString().

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.

See Also:

AppSecurityGroupManagement

appSecurityGroupManagementAsString

public final String appSecurityGroupManagementAsString()

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 the service returns an enum value that is not available in the current SDK version, appSecurityGroupManagement will return AppSecurityGroupManagement.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from appSecurityGroupManagementAsString().

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.

See Also:

AppSecurityGroupManagement

securityGroupIdForDomainBoundary

public final String securityGroupIdForDomainBoundary()

The ID of the security group that authorizes traffic between the RSessionGateway apps and the RStudioServerPro app.

Returns:

The ID of the security group that authorizes traffic between the RSessionGateway apps and the RStudioServerPro app.

toBuilder

public DescribeDomainResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeDomainResponse.Builder,DescribeDomainResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static DescribeDomainResponse.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeDomainResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo