Interface CfnStudioProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnStudioProps.Jsii$Proxy
CfnStudio
.
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.*; CfnStudioProps cfnStudioProps = CfnStudioProps.builder() .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") .encryptionKeyArn("encryptionKeyArn") .idcInstanceArn("idcInstanceArn") .idcUserAssignment("idcUserAssignment") .idpAuthUrl("idpAuthUrl") .idpRelayStateParameterName("idpRelayStateParameterName") .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .trustedIdentityPropagationEnabled(false) .userRole("userRole") .build();
- See Also:
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnStudioProps
static final class
An implementation forCfnStudioProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnStudioProps.Builder
builder()
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.default String
A detailed description of the Amazon EMR Studio.default String
The AWS KMS key identifier (ARN) used to encrypt Amazon EMR Studio workspace and notebook files when backed up to Amazon S3.The ID of the Amazon EMR Studio Engine security group.default String
The ARN of the IAM Identity Center instance the Studio application belongs to.default String
Indicates whether the Studio hasREQUIRED
orOPTIONAL
IAM Identity Center user assignment.default String
Your identity provider's authentication endpoint.default String
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.default Object
Indicates whether the Studio has Trusted identity propagation enabled.default String
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.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getAuthMode
Specifies whether the Studio authenticates users using IAM Identity Center or IAM.- See Also:
-
getDefaultS3Location
The Amazon S3 location to back up EMR Studio Workspaces and notebook files.- See Also:
-
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
.- See Also:
-
getName
A descriptive name for the Amazon EMR Studio.- See Also:
-
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.
- See Also:
-
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.- See Also:
-
getVpcId
The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.- See Also:
-
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.
- See Also:
-
getDescription
A detailed description of the Amazon EMR Studio.- See Also:
-
getEncryptionKeyArn
The AWS KMS key identifier (ARN) used to encrypt Amazon EMR Studio workspace and notebook files when backed up to Amazon S3.- See Also:
-
getIdcInstanceArn
The ARN of the IAM Identity Center instance the Studio application belongs to.- See Also:
-
getIdcUserAssignment
Indicates whether the Studio hasREQUIRED
orOPTIONAL
IAM Identity Center user assignment.If the value is set to
REQUIRED
, users must be explicitly assigned to the Studio application to access the Studio.- See Also:
-
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.
- See Also:
-
getIdpRelayStateParameterName
The name of your identity provider'sRelayState
parameter.- See Also:
-
getTags
An array of key-value pairs to apply to this resource.For more information, see Tag .
- See Also:
-
getTrustedIdentityPropagationEnabled
Indicates whether the Studio has Trusted identity propagation enabled.The default value is
false
.- See Also:
-
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
.- See Also:
-
builder
- Returns:
- a
CfnStudioProps.Builder
ofCfnStudioProps
-