Interface CreateDomainRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateDomainRequest.Builder,CreateDomainRequest>, SageMakerRequest.Builder, SdkBuilder<CreateDomainRequest.Builder,CreateDomainRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateDomainRequest
public static interface CreateDomainRequest.Builder extends SageMakerRequest.Builder, SdkPojo, CopyableBuilder<CreateDomainRequest.Builder,CreateDomainRequest>

  • Method Details

    • domainName

      CreateDomainRequest.Builder domainName(String domainName)

      A name for the domain.

      Parameters:
      domainName - A name for the domain.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • authMode

      CreateDomainRequest.Builder authMode(String authMode)

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

      Parameters:
      authMode - The mode of authentication that members use to access the domain.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • authMode

      CreateDomainRequest.Builder authMode(AuthMode authMode)

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

      Parameters:
      authMode - The mode of authentication that members use to access the domain.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • defaultUserSettings

      CreateDomainRequest.Builder defaultUserSettings(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • defaultUserSettings

      default CreateDomainRequest.Builder defaultUserSettings(Consumer<UserSettings.Builder> 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.

      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

      CreateDomainRequest.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 CreateDomainRequest.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:

    • subnetIds

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

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

    • vpcId

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

    • tags

      CreateDomainRequest.Builder tags(Collection<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.

      Parameters:
      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.

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

    • tags

      CreateDomainRequest.Builder tags(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.

      Parameters:
      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.

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

    • tags

      CreateDomainRequest.Builder tags(Consumer<Tag.Builder>... 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.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • appNetworkAccessType

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

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

    • kmsKeyId

      CreateDomainRequest.Builder kmsKeyId(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • appSecurityGroupManagement

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

      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. If setting up the domain for use with RStudio, this value must be set to Service.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • appSecurityGroupManagement

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

      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. If setting up the domain for use with RStudio, this value must be set to Service.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tagPropagation

      CreateDomainRequest.Builder tagPropagation(String tagPropagation)

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

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

    • tagPropagation

      CreateDomainRequest.Builder tagPropagation(TagPropagation tagPropagation)

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

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

    • defaultSpaceSettings

      CreateDomainRequest.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 CreateDomainRequest.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:

    • overrideConfiguration

      CreateDomainRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateDomainRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.