Class CfnStudioProps.Builder
java.lang.Object
software.amazon.awscdk.services.emr.CfnStudioProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnStudioProps>
- Enclosing interface:
CfnStudioProps
@Stability(Stable)
public static final class CfnStudioProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnStudioProps>
A builder for
CfnStudioProps
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionSets the value ofCfnStudioProps.getAuthMode()
build()
Builds the configured instance.defaultS3Location
(String defaultS3Location) Sets the value ofCfnStudioProps.getDefaultS3Location()
description
(String description) Sets the value ofCfnStudioProps.getDescription()
encryptionKeyArn
(String encryptionKeyArn) Sets the value ofCfnStudioProps.getEncryptionKeyArn()
engineSecurityGroupId
(String engineSecurityGroupId) Sets the value ofCfnStudioProps.getEngineSecurityGroupId()
idcInstanceArn
(String idcInstanceArn) Sets the value ofCfnStudioProps.getIdcInstanceArn()
idcUserAssignment
(String idcUserAssignment) Sets the value ofCfnStudioProps.getIdcUserAssignment()
idpAuthUrl
(String idpAuthUrl) Sets the value ofCfnStudioProps.getIdpAuthUrl()
idpRelayStateParameterName
(String idpRelayStateParameterName) Sets the value ofCfnStudioProps.getIdpRelayStateParameterName()
Sets the value ofCfnStudioProps.getName()
serviceRole
(String serviceRole) Sets the value ofCfnStudioProps.getServiceRole()
Sets the value ofCfnStudioProps.getSubnetIds()
Sets the value ofCfnStudioProps.getTags()
trustedIdentityPropagationEnabled
(Boolean trustedIdentityPropagationEnabled) Sets the value ofCfnStudioProps.getTrustedIdentityPropagationEnabled()
trustedIdentityPropagationEnabled
(IResolvable trustedIdentityPropagationEnabled) Sets the value ofCfnStudioProps.getTrustedIdentityPropagationEnabled()
Sets the value ofCfnStudioProps.getUserRole()
Sets the value ofCfnStudioProps.getVpcId()
workspaceSecurityGroupId
(String workspaceSecurityGroupId) Sets the value ofCfnStudioProps.getWorkspaceSecurityGroupId()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
authMode
Sets the value ofCfnStudioProps.getAuthMode()
- Parameters:
authMode
- Specifies whether the Studio authenticates users using IAM Identity Center or IAM. This parameter is required.- Returns:
this
-
defaultS3Location
Sets the value ofCfnStudioProps.getDefaultS3Location()
- Parameters:
defaultS3Location
- The Amazon S3 location to back up EMR Studio Workspaces and notebook files. This parameter is required.- Returns:
this
-
engineSecurityGroupId
@Stability(Stable) public CfnStudioProps.Builder engineSecurityGroupId(String engineSecurityGroupId) Sets the value ofCfnStudioProps.getEngineSecurityGroupId()
- Parameters:
engineSecurityGroupId
- The ID of the Amazon EMR Studio Engine security group. This parameter is required. The Engine security group allows inbound network traffic from the Workspace security group, and it must be in the same VPC specified byVpcId
.- Returns:
this
-
name
Sets the value ofCfnStudioProps.getName()
- Parameters:
name
- A descriptive name for the Amazon EMR Studio. This parameter is required.- Returns:
this
-
serviceRole
Sets the value ofCfnStudioProps.getServiceRole()
- Parameters:
serviceRole
- The Amazon Resource Name (ARN) of the IAM role that will be assumed by the Amazon EMR Studio. This parameter is required. The service role provides a way for Amazon EMR Studio to interoperate with other AWS services.- Returns:
this
-
subnetIds
Sets the value ofCfnStudioProps.getSubnetIds()
- Parameters:
subnetIds
- A list of subnet IDs to associate with the Amazon EMR Studio. This parameter is required. A Studio can have a maximum of 5 subnets. The subnets must belong to the VPC specified byVpcId
. Studio users can create a Workspace in any of the specified subnets.- Returns:
this
-
vpcId
Sets the value ofCfnStudioProps.getVpcId()
- Parameters:
vpcId
- The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio. This parameter is required.- Returns:
this
-
workspaceSecurityGroupId
@Stability(Stable) public CfnStudioProps.Builder workspaceSecurityGroupId(String workspaceSecurityGroupId) Sets the value ofCfnStudioProps.getWorkspaceSecurityGroupId()
- Parameters:
workspaceSecurityGroupId
- The ID of the Workspace security group associated with the Amazon EMR Studio. This parameter is required. The Workspace security group allows outbound network traffic to resources in the Engine security group and to the internet.- Returns:
this
-
description
Sets the value ofCfnStudioProps.getDescription()
- Parameters:
description
- A detailed description of the Amazon EMR Studio.- Returns:
this
-
encryptionKeyArn
Sets the value ofCfnStudioProps.getEncryptionKeyArn()
- Parameters:
encryptionKeyArn
- The AWS KMS key identifier (ARN) used to encrypt Amazon EMR Studio workspace and notebook files when backed up to Amazon S3.- Returns:
this
-
idcInstanceArn
Sets the value ofCfnStudioProps.getIdcInstanceArn()
- Parameters:
idcInstanceArn
- The ARN of the IAM Identity Center instance the Studio application belongs to.- Returns:
this
-
idcUserAssignment
Sets the value ofCfnStudioProps.getIdcUserAssignment()
- Parameters:
idcUserAssignment
- Indicates whether the Studio hasREQUIRED
orOPTIONAL
IAM Identity Center user assignment. If the value is set toREQUIRED
, users must be explicitly assigned to the Studio application to access the Studio.- Returns:
this
-
idpAuthUrl
Sets the value ofCfnStudioProps.getIdpAuthUrl()
- Parameters:
idpAuthUrl
- Your identity provider's authentication endpoint. Amazon EMR Studio redirects federated users to this endpoint for authentication when logging in to a Studio with the Studio URL.- Returns:
this
-
idpRelayStateParameterName
@Stability(Stable) public CfnStudioProps.Builder idpRelayStateParameterName(String idpRelayStateParameterName) Sets the value ofCfnStudioProps.getIdpRelayStateParameterName()
- Parameters:
idpRelayStateParameterName
- The name of your identity provider'sRelayState
parameter.- Returns:
this
-
tags
Sets the value ofCfnStudioProps.getTags()
- Parameters:
tags
- An array of key-value pairs to apply to this resource. For more information, see Tag .- Returns:
this
-
trustedIdentityPropagationEnabled
@Stability(Stable) public CfnStudioProps.Builder trustedIdentityPropagationEnabled(Boolean trustedIdentityPropagationEnabled) Sets the value ofCfnStudioProps.getTrustedIdentityPropagationEnabled()
- Parameters:
trustedIdentityPropagationEnabled
- Indicates whether the Studio has Trusted identity propagation enabled. The default value isfalse
.- Returns:
this
-
trustedIdentityPropagationEnabled
@Stability(Stable) public CfnStudioProps.Builder trustedIdentityPropagationEnabled(IResolvable trustedIdentityPropagationEnabled) Sets the value ofCfnStudioProps.getTrustedIdentityPropagationEnabled()
- Parameters:
trustedIdentityPropagationEnabled
- Indicates whether the Studio has Trusted identity propagation enabled. The default value isfalse
.- Returns:
this
-
userRole
Sets the value ofCfnStudioProps.getUserRole()
- Parameters:
userRole
- The Amazon Resource Name (ARN) of the IAM user role that will be assumed by users and groups logged in to a Studio. The permissions attached to this IAM role can be scoped down for each user or group using session policies. You only need to specifyUserRole
when you setAuthMode
toSSO
.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnStudioProps>
- Returns:
- a new instance of
CfnStudioProps
- Throws:
NullPointerException
- if any required attribute was not provided
-