Interface DescribeDomainResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<DescribeDomainResponse.Builder,DescribeDomainResponse>, SageMakerResponse.Builder, SdkBuilder<DescribeDomainResponse.Builder,DescribeDomainResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
DescribeDomainResponse
@Mutable @NotThreadSafe public static interface DescribeDomainResponse.Builder extends SageMakerResponse.Builder, SdkPojo, CopyableBuilder<DescribeDomainResponse.Builder,DescribeDomainResponse>

  • Method Details

    • 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 managed by this Domain.

      Parameters:
      homeEfsFileSystemId - The ID of the Amazon Elastic File System 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.

    • singleSignOnApplicationArn

      DescribeDomainResponse.Builder singleSignOnApplicationArn(String singleSignOnApplicationArn)

      The ARN of the application managed by SageMaker AI in IAM Identity Center. This value is only returned for domains created after October 1, 2023.

      Parameters:
      singleSignOnApplicationArn - The ARN of the application managed by SageMaker AI in IAM Identity Center. This value is only returned for domains created after October 1, 2023.
      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:

    • 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:

    • 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.

    • 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.

    • 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

      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:

    • 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:

    • 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:

    • 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 AI, 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 AI, 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

      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 AI, 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 AI, 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:

    • 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 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.

    • subnetIds

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

    • 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 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.

    • 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.

    • 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

      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:

    • tagPropagation

      DescribeDomainResponse.Builder tagPropagation(String tagPropagation)

      Indicates whether custom tag propagation is supported for the domain.

      Parameters:
      tagPropagation - Indicates whether custom tag propagation is supported for the domain.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tagPropagation

      DescribeDomainResponse.Builder tagPropagation(TagPropagation tagPropagation)

      Indicates whether custom tag propagation is supported for the domain.

      Parameters:
      tagPropagation - Indicates whether custom tag propagation is supported for the domain.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • defaultSpaceSettings

      DescribeDomainResponse.Builder defaultSpaceSettings(DefaultSpaceSettings defaultSpaceSettings)

      The default settings for shared spaces that users create in the domain.

      Parameters:
      defaultSpaceSettings - The default settings for shared spaces that users create in the domain.
      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 for shared spaces that users create in the domain.

      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: