CfnDomainProps.Builder (software.amazon.awscdk:aws-cdk-lib 2.42.1 API)

java.lang.Object
- software.amazon.awscdk.services.sagemaker.CfnDomainProps.Builder

All Implemented Interfaces:: software.amazon.jsii.Builder<CfnDomainProps>

Enclosing interface:: CfnDomainProps

@Stability(value=Stable)
public static final class CfnDomainProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnDomainProps>

A builder for CfnDomainProps

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CfnDomainProps.Builder`	`appNetworkAccessType(String appNetworkAccessType)` Sets the value of `CfnDomainProps.getAppNetworkAccessType()`
`CfnDomainProps.Builder`	`appSecurityGroupManagement(String appSecurityGroupManagement)` Sets the value of `CfnDomainProps.getAppSecurityGroupManagement()`
`CfnDomainProps.Builder`	`authMode(String authMode)` Sets the value of `CfnDomainProps.getAuthMode()`
`CfnDomainProps`	`build()` Builds the configured instance.
`CfnDomainProps.Builder`	`defaultUserSettings(CfnDomain.UserSettingsProperty defaultUserSettings)` Sets the value of `CfnDomainProps.getDefaultUserSettings()`
`CfnDomainProps.Builder`	`defaultUserSettings(IResolvable defaultUserSettings)` Sets the value of `CfnDomainProps.getDefaultUserSettings()`
`CfnDomainProps.Builder`	`domainName(String domainName)` Sets the value of `CfnDomainProps.getDomainName()`
`CfnDomainProps.Builder`	`domainSettings(CfnDomain.DomainSettingsProperty domainSettings)` Sets the value of `CfnDomainProps.getDomainSettings()`
`CfnDomainProps.Builder`	`domainSettings(IResolvable domainSettings)` Sets the value of `CfnDomainProps.getDomainSettings()`
`CfnDomainProps.Builder`	`kmsKeyId(String kmsKeyId)` Sets the value of `CfnDomainProps.getKmsKeyId()`
`CfnDomainProps.Builder`	`subnetIds(List<String> subnetIds)` Sets the value of `CfnDomainProps.getSubnetIds()`
`CfnDomainProps.Builder`	`tags(List<? extends CfnTag> tags)` Sets the value of `CfnDomainProps.getTags()`
`CfnDomainProps.Builder`	`vpcId(String vpcId)` Sets the value of `CfnDomainProps.getVpcId()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - authMode
```
@Stability(value=Stable)
public CfnDomainProps.Builder authMode(String authMode)
```
    Sets the value of CfnDomainProps.getAuthMode()
    
    Parameters:
    
    authMode - The mode of authentication that members use to access the Domain. This parameter is required. Valid Values : SSO | IAM
    
    Returns:
    
    this
  - defaultUserSettings
```
@Stability(value=Stable)
public CfnDomainProps.Builder defaultUserSettings(CfnDomain.UserSettingsProperty defaultUserSettings)
```
    Sets the value of CfnDomainProps.getDefaultUserSettings()
    
    Parameters:
    
    defaultUserSettings - The default user settings. This parameter is required.
    
    Returns:
    
    this
  - defaultUserSettings
```
@Stability(value=Stable)
public CfnDomainProps.Builder defaultUserSettings(IResolvable defaultUserSettings)
```
    Sets the value of CfnDomainProps.getDefaultUserSettings()
    
    Parameters:
    
    defaultUserSettings - The default user settings. This parameter is required.
    
    Returns:
    
    this
  - domainName
```
@Stability(value=Stable)
public CfnDomainProps.Builder domainName(String domainName)
```
    Sets the value of CfnDomainProps.getDomainName()
    
    Parameters:
    
    domainName - The domain name. This parameter is required.
    
    Returns:
    
    this
  - subnetIds
```
@Stability(value=Stable)
public CfnDomainProps.Builder subnetIds(List<String> subnetIds)
```
    Sets the value of CfnDomainProps.getSubnetIds()
    
    Parameters:
    
    subnetIds - The VPC subnets that Studio uses for communication. This parameter is required. Length Constraints : Maximum length of 32.
    Array members : Minimum number of 1 item. Maximum number of 16 items.
    Pattern : [-0-9a-zA-Z]+
    
    Returns:
    
    this
  - vpcId
```
@Stability(value=Stable)
public CfnDomainProps.Builder vpcId(String vpcId)
```
    Sets the value of CfnDomainProps.getVpcId()
    
    Parameters:
    
    vpcId - The ID of the Amazon Virtual Private Cloud (Amazon VPC) that Studio uses for communication. This parameter is required. Length Constraints : Maximum length of 32.
    Pattern : [-0-9a-zA-Z]+
    
    Returns:
    
    this
  - appNetworkAccessType
```
@Stability(value=Stable)
public CfnDomainProps.Builder appNetworkAccessType(String appNetworkAccessType)
```
    Sets the value of CfnDomainProps.getAppNetworkAccessType()
    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 Studio traffic is through the specified VPC and subnets
    
    Valid Values : PublicInternetOnly | VpcOnly
    Returns:
    
    this
  - appSecurityGroupManagement
```
@Stability(value=Stable)
public CfnDomainProps.Builder appSecurityGroupManagement(String appSecurityGroupManagement)
```
    Sets the value of CfnDomainProps.getAppSecurityGroupManagement()
    
    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.
    
    Returns:
    
    this
  - domainSettings
```
@Stability(value=Stable)
public CfnDomainProps.Builder domainSettings(CfnDomain.DomainSettingsProperty domainSettings)
```
    Sets the value of CfnDomainProps.getDomainSettings()
    
    Parameters:
    
    domainSettings - A collection of settings that apply to the `SageMaker Domain` . These settings are specified through the CreateDomain API call.
    
    Returns:
    
    this
  - domainSettings
```
@Stability(value=Stable)
public CfnDomainProps.Builder domainSettings(IResolvable domainSettings)
```
    Sets the value of CfnDomainProps.getDomainSettings()
    
    Parameters:
    
    domainSettings - A collection of settings that apply to the `SageMaker Domain` . These settings are specified through the CreateDomain API call.
    
    Returns:
    
    this
  - kmsKeyId
```
@Stability(value=Stable)
public CfnDomainProps.Builder kmsKeyId(String kmsKeyId)
```
    Sets the value of CfnDomainProps.getKmsKeyId()
    
    Parameters:
    
    kmsKeyId - SageMaker uses AWS KMS to encrypt the EFS volume attached to the Domain with an AWS managed customer master key (CMK) by default. For more control, specify a customer managed CMK.
    Length Constraints : Maximum length of 2048.
    Pattern : .*
    
    Returns:
    
    this
  - tags
```
@Stability(value=Stable)
public CfnDomainProps.Builder tags(List<? extends CfnTag> tags)
```
    Sets the value of CfnDomainProps.getTags()
    
    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 are launched in the Domain.
    Array members : Minimum number of 0 items. Maximum number of 50 items.
    
    Returns:
    
    this
  - build
```
@Stability(value=Stable)
public CfnDomainProps build()
```
    Builds the configured instance.
    
    Specified by:
    
    build in interface software.amazon.jsii.Builder<CfnDomainProps>
    
    Returns:
    
    a new instance of CfnDomainProps
    
    Throws:
    
    NullPointerException - if any required attribute was not provided

Class CfnDomainProps.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

authMode

defaultUserSettings

defaultUserSettings

domainName

subnetIds

vpcId

appNetworkAccessType

appSecurityGroupManagement

domainSettings

domainSettings

kmsKeyId

tags

build