Class CfnStudio
- All Implemented Interfaces:
IConstruct
,IDependable
,IInspectable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
AWS::EMR::Studio
.
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();
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionThe Amazon Resource Name (ARN) of the Amazon EMR Studio.The ID of the Amazon EMR Studio.The unique access URL of the Amazon EMR Studio.Specifies whether the Studio authenticates users using IAM Identity Center or IAM.The Amazon S3 location to back up EMR Studio Workspaces and notebook files.A detailed description of the Amazon EMR Studio.The ID of the Amazon EMR Studio Engine security group.Your identity provider's authentication endpoint.The name of your identity provider'sRelayState
parameter.getName()
A descriptive name for the Amazon EMR Studio.The Amazon Resource Name (ARN) of the IAM role that will be assumed by the Amazon EMR Studio.A list of subnet IDs to associate with the Amazon EMR Studio.getTags()
An array of key-value pairs to apply to this resource.The Amazon Resource Name (ARN) of the IAM user role that will be assumed by users and groups logged in to a Studio.getVpcId()
The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.The ID of the Workspace security group associated with the Amazon EMR Studio.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setAuthMode
(String value) Specifies whether the Studio authenticates users using IAM Identity Center or IAM.void
setDefaultS3Location
(String value) The Amazon S3 location to back up EMR Studio Workspaces and notebook files.void
setDescription
(String value) A detailed description of the Amazon EMR Studio.void
setEngineSecurityGroupId
(String value) The ID of the Amazon EMR Studio Engine security group.void
setIdpAuthUrl
(String value) Your identity provider's authentication endpoint.void
The name of your identity provider'sRelayState
parameter.void
A descriptive name for the Amazon EMR Studio.void
setServiceRole
(String value) The Amazon Resource Name (ARN) of the IAM role that will be assumed by the Amazon EMR Studio.void
setSubnetIds
(List<String> value) A list of subnet IDs to associate with the Amazon EMR Studio.void
setUserRole
(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
The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.void
The ID of the Workspace security group associated with the Amazon EMR Studio.Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnStudio
protected CfnStudio(software.amazon.jsii.JsiiObjectRef objRef) -
CfnStudio
protected CfnStudio(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnStudio
@Stability(Stable) public CfnStudio(@NotNull Construct scope, @NotNull String id, @NotNull CfnStudioProps props) Create a newAWS::EMR::Studio
.- Parameters:
scope
-- scope in which this resource is defined.
id
-- scoped id of the resource.
props
-- resource properties.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
-- tree inspector to collect and process attributes.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrArn
The Amazon Resource Name (ARN) of the Amazon EMR Studio.For example:
arn:aws:elasticmapreduce:us-east-1:653XXXXXXXXX:studio/es-EXAMPLE12345678XXXXXXXXXXX
. -
getAttrStudioId
The ID of the Amazon EMR Studio.For example:
es-EXAMPLE12345678XXXXXXXXXXX
. -
getAttrUrl
The unique access URL of the Amazon EMR Studio.For example:
https://es-EXAMPLE12345678XXXXXXXXXXX.emrstudio-prod.us-east-1.amazonaws.com
. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
An array of key-value pairs to apply to this resource.For more information, see Tag .
-
getAuthMode
Specifies whether the Studio authenticates users using IAM Identity Center or IAM. -
setAuthMode
Specifies whether the Studio authenticates users using IAM Identity Center or IAM. -
getDefaultS3Location
The Amazon S3 location to back up EMR Studio Workspaces and notebook files. -
setDefaultS3Location
The Amazon S3 location to back up EMR Studio Workspaces and notebook files. -
getEngineSecurityGroupId
The ID of the Amazon EMR Studio Engine security group.The Engine security group allows inbound network traffic from the Workspace security group, and it must be in the same VPC specified by
VpcId
. -
setEngineSecurityGroupId
The ID of the Amazon EMR Studio Engine security group.The Engine security group allows inbound network traffic from the Workspace security group, and it must be in the same VPC specified by
VpcId
. -
getName
A descriptive name for the Amazon EMR Studio. -
setName
A descriptive name for the Amazon EMR Studio. -
getServiceRole
The Amazon Resource Name (ARN) of the IAM role that will be assumed by the Amazon EMR Studio.The service role provides a way for Amazon EMR Studio to interoperate with other AWS services.
-
setServiceRole
The Amazon Resource Name (ARN) of the IAM role that will be assumed by the Amazon EMR Studio.The service role provides a way for Amazon EMR Studio to interoperate with other AWS services.
-
getSubnetIds
A list of subnet IDs to associate with the Amazon EMR Studio.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. -
setSubnetIds
A list of subnet IDs to associate with the Amazon EMR Studio.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. -
getVpcId
The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio. -
setVpcId
The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio. -
getWorkspaceSecurityGroupId
The ID of the Workspace security group associated with the Amazon EMR Studio.The Workspace security group allows outbound network traffic to resources in the Engine security group and to the internet.
-
setWorkspaceSecurityGroupId
The ID of the Workspace security group associated with the Amazon EMR Studio.The Workspace security group allows outbound network traffic to resources in the Engine security group and to the internet.
-
getDescription
A detailed description of the Amazon EMR Studio. -
setDescription
A detailed description of the Amazon EMR Studio. -
getIdpAuthUrl
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.
-
setIdpAuthUrl
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.
-
getIdpRelayStateParameterName
The name of your identity provider'sRelayState
parameter. -
setIdpRelayStateParameterName
The name of your identity provider'sRelayState
parameter. -
getUserRole
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 specify
UserRole
when you setAuthMode
toSSO
. -
setUserRole
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 specify
UserRole
when you setAuthMode
toSSO
.
-