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

Class CreateDomainRequest

    • Method Detail

      • domainName

        public final String domainName()

        A name for the domain.

        Returns:
        A name for the domain.

      • authMode

        public final AuthMode authMode()

        The mode of authentication that members use to access the domain.

        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 mode of authentication that members use to access the domain.
        See Also:
        AuthMode

      • authModeAsString

        public final String authModeAsString()

        The mode of authentication that members use to access the domain.

        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 mode of authentication that members use to access the domain.
        See Also:
        AuthMode

      • defaultUserSettings

        public final UserSettings defaultUserSettings()

        The default settings to use to create a user profile when UserSettings isn't specified in the call to the CreateUserProfile API.

        SecurityGroups is aggregated when specified in both calls. For all other settings in UserSettings, the values specified in CreateUserProfile take precedence over those specified in CreateDomain.

        Returns:
        The default settings to use to create a user profile when UserSettings isn't specified in the call to the CreateUserProfile API.

        SecurityGroups is aggregated when specified in both calls. For all other settings in UserSettings, the values specified in CreateUserProfile take precedence over those specified in CreateDomain.

      • domainSettings

        public final DomainSettings domainSettings()

        A collection of Domain settings.

        Returns:
        A collection of Domain settings.

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

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

      • hasTags

        public final boolean hasTags()
        For responses, this returns true if the service returned a value for the Tags 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.

      • tags

        public final List<Tag> tags()

        Tags to associated with the Domain. Each tag consists of a key and an optional value. Tag keys must be unique per resource. Tags are searchable using the Search API.

        Tags that you specify for the Domain are also added to all Apps that the Domain launches.

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

        Returns:
        Tags to associated with the Domain. Each tag consists of a key and an optional value. Tag keys must be unique per resource. Tags are searchable using the Search API.

        Tags that you specify for the Domain are also added to all Apps that the Domain launches.

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

      • kmsKeyId

        public final String kmsKeyId()

        SageMaker uses Amazon Web Services KMS to encrypt EFS and EBS volumes attached to the domain with an Amazon Web Services managed key by default. For more control, specify a customer managed key.

        Returns:
        SageMaker uses Amazon Web Services KMS to encrypt EFS and EBS volumes attached to the domain with an Amazon Web Services managed key by default. For more control, specify a customer managed key.

      • 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 setting up the domain for use with RStudio, this value must be set to Service.

        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. If setting up the domain for use with RStudio, this value must be set to Service.
        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 setting up the domain for use with RStudio, this value must be set to Service.

        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. If setting up the domain for use with RStudio, this value must be set to Service.
        See Also:
        AppSecurityGroupManagement

      • tagPropagation

        public final TagPropagation tagPropagation()

        Indicates whether custom tag propagation is supported for the domain. Defaults to DISABLED.

        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. Defaults to DISABLED.
        See Also:
        TagPropagation

      • tagPropagationAsString

        public final String tagPropagationAsString()

        Indicates whether custom tag propagation is supported for the domain. Defaults to DISABLED.

        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. Defaults to DISABLED.
        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