Class CfnStudioProps
Properties for defining a CfnStudio
.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.EMR
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnStudioProps : Object, ICfnStudioProps
Syntax (vb)
Public Class CfnStudioProps
Inherits Object
Implements ICfnStudioProps
Remarks
See: 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",
EncryptionKeyArn = "encryptionKeyArn",
IdcInstanceArn = "idcInstanceArn",
IdcUserAssignment = "idcUserAssignment",
IdpAuthUrl = "idpAuthUrl",
IdpRelayStateParameterName = "idpRelayStateParameterName",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
TrustedIdentityPropagationEnabled = false,
UserRole = "userRole"
};
Synopsis
Constructors
CfnStudioProps() |
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. |
EncryptionKeyArn | The AWS KMS key identifier (ARN) used to encrypt Amazon EMR Studio workspace and notebook files when backed up to Amazon S3. |
EngineSecurityGroupId | The ID of the Amazon EMR Studio Engine security group. |
IdcInstanceArn | The ARN of the IAM Identity Center instance the Studio application belongs to. |
IdcUserAssignment | Indicates whether the Studio has |
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. |
TrustedIdentityPropagationEnabled | Indicates whether the Studio has Trusted identity propagation enabled. |
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. |
Constructors
CfnStudioProps()
public CfnStudioProps()
Properties
AuthMode
Specifies whether the Studio authenticates users using IAM Identity Center or IAM.
public string AuthMode { get; set; }
Property Value
System.String
Remarks
DefaultS3Location
The Amazon S3 location to back up EMR Studio Workspaces and notebook files.
public string DefaultS3Location { get; set; }
Property Value
System.String
Remarks
Description
A detailed description of the Amazon EMR Studio.
public string Description { get; set; }
Property Value
System.String
Remarks
EncryptionKeyArn
The AWS KMS key identifier (ARN) used to encrypt Amazon EMR Studio workspace and notebook files when backed up to Amazon S3.
public string EncryptionKeyArn { get; set; }
Property Value
System.String
Remarks
EngineSecurityGroupId
The ID of the Amazon EMR Studio Engine security group.
public 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
.
IdcInstanceArn
The ARN of the IAM Identity Center instance the Studio application belongs to.
public string IdcInstanceArn { get; set; }
Property Value
System.String
Remarks
IdcUserAssignment
Indicates whether the Studio has REQUIRED
or OPTIONAL
IAM Identity Center user assignment.
public string IdcUserAssignment { get; set; }
Property Value
System.String
Remarks
If the value is set to REQUIRED
, users must be explicitly assigned to the Studio application to access the Studio.
IdpAuthUrl
Your identity provider's authentication endpoint.
public 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 string IdpRelayStateParameterName { get; set; }
Property Value
System.String
Remarks
Name
A descriptive name for the Amazon EMR Studio.
public 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 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 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 ICfnTag[] Tags { get; set; }
Property Value
ICfnTag[]
Remarks
For more information, see Tag .
TrustedIdentityPropagationEnabled
Indicates whether the Studio has Trusted identity propagation enabled.
public object TrustedIdentityPropagationEnabled { get; set; }
Property Value
System.Object
Remarks
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 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 string VpcId { get; set; }
Property Value
System.String
Remarks
WorkspaceSecurityGroupId
The ID of the Workspace security group associated with the Amazon EMR Studio.
public 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.