Interface DomainSettingsForUpdate.Builder

All Superinterfaces:

Buildable, CopyableBuilder<DomainSettingsForUpdate.Builder,DomainSettingsForUpdate>, SdkBuilder<DomainSettingsForUpdate.Builder,DomainSettingsForUpdate>, SdkPojo

Enclosing class:

DomainSettingsForUpdate

@Mutable
@NotThreadSafe
public static interface DomainSettingsForUpdate.Builder
extends SdkPojo, CopyableBuilder<DomainSettingsForUpdate.Builder,DomainSettingsForUpdate>

Method Summary

Modifier and Type	Method	Description
default DomainSettingsForUpdate.Builder	amazonQSettings(Consumer<AmazonQSettings.Builder> amazonQSettings)	A collection of settings that configure the Amazon Q experience within the domain.
DomainSettingsForUpdate.Builder	amazonQSettings(AmazonQSettings amazonQSettings)	A collection of settings that configure the Amazon Q experience within the domain.
default DomainSettingsForUpdate.Builder	dockerSettings(Consumer<DockerSettings.Builder> dockerSettings)	A collection of settings that configure the domain's Docker interaction.
DomainSettingsForUpdate.Builder	dockerSettings(DockerSettings dockerSettings)	A collection of settings that configure the domain's Docker interaction.
DomainSettingsForUpdate.Builder	executionRoleIdentityConfig(String executionRoleIdentityConfig)	The configuration for attaching a SageMaker AI user profile name to the execution role as a sts:SourceIdentity key.
DomainSettingsForUpdate.Builder	executionRoleIdentityConfig(ExecutionRoleIdentityConfig executionRoleIdentityConfig)	The configuration for attaching a SageMaker AI user profile name to the execution role as a sts:SourceIdentity key.
DomainSettingsForUpdate.Builder	ipAddressType(String ipAddressType)	The IP address type for the domain.
DomainSettingsForUpdate.Builder	ipAddressType(IPAddressType ipAddressType)	The IP address type for the domain.
default DomainSettingsForUpdate.Builder	rStudioServerProDomainSettingsForUpdate(Consumer<RStudioServerProDomainSettingsForUpdate.Builder> rStudioServerProDomainSettingsForUpdate)	A collection of RStudioServerPro Domain-level app settings to update.
DomainSettingsForUpdate.Builder	rStudioServerProDomainSettingsForUpdate(RStudioServerProDomainSettingsForUpdate rStudioServerProDomainSettingsForUpdate)	A collection of RStudioServerPro Domain-level app settings to update.
DomainSettingsForUpdate.Builder	securityGroupIds(String... securityGroupIds)	The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.
DomainSettingsForUpdate.Builder	securityGroupIds(Collection<String> securityGroupIds)	The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.
default DomainSettingsForUpdate.Builder	trustedIdentityPropagationSettings(Consumer<TrustedIdentityPropagationSettings.Builder> trustedIdentityPropagationSettings)	The Trusted Identity Propagation (TIP) settings for the SageMaker domain.
DomainSettingsForUpdate.Builder	trustedIdentityPropagationSettings(TrustedIdentityPropagationSettings trustedIdentityPropagationSettings)	The Trusted Identity Propagation (TIP) settings for the SageMaker domain.
default DomainSettingsForUpdate.Builder	unifiedStudioSettings(Consumer<UnifiedStudioSettings.Builder> unifiedStudioSettings)	The settings that apply to an SageMaker AI domain when you use it in Amazon SageMaker Unified Studio.
DomainSettingsForUpdate.Builder	unifiedStudioSettings(UnifiedStudioSettings unifiedStudioSettings)	The settings that apply to an SageMaker AI domain when you use it in Amazon SageMaker Unified Studio.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

rStudioServerProDomainSettingsForUpdate

DomainSettingsForUpdate.Builder rStudioServerProDomainSettingsForUpdate(RStudioServerProDomainSettingsForUpdate rStudioServerProDomainSettingsForUpdate)

A collection of RStudioServerPro Domain-level app settings to update. A single RStudioServerPro application is created for a domain.

Parameters:

rStudioServerProDomainSettingsForUpdate - A collection of RStudioServerPro Domain-level app settings to update. A single RStudioServerPro application is created for a domain.

Returns:

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

rStudioServerProDomainSettingsForUpdate

default DomainSettingsForUpdate.Builder rStudioServerProDomainSettingsForUpdate(Consumer<RStudioServerProDomainSettingsForUpdate.Builder> rStudioServerProDomainSettingsForUpdate)

A collection of RStudioServerPro Domain-level app settings to update. A single RStudioServerPro application is created for a domain.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to rStudioServerProDomainSettingsForUpdate(RStudioServerProDomainSettingsForUpdate).

Parameters:

rStudioServerProDomainSettingsForUpdate - a consumer that will call methods on RStudioServerProDomainSettingsForUpdate.Builder

Returns:

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

See Also:

• rStudioServerProDomainSettingsForUpdate(RStudioServerProDomainSettingsForUpdate)

executionRoleIdentityConfig

DomainSettingsForUpdate.Builder executionRoleIdentityConfig(String executionRoleIdentityConfig)

The configuration for attaching a SageMaker AI user profile name to the execution role as a sts:SourceIdentity key. This configuration can only be modified if there are no apps in the InService or Pending state.

Parameters:

executionRoleIdentityConfig - The configuration for attaching a SageMaker AI user profile name to the execution role as a sts:SourceIdentity key. This configuration can only be modified if there are no apps in the InService or Pending state.

Returns:

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

See Also:

• ExecutionRoleIdentityConfig
• ExecutionRoleIdentityConfig

executionRoleIdentityConfig

DomainSettingsForUpdate.Builder executionRoleIdentityConfig(ExecutionRoleIdentityConfig executionRoleIdentityConfig)

The configuration for attaching a SageMaker AI user profile name to the execution role as a sts:SourceIdentity key. This configuration can only be modified if there are no apps in the InService or Pending state.

Parameters:

executionRoleIdentityConfig - The configuration for attaching a SageMaker AI user profile name to the execution role as a sts:SourceIdentity key. This configuration can only be modified if there are no apps in the InService or Pending state.

Returns:

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

See Also:

• ExecutionRoleIdentityConfig
• ExecutionRoleIdentityConfig

securityGroupIds

DomainSettingsForUpdate.Builder securityGroupIds(Collection<String> securityGroupIds)

The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.

Parameters:

securityGroupIds - The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.

Returns:

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

securityGroupIds

DomainSettingsForUpdate.Builder securityGroupIds(String... securityGroupIds)

The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.

Parameters:

securityGroupIds - The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.

Returns:

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

trustedIdentityPropagationSettings

DomainSettingsForUpdate.Builder trustedIdentityPropagationSettings(TrustedIdentityPropagationSettings trustedIdentityPropagationSettings)

The Trusted Identity Propagation (TIP) settings for the SageMaker domain. These settings determine how user identities from IAM Identity Center are propagated through the domain to TIP enabled Amazon Web Services services.

Parameters:

trustedIdentityPropagationSettings - The Trusted Identity Propagation (TIP) settings for the SageMaker domain. These settings determine how user identities from IAM Identity Center are propagated through the domain to TIP enabled Amazon Web Services services.

Returns:

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

trustedIdentityPropagationSettings

default DomainSettingsForUpdate.Builder trustedIdentityPropagationSettings(Consumer<TrustedIdentityPropagationSettings.Builder> trustedIdentityPropagationSettings)

The Trusted Identity Propagation (TIP) settings for the SageMaker domain. These settings determine how user identities from IAM Identity Center are propagated through the domain to TIP enabled Amazon Web Services services.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to trustedIdentityPropagationSettings(TrustedIdentityPropagationSettings).

Parameters:

trustedIdentityPropagationSettings - a consumer that will call methods on TrustedIdentityPropagationSettings.Builder

Returns:

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

See Also:

• trustedIdentityPropagationSettings(TrustedIdentityPropagationSettings)

dockerSettings

DomainSettingsForUpdate.Builder dockerSettings(DockerSettings dockerSettings)

A collection of settings that configure the domain's Docker interaction.

Parameters:

dockerSettings - A collection of settings that configure the domain's Docker interaction.

Returns:

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

dockerSettings

default DomainSettingsForUpdate.Builder dockerSettings(Consumer<DockerSettings.Builder> dockerSettings)

A collection of settings that configure the domain's Docker interaction.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dockerSettings(DockerSettings).

Parameters:

dockerSettings - a consumer that will call methods on DockerSettings.Builder

Returns:

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

See Also:

• dockerSettings(DockerSettings)

amazonQSettings

DomainSettingsForUpdate.Builder amazonQSettings(AmazonQSettings amazonQSettings)

A collection of settings that configure the Amazon Q experience within the domain.

Parameters:

amazonQSettings - A collection of settings that configure the Amazon Q experience within the domain.

Returns:

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

amazonQSettings

default DomainSettingsForUpdate.Builder amazonQSettings(Consumer<AmazonQSettings.Builder> amazonQSettings)

A collection of settings that configure the Amazon Q experience within the domain.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to amazonQSettings(AmazonQSettings).

Parameters:

amazonQSettings - a consumer that will call methods on AmazonQSettings.Builder

Returns:

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

See Also:

• amazonQSettings(AmazonQSettings)

unifiedStudioSettings

DomainSettingsForUpdate.Builder unifiedStudioSettings(UnifiedStudioSettings unifiedStudioSettings)

The settings that apply to an SageMaker AI domain when you use it in Amazon SageMaker Unified Studio.

Parameters:

unifiedStudioSettings - The settings that apply to an SageMaker AI domain when you use it in Amazon SageMaker Unified Studio.

Returns:

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

unifiedStudioSettings

default DomainSettingsForUpdate.Builder unifiedStudioSettings(Consumer<UnifiedStudioSettings.Builder> unifiedStudioSettings)

The settings that apply to an SageMaker AI domain when you use it in Amazon SageMaker Unified Studio.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to unifiedStudioSettings(UnifiedStudioSettings).

Parameters:

unifiedStudioSettings - a consumer that will call methods on UnifiedStudioSettings.Builder

Returns:

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

See Also:

• unifiedStudioSettings(UnifiedStudioSettings)

ipAddressType

DomainSettingsForUpdate.Builder ipAddressType(String ipAddressType)

The IP address type for the domain. Specify ipv4 for IPv4-only connectivity or dualstack for both IPv4 and IPv6 connectivity. When you specify dualstack, the subnet must support IPv6 CIDR blocks.

Parameters:

ipAddressType - The IP address type for the domain. Specify ipv4 for IPv4-only connectivity or dualstack for both IPv4 and IPv6 connectivity. When you specify dualstack, the subnet must support IPv6 CIDR blocks.

Returns:

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

See Also:

• IPAddressType
• IPAddressType

ipAddressType

DomainSettingsForUpdate.Builder ipAddressType(IPAddressType ipAddressType)

The IP address type for the domain. Specify ipv4 for IPv4-only connectivity or dualstack for both IPv4 and IPv6 connectivity. When you specify dualstack, the subnet must support IPv6 CIDR blocks.

Parameters:

ipAddressType - The IP address type for the domain. Specify ipv4 for IPv4-only connectivity or dualstack for both IPv4 and IPv6 connectivity. When you specify dualstack, the subnet must support IPv6 CIDR blocks.

Returns:

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

See Also:

• IPAddressType
• IPAddressType