Interface ICfnStudioProps
Properties for defining a CfnStudio
.
Namespace: Amazon.CDK.AWS.EMR
Assembly: Amazon.CDK.AWS.EMR.dll
Syntax (csharp)
public interface ICfnStudioProps
Syntax (vb)
Public Interface ICfnStudioProps
Remarks
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 cfnStudioProps = 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
Properties
AuthMode | Specifies whether the Studio authenticates users using IAM Identity Center or IAM. |
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. |
Properties
AuthMode
Specifies whether the Studio authenticates users using IAM Identity Center or IAM.
string AuthMode { get; }
Property Value
System.String
Remarks
DefaultS3Location
The Amazon S3 location to back up EMR Studio Workspaces and notebook files.
string DefaultS3Location { get; }
Property Value
System.String
Remarks
Description
A detailed description of the Amazon EMR Studio.
virtual string Description { get; }
Property Value
System.String
Remarks
EngineSecurityGroupId
The ID of the Amazon EMR Studio Engine security group.
string EngineSecurityGroupId { get; }
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.
virtual string IdpAuthUrl { get; }
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.
virtual string IdpRelayStateParameterName { get; }
Property Value
System.String
Remarks
Name
A descriptive name for the Amazon EMR Studio.
string Name { get; }
Property Value
System.String
Remarks
ServiceRole
The Amazon Resource Name (ARN) of the IAM role that will be assumed by the Amazon EMR Studio.
string ServiceRole { get; }
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.
string[] SubnetIds { get; }
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.
virtual ICfnTag[] Tags { get; }
Property Value
ICfnTag[]
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.
virtual string UserRole { get; }
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.
string VpcId { get; }
Property Value
System.String
Remarks
WorkspaceSecurityGroupId
The ID of the Workspace security group associated with the Amazon EMR Studio.
string WorkspaceSecurityGroupId { get; }
Property Value
System.String
Remarks
The Workspace security group allows outbound network traffic to resources in the Engine security group and to the internet.