Package software.amazon.awssdk.services.sagemaker.model

Class DescribeDomainResponse

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

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

      • singleSignOnApplicationArn

        public final String singleSignOnApplicationArn()

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

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

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

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

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

      • domainSettings

        public final DomainSettings domainSettings()

        A collection of Domain settings.

        Returns:
        A collection of Domain settings.

      • 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 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 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 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 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 the domain 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 the domain 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 the domain uses for communication.

        Returns:
        The ID of the Amazon Virtual Private Cloud (VPC) that the domain 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.

      • 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

      • tagPropagation

        public final TagPropagation tagPropagation()

        Indicates whether custom tag propagation is supported for the domain.

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

        Returns:
        Indicates whether custom tag propagation is supported for the domain.
        See Also:
        TagPropagation

      • tagPropagationAsString

        public final String tagPropagationAsString()

        Indicates whether custom tag propagation is supported for the domain.

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

        Returns:
        Indicates whether custom tag propagation is supported for the domain.
        See Also:
        TagPropagation

      • defaultSpaceSettings

        public final DefaultSpaceSettings defaultSpaceSettings()

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

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

      • 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