Class CfnStudio
A CloudFormation AWS::EMR::Studio
.
Inherited Members
Namespace: Amazon.CDK.AWS.EMR
Assembly: Amazon.CDK.AWS.EMR.dll
Syntax (csharp)
public class CfnStudio : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnStudio
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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 .
CloudformationResource: AWS::EMR::Studio
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-studio.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.EMR;
var cfnStudio = new CfnStudio(this, "MyCfnStudio", new CfnStudioProps {
AuthMode = "authMode",
DefaultS3Location = "defaultS3Location",
EngineSecurityGroupId = "engineSecurityGroupId",
Name = "name",
ServiceRole = "serviceRole",
SubnetIds = new [] { "subnetIds" },
VpcId = "vpcId",
WorkspaceSecurityGroupId = "workspaceSecurityGroupId",
// the properties below are optional
Description = "description",
IdpAuthUrl = "idpAuthUrl",
IdpRelayStateParameterName = "idpRelayStateParameterName",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
UserRole = "userRole"
});
Synopsis
Constructors
CfnStudio(Construct, String, ICfnStudioProps) | Create a new |
CfnStudio(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnStudio(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrArn | The Amazon Resource Name (ARN) of the Amazon EMR Studio. |
AttrStudioId | The ID of the Amazon EMR Studio. |
AttrUrl | The unique access URL of the Amazon EMR Studio. |
AuthMode | Specifies whether the Studio authenticates users using IAM Identity Center or IAM. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
DefaultS3Location | The Amazon S3 location to back up EMR Studio Workspaces and notebook files. |
Description | A detailed description of the Amazon EMR Studio. |
EngineSecurityGroupId | The ID of the Amazon EMR Studio Engine security group. |
IdpAuthUrl | Your identity provider's authentication endpoint. |
IdpRelayStateParameterName | The name of your identity provider's |
Name | A descriptive name for the Amazon EMR Studio. |
ServiceRole | The Amazon Resource Name (ARN) of the IAM role that will be assumed by the Amazon EMR Studio. |
SubnetIds | A list of subnet IDs to associate with the Amazon EMR Studio. |
Tags | An array of key-value pairs to apply to this resource. |
UserRole | The Amazon Resource Name (ARN) of the IAM user role that will be assumed by users and groups logged in to a Studio. |
VpcId | The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio. |
WorkspaceSecurityGroupId | The ID of the Workspace security group associated with the Amazon EMR Studio. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnStudio(Construct, String, ICfnStudioProps)
Create a new AWS::EMR::Studio
.
public CfnStudio(Construct scope, string id, ICfnStudioProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnStudioProps
- resource properties.
CfnStudio(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnStudio(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnStudio(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnStudio(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrArn
The Amazon Resource Name (ARN) of the Amazon EMR Studio.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
For example: arn:aws:elasticmapreduce:us-east-1:653XXXXXXXXX:studio/es-EXAMPLE12345678XXXXXXXXXXX
.
CloudformationAttribute: Arn
AttrStudioId
The ID of the Amazon EMR Studio.
public virtual string AttrStudioId { get; }
Property Value
System.String
Remarks
For example: es-EXAMPLE12345678XXXXXXXXXXX
.
CloudformationAttribute: StudioId
AttrUrl
The unique access URL of the Amazon EMR Studio.
public virtual string AttrUrl { get; }
Property Value
System.String
Remarks
For example: https://es-EXAMPLE12345678XXXXXXXXXXX.emrstudio-prod.us-east-1.amazonaws.com
.
CloudformationAttribute: Url
AuthMode
Specifies whether the Studio authenticates users using IAM Identity Center or IAM.
public virtual string AuthMode { get; set; }
Property Value
System.String
Remarks
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
DefaultS3Location
The Amazon S3 location to back up EMR Studio Workspaces and notebook files.
public virtual string DefaultS3Location { get; set; }
Property Value
System.String
Remarks
Description
A detailed description of the Amazon EMR Studio.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
EngineSecurityGroupId
The ID of the Amazon EMR Studio Engine security group.
public virtual string EngineSecurityGroupId { get; set; }
Property Value
System.String
Remarks
The Engine security group allows inbound network traffic from the Workspace security group, and it must be in the same VPC specified by VpcId
.
IdpAuthUrl
Your identity provider's authentication endpoint.
public virtual string IdpAuthUrl { get; set; }
Property Value
System.String
Remarks
Amazon EMR Studio redirects federated users to this endpoint for authentication when logging in to a Studio with the Studio URL.
IdpRelayStateParameterName
The name of your identity provider's RelayState
parameter.
public virtual string IdpRelayStateParameterName { get; set; }
Property Value
System.String
Remarks
Name
A descriptive name for the Amazon EMR Studio.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
ServiceRole
The Amazon Resource Name (ARN) of the IAM role that will be assumed by the Amazon EMR Studio.
public virtual string ServiceRole { get; set; }
Property Value
System.String
Remarks
The service role provides a way for Amazon EMR Studio to interoperate with other AWS services.
SubnetIds
A list of subnet IDs to associate with the Amazon EMR Studio.
public virtual string[] SubnetIds { get; set; }
Property Value
System.String[]
Remarks
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.
Tags
An array of key-value pairs to apply to this resource.
public virtual TagManager Tags { get; }
Property Value
Remarks
For more information, see Tag .
UserRole
The Amazon Resource Name (ARN) of the IAM user role that will be assumed by users and groups logged in to a Studio.
public virtual string UserRole { get; set; }
Property Value
System.String
Remarks
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
.
VpcId
The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.
public virtual string VpcId { get; set; }
Property Value
System.String
Remarks
WorkspaceSecurityGroupId
The ID of the Workspace security group associated with the Amazon EMR Studio.
public virtual string WorkspaceSecurityGroupId { get; set; }
Property Value
System.String
Remarks
The Workspace security group allows outbound network traffic to resources in the Engine security group and to the internet.
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>