Package software.amazon.awscdk.services.emr

Interface CfnStudioProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnStudioProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:56.663Z") @Stability(Stable) public interface CfnStudioProps extends software.amazon.jsii.JsiiSerializable
Properties for defining a 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")
         .idpAuthUrl("idpAuthUrl")
         .idpRelayStateParameterName("idpRelayStateParameterName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .userRole("userRole")
         .build();

  • Method Details

    • getAuthMode

      @Stability(Stable) @NotNull String getAuthMode()
      Specifies whether the Studio authenticates users using IAM Identity Center or IAM.

    • getDefaultS3Location

      @Stability(Stable) @NotNull String getDefaultS3Location()
      The Amazon S3 location to back up EMR Studio Workspaces and notebook files.

    • getEngineSecurityGroupId

      @Stability(Stable) @NotNull String 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 .

    • getName

      @Stability(Stable) @NotNull String getName()
      A descriptive name for the Amazon EMR Studio.

    • getServiceRole

      @Stability(Stable) @NotNull String 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.

    • getSubnetIds

      @Stability(Stable) @NotNull List<String> 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.

    • getVpcId

      @Stability(Stable) @NotNull String getVpcId()
      The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.

    • getWorkspaceSecurityGroupId

      @Stability(Stable) @NotNull String 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.

    • getDescription

      @Stability(Stable) @Nullable default String getDescription()
      A detailed description of the Amazon EMR Studio.

    • getIdpAuthUrl

      @Stability(Stable) @Nullable default String 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.

    • getIdpRelayStateParameterName

      @Stability(Stable) @Nullable default String getIdpRelayStateParameterName()
      The name of your identity provider's RelayState parameter.

    • getTags

      @Stability(Stable) @Nullable default List<CfnTag> getTags()
      An array of key-value pairs to apply to this resource.

      For more information, see Tag .

    • getUserRole

      @Stability(Stable) @Nullable default String 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 set AuthMode to SSO .

    • builder

      @Stability(Stable) static CfnStudioProps.Builder builder()
      Returns:
      a CfnStudioProps.Builder of CfnStudioProps