software.amazon.awssdk.services.sagemaker.model

Interface DescribeDomainResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<DescribeDomainResponse.Builder,DescribeDomainResponse>, SageMakerResponse.Builder, SdkBuilder<DescribeDomainResponse.Builder,DescribeDomainResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

DescribeDomainResponse

public static interface DescribeDomainResponse.Builder
extends SageMakerResponse.Builder, SdkPojo, CopyableBuilder<DescribeDomainResponse.Builder,DescribeDomainResponse>

Method Summary

Modifier and Type	Method and Description
DescribeDomainResponse.Builder	appNetworkAccessType(AppNetworkAccessType appNetworkAccessType) Specifies the VPC used for non-EFS traffic.
DescribeDomainResponse.Builder	appNetworkAccessType(String appNetworkAccessType) Specifies the VPC used for non-EFS traffic.
DescribeDomainResponse.Builder	appSecurityGroupManagement(AppSecurityGroupManagement appSecurityGroupManagement) The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode.
DescribeDomainResponse.Builder	appSecurityGroupManagement(String appSecurityGroupManagement) The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode.
DescribeDomainResponse.Builder	authMode(AuthMode authMode) The domain's authentication mode.
DescribeDomainResponse.Builder	authMode(String authMode) The domain's authentication mode.
DescribeDomainResponse.Builder	creationTime(Instant creationTime) The creation time.
default DescribeDomainResponse.Builder	defaultSpaceSettings(Consumer<DefaultSpaceSettings.Builder> defaultSpaceSettings) The default settings used to create a space.
DescribeDomainResponse.Builder	defaultSpaceSettings(DefaultSpaceSettings defaultSpaceSettings) The default settings used to create a space.
default DescribeDomainResponse.Builder	defaultUserSettings(Consumer<UserSettings.Builder> defaultUserSettings) Settings which are applied to UserProfiles in this domain if settings are not explicitly specified in a given UserProfile.
DescribeDomainResponse.Builder	defaultUserSettings(UserSettings defaultUserSettings) Settings which are applied to UserProfiles in this domain if settings are not explicitly specified in a given UserProfile.
DescribeDomainResponse.Builder	domainArn(String domainArn) The domain's Amazon Resource Name (ARN).
DescribeDomainResponse.Builder	domainId(String domainId) The domain ID.
DescribeDomainResponse.Builder	domainName(String domainName) The domain name.
default DescribeDomainResponse.Builder	domainSettings(Consumer<DomainSettings.Builder> domainSettings) A collection of Domain settings.
DescribeDomainResponse.Builder	domainSettings(DomainSettings domainSettings) A collection of Domain settings.
DescribeDomainResponse.Builder	failureReason(String failureReason) The failure reason.
DescribeDomainResponse.Builder	homeEfsFileSystemId(String homeEfsFileSystemId) The ID of the Amazon Elastic File System (EFS) managed by this Domain.
DescribeDomainResponse.Builder	homeEfsFileSystemKmsKeyId(String homeEfsFileSystemKmsKeyId) Deprecated. This property is deprecated, use KmsKeyId instead.
DescribeDomainResponse.Builder	kmsKeyId(String kmsKeyId) The Amazon Web Services KMS customer managed key used to encrypt the EFS volume attached to the domain.
DescribeDomainResponse.Builder	lastModifiedTime(Instant lastModifiedTime) The last modified time.
DescribeDomainResponse.Builder	securityGroupIdForDomainBoundary(String securityGroupIdForDomainBoundary) The ID of the security group that authorizes traffic between the RSessionGateway apps and the RStudioServerPro app.
DescribeDomainResponse.Builder	singleSignOnManagedApplicationInstanceId(String singleSignOnManagedApplicationInstanceId) The IAM Identity Center managed application instance ID.
DescribeDomainResponse.Builder	status(DomainStatus status) The status.
DescribeDomainResponse.Builder	status(String status) The status.
DescribeDomainResponse.Builder	subnetIds(Collection<String> subnetIds) The VPC subnets that Studio uses for communication.
DescribeDomainResponse.Builder	subnetIds(String... subnetIds) The VPC subnets that Studio uses for communication.
DescribeDomainResponse.Builder	url(String url) The domain's URL.
DescribeDomainResponse.Builder	vpcId(String vpcId) The ID of the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.

Methods inherited from interface software.amazon.awssdk.services.sagemaker.model.SageMakerResponse.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

domainArn

DescribeDomainResponse.Builder domainArn(String domainArn)

The domain's Amazon Resource Name (ARN).

Parameters:

domainArn - The domain's Amazon Resource Name (ARN).

Returns:

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

domainId

DescribeDomainResponse.Builder domainId(String domainId)

The domain ID.

Parameters:

domainId - The domain ID.

Returns:

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

domainName

DescribeDomainResponse.Builder domainName(String domainName)

The domain name.

Parameters:

domainName - The domain name.

Returns:

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

homeEfsFileSystemId

DescribeDomainResponse.Builder homeEfsFileSystemId(String homeEfsFileSystemId)

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

Parameters:

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

Returns:

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

singleSignOnManagedApplicationInstanceId

DescribeDomainResponse.Builder singleSignOnManagedApplicationInstanceId(String singleSignOnManagedApplicationInstanceId)

The IAM Identity Center managed application instance ID.

Parameters:

singleSignOnManagedApplicationInstanceId - The IAM Identity Center managed application instance ID.

Returns:

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

status

DescribeDomainResponse.Builder status(String status)

The status.

Parameters:

status - The status.

Returns:

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

See Also:

DomainStatus, DomainStatus

status

DescribeDomainResponse.Builder status(DomainStatus status)

The status.

Parameters:

status - The status.

Returns:

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

See Also:

DomainStatus, DomainStatus

creationTime

DescribeDomainResponse.Builder creationTime(Instant creationTime)

The creation time.

Parameters:

creationTime - The creation time.

Returns:

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

lastModifiedTime

DescribeDomainResponse.Builder lastModifiedTime(Instant lastModifiedTime)

The last modified time.

Parameters:

lastModifiedTime - The last modified time.

Returns:

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

failureReason

DescribeDomainResponse.Builder failureReason(String failureReason)

The failure reason.

Parameters:

failureReason - The failure reason.

Returns:

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

authMode

DescribeDomainResponse.Builder authMode(String authMode)

The domain's authentication mode.

Parameters:

authMode - The domain's authentication mode.

Returns:

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

See Also:

AuthMode, AuthMode

authMode

DescribeDomainResponse.Builder authMode(AuthMode authMode)

The domain's authentication mode.

Parameters:

authMode - The domain's authentication mode.

Returns:

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

See Also:

AuthMode, AuthMode

defaultUserSettings

DescribeDomainResponse.Builder defaultUserSettings(UserSettings defaultUserSettings)

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

Parameters:

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

Returns:

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

defaultUserSettings

default DescribeDomainResponse.Builder defaultUserSettings(Consumer<UserSettings.Builder> defaultUserSettings)

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

This is a convenience method that creates an instance of the UserSettings.Builder avoiding the need to create one manually via UserSettings.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to defaultUserSettings(UserSettings).

Parameters:

defaultUserSettings - a consumer that will call methods on UserSettings.Builder

Returns:

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

See Also:

defaultUserSettings(UserSettings)

appNetworkAccessType

DescribeDomainResponse.Builder appNetworkAccessType(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 Studio 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 Studio 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, AppNetworkAccessType

appNetworkAccessType

DescribeDomainResponse.Builder appNetworkAccessType(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

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 Studio 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, AppNetworkAccessType

homeEfsFileSystemKmsKeyId

@Deprecated
DescribeDomainResponse.Builder homeEfsFileSystemKmsKeyId(String homeEfsFileSystemKmsKeyId)

Deprecated. This property is deprecated, use KmsKeyId instead.

Use KmsKeyId.

Parameters:

homeEfsFileSystemKmsKeyId - Use KmsKeyId.

Returns:

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

subnetIds

DescribeDomainResponse.Builder subnetIds(Collection<String> subnetIds)

The VPC subnets that Studio uses for communication.

Parameters:

subnetIds - The VPC subnets that Studio uses for communication.

Returns:

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

subnetIds

DescribeDomainResponse.Builder subnetIds(String... subnetIds)

The VPC subnets that Studio uses for communication.

Parameters:

subnetIds - The VPC subnets that Studio uses for communication.

Returns:

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

url

DescribeDomainResponse.Builder url(String url)

The domain's URL.

Parameters:

url - The domain's URL.

Returns:

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

vpcId

DescribeDomainResponse.Builder vpcId(String vpcId)

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

Parameters:

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

Returns:

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

kmsKeyId

DescribeDomainResponse.Builder kmsKeyId(String kmsKeyId)

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

Parameters:

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

Returns:

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

domainSettings

DescribeDomainResponse.Builder domainSettings(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.

domainSettings

default DescribeDomainResponse.Builder domainSettings(Consumer<DomainSettings.Builder> domainSettings)

A collection of Domain settings.

This is a convenience method that creates an instance of the DomainSettings.Builder avoiding the need to create one manually via DomainSettings.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to domainSettings(DomainSettings).

Parameters:

domainSettings - a consumer that will call methods on DomainSettings.Builder

Returns:

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

See Also:

domainSettings(DomainSettings)

appSecurityGroupManagement

DescribeDomainResponse.Builder appSecurityGroupManagement(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.

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.

Returns:

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

See Also:

AppSecurityGroupManagement, AppSecurityGroupManagement

appSecurityGroupManagement

DescribeDomainResponse.Builder appSecurityGroupManagement(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.

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.

Returns:

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

See Also:

AppSecurityGroupManagement, AppSecurityGroupManagement

securityGroupIdForDomainBoundary

DescribeDomainResponse.Builder securityGroupIdForDomainBoundary(String securityGroupIdForDomainBoundary)

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

Parameters:

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

Returns:

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

defaultSpaceSettings

DescribeDomainResponse.Builder defaultSpaceSettings(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.

defaultSpaceSettings

default DescribeDomainResponse.Builder defaultSpaceSettings(Consumer<DefaultSpaceSettings.Builder> defaultSpaceSettings)

The default settings used to create a space.

This is a convenience method that creates an instance of the DefaultSpaceSettings.Builder avoiding the need to create one manually via DefaultSpaceSettings.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to defaultSpaceSettings(DefaultSpaceSettings).

Parameters:

defaultSpaceSettings - a consumer that will call methods on DefaultSpaceSettings.Builder

Returns:

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

See Also:

defaultSpaceSettings(DefaultSpaceSettings)