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("software.amazon.awssdk:codegen") public final class DescribeDomainResponse extends SageMakerResponse implements ToCopyableBuilder<DescribeDomainResponse.Builder,DescribeDomainResponse>

  • Method Details

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

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

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

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

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

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

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

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

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

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

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

    • defaultSpaceSettings

      public final DefaultSpaceSettings defaultSpaceSettings()

      The default settings used to create a space.

      Returns:
      The default settings used to create a space.

    • toBuilder

      public DescribeDomainResponse.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<DescribeDomainResponse.Builder,DescribeDomainResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.