@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)", date="2022-05-13T01:13:28.008Z") public class CfnStudio extends CfnResource implements IInspectable
The AWS::EMR::Studio
resource specifies an Amazon EMR Studio. An EMR Studio is a web-based, integrated development environment for fully managed Jupyter notebooks that run on Amazon EMR clusters. For more information, see the Amazon EMR Management Guide .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.emr.*; CfnStudio cfnStudio = CfnStudio.Builder.create(this, "MyCfnStudio") .authMode("authMode") .defaultS3Location("defaultS3Location") .engineSecurityGroupId("engineSecurityGroupId") .name("name") .serviceRole("serviceRole") .subnetIds(List.of("subnetIds")) .vpcId("vpcId") .workspaceSecurityGroupId("workspaceSecurityGroupId") // the properties below are optional .description("description") .idpAuthUrl("idpAuthUrl") .idpRelayStateParameterName("idpRelayStateParameterName") .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .userRole("userRole") .build();
Modifier and Type | Class and Description |
---|---|
static class |
CfnStudio.Builder
A fluent builder for
CfnStudio . |
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnStudio(Construct scope,
java.lang.String id,
CfnStudioProps props)
Create a new `AWS::EMR::Studio`.
|
protected |
CfnStudio(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnStudio(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAttrArn()
The Amazon Resource Name (ARN) of the Amazon EMR Studio.
|
java.lang.String |
getAttrStudioId()
The ID of the Amazon EMR Studio.
|
java.lang.String |
getAttrUrl()
The unique access URL of the Amazon EMR Studio.
|
java.lang.String |
getAuthMode()
Specifies whether the Studio authenticates users using AWS SSO or IAM.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.String |
getDefaultS3Location()
The Amazon S3 location to back up EMR Studio Workspaces and notebook files.
|
java.lang.String |
getDescription()
A detailed description of the Amazon EMR Studio.
|
java.lang.String |
getEngineSecurityGroupId()
The ID of the Amazon EMR Studio Engine security group.
|
java.lang.String |
getIdpAuthUrl()
Your identity provider's authentication endpoint.
|
java.lang.String |
getIdpRelayStateParameterName()
The name of your identity provider's `RelayState` parameter.
|
java.lang.String |
getName()
A descriptive name for the Amazon EMR Studio.
|
java.lang.String |
getServiceRole()
The Amazon Resource Name (ARN) of the IAM role that will be assumed by the Amazon EMR Studio.
|
java.util.List<java.lang.String> |
getSubnetIds()
A list of subnet IDs to associate with the Amazon EMR Studio.
|
TagManager |
getTags()
An array of key-value pairs to apply to this resource.
|
java.lang.String |
getUserRole()
The Amazon Resource Name (ARN) of the IAM user role that will be assumed by users and groups logged in to a Studio.
|
java.lang.String |
getVpcId()
The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.
|
java.lang.String |
getWorkspaceSecurityGroupId()
The ID of the Workspace security group associated with the Amazon EMR Studio.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setAuthMode(java.lang.String value)
Specifies whether the Studio authenticates users using AWS SSO or IAM.
|
void |
setDefaultS3Location(java.lang.String value)
The Amazon S3 location to back up EMR Studio Workspaces and notebook files.
|
void |
setDescription(java.lang.String value)
A detailed description of the Amazon EMR Studio.
|
void |
setEngineSecurityGroupId(java.lang.String value)
The ID of the Amazon EMR Studio Engine security group.
|
void |
setIdpAuthUrl(java.lang.String value)
Your identity provider's authentication endpoint.
|
void |
setIdpRelayStateParameterName(java.lang.String value)
The name of your identity provider's `RelayState` parameter.
|
void |
setName(java.lang.String value)
A descriptive name for the Amazon EMR Studio.
|
void |
setServiceRole(java.lang.String value)
The Amazon Resource Name (ARN) of the IAM role that will be assumed by the Amazon EMR Studio.
|
void |
setSubnetIds(java.util.List<java.lang.String> value)
A list of subnet IDs to associate with the Amazon EMR Studio.
|
void |
setUserRole(java.lang.String value)
The Amazon Resource Name (ARN) of the IAM user role that will be assumed by users and groups logged in to a Studio.
|
void |
setVpcId(java.lang.String value)
The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.
|
void |
setWorkspaceSecurityGroupId(java.lang.String value)
The ID of the Workspace security group associated with the Amazon EMR Studio.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnStudio(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnStudio(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnStudio(Construct scope, java.lang.String id, CfnStudioProps props)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.props
- - resource properties. This parameter is required.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrArn()
For example: arn:aws:elasticmapreduce:us-east-1:653XXXXXXXXX:studio/es-EXAMPLE12345678XXXXXXXXXXX
.
public java.lang.String getAttrStudioId()
For example: es-EXAMPLE12345678XXXXXXXXXXX
.
public java.lang.String getAttrUrl()
For example: https://es-EXAMPLE12345678XXXXXXXXXXX.emrstudio-prod.us-east-1.amazonaws.com
.
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
For more information, see Tag .
public java.lang.String getAuthMode()
public void setAuthMode(java.lang.String value)
public java.lang.String getDefaultS3Location()
public void setDefaultS3Location(java.lang.String value)
public java.lang.String getEngineSecurityGroupId()
The Engine security group allows inbound network traffic from the Workspace security group, and it must be in the same VPC specified by VpcId
.
public void setEngineSecurityGroupId(java.lang.String value)
The Engine security group allows inbound network traffic from the Workspace security group, and it must be in the same VPC specified by VpcId
.
public java.lang.String getName()
public void setName(java.lang.String value)
public java.lang.String getServiceRole()
The service role provides a way for Amazon EMR Studio to interoperate with other AWS services.
public void setServiceRole(java.lang.String value)
The service role provides a way for Amazon EMR Studio to interoperate with other AWS services.
public java.util.List<java.lang.String> getSubnetIds()
A Studio can have a maximum of 5 subnets. The subnets must belong to the VPC specified by VpcId
. Studio users can create a Workspace in any of the specified subnets.
public void setSubnetIds(java.util.List<java.lang.String> value)
A Studio can have a maximum of 5 subnets. The subnets must belong to the VPC specified by VpcId
. Studio users can create a Workspace in any of the specified subnets.
public java.lang.String getVpcId()
public void setVpcId(java.lang.String value)
public java.lang.String getWorkspaceSecurityGroupId()
The Workspace security group allows outbound network traffic to resources in the Engine security group and to the internet.
public void setWorkspaceSecurityGroupId(java.lang.String value)
The Workspace security group allows outbound network traffic to resources in the Engine security group and to the internet.
public java.lang.String getDescription()
public void setDescription(java.lang.String value)
public java.lang.String getIdpAuthUrl()
Amazon EMR Studio redirects federated users to this endpoint for authentication when logging in to a Studio with the Studio URL.
public void setIdpAuthUrl(java.lang.String value)
Amazon EMR Studio redirects federated users to this endpoint for authentication when logging in to a Studio with the Studio URL.
public java.lang.String getIdpRelayStateParameterName()
public void setIdpRelayStateParameterName(java.lang.String value)
public java.lang.String getUserRole()
The permissions attached to this IAM role can be scoped down for each user or group using session policies. You only need to specify UserRole
when you set AuthMode
to SSO
.
public void setUserRole(java.lang.String value)
The permissions attached to this IAM role can be scoped down for each user or group using session policies. You only need to specify UserRole
when you set AuthMode
to SSO
.