com.pulumi.aws.emr.kotlin.StudioArgs.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-aws-kotlin Show documentation
Show all versions of pulumi-aws-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.aws.emr.kotlin
import com.pulumi.aws.emr.StudioArgs.builder
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import kotlin.Pair
import kotlin.String
import kotlin.Suppress
import kotlin.collections.List
import kotlin.collections.Map
import kotlin.jvm.JvmName
/**
* Provides an Elastic MapReduce Studio.
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
* const example = new aws.emr.Studio("example", {
* authMode: "SSO",
* defaultS3Location: `s3://${test.bucket}/test`,
* engineSecurityGroupId: testAwsSecurityGroup.id,
* name: "example",
* serviceRole: testAwsIamRole.arn,
* subnetIds: [testAwsSubnet.id],
* userRole: testAwsIamRole.arn,
* vpcId: testAwsVpc.id,
* workspaceSecurityGroupId: testAwsSecurityGroup.id,
* });
* ```
* ```python
* import pulumi
* import pulumi_aws as aws
* example = aws.emr.Studio("example",
* auth_mode="SSO",
* default_s3_location=f"s3://{test['bucket']}/test",
* engine_security_group_id=test_aws_security_group["id"],
* name="example",
* service_role=test_aws_iam_role["arn"],
* subnet_ids=[test_aws_subnet["id"]],
* user_role=test_aws_iam_role["arn"],
* vpc_id=test_aws_vpc["id"],
* workspace_security_group_id=test_aws_security_group["id"])
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Aws = Pulumi.Aws;
* return await Deployment.RunAsync(() =>
* {
* var example = new Aws.Emr.Studio("example", new()
* {
* AuthMode = "SSO",
* DefaultS3Location = $"s3://{test.Bucket}/test",
* EngineSecurityGroupId = testAwsSecurityGroup.Id,
* Name = "example",
* ServiceRole = testAwsIamRole.Arn,
* SubnetIds = new[]
* {
* testAwsSubnet.Id,
* },
* UserRole = testAwsIamRole.Arn,
* VpcId = testAwsVpc.Id,
* WorkspaceSecurityGroupId = testAwsSecurityGroup.Id,
* });
* });
* ```
* ```go
* package main
* import (
* "fmt"
* "github.com/pulumi/pulumi-aws/sdk/v6/go/aws/emr"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* _, err := emr.NewStudio(ctx, "example", &emr.StudioArgs{
* AuthMode: pulumi.String("SSO"),
* DefaultS3Location: pulumi.Sprintf("s3://%v/test", test.Bucket),
* EngineSecurityGroupId: pulumi.Any(testAwsSecurityGroup.Id),
* Name: pulumi.String("example"),
* ServiceRole: pulumi.Any(testAwsIamRole.Arn),
* SubnetIds: pulumi.StringArray{
* testAwsSubnet.Id,
* },
* UserRole: pulumi.Any(testAwsIamRole.Arn),
* VpcId: pulumi.Any(testAwsVpc.Id),
* WorkspaceSecurityGroupId: pulumi.Any(testAwsSecurityGroup.Id),
* })
* if err != nil {
* return err
* }
* return nil
* })
* }
* ```
* ```java
* package generated_program;
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.aws.emr.Studio;
* import com.pulumi.aws.emr.StudioArgs;
* import java.util.List;
* import java.util.ArrayList;
* import java.util.Map;
* import java.io.File;
* import java.nio.file.Files;
* import java.nio.file.Paths;
* public class App {
* public static void main(String[] args) {
* Pulumi.run(App::stack);
* }
* public static void stack(Context ctx) {
* var example = new Studio("example", StudioArgs.builder()
* .authMode("SSO")
* .defaultS3Location(String.format("s3://%s/test", test.bucket()))
* .engineSecurityGroupId(testAwsSecurityGroup.id())
* .name("example")
* .serviceRole(testAwsIamRole.arn())
* .subnetIds(testAwsSubnet.id())
* .userRole(testAwsIamRole.arn())
* .vpcId(testAwsVpc.id())
* .workspaceSecurityGroupId(testAwsSecurityGroup.id())
* .build());
* }
* }
* ```
* ```yaml
* resources:
* example:
* type: aws:emr:Studio
* properties:
* authMode: SSO
* defaultS3Location: s3://${test.bucket}/test
* engineSecurityGroupId: ${testAwsSecurityGroup.id}
* name: example
* serviceRole: ${testAwsIamRole.arn}
* subnetIds:
* - ${testAwsSubnet.id}
* userRole: ${testAwsIamRole.arn}
* vpcId: ${testAwsVpc.id}
* workspaceSecurityGroupId: ${testAwsSecurityGroup.id}
* ```
*
* ## Import
* Using `pulumi import`, import EMR studios using the `id`. For example:
* ```sh
* $ pulumi import aws:emr/studio:Studio studio es-123456ABCDEF
* ```
* @property authMode Specifies whether the Studio authenticates users using IAM or Amazon Web Services SSO. Valid values are `SSO` or `IAM`.
* @property defaultS3Location The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files.
* @property description A detailed description of the Amazon EMR Studio.
* @property engineSecurityGroupId 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 `vpc_id`.
* @property idpAuthUrl The authentication endpoint of your identity provider (IdP). Specify this value when you use IAM authentication and want to let federated users log in to a Studio with the Studio URL and credentials from your IdP. Amazon EMR Studio redirects users to this endpoint to enter credentials.
* @property idpRelayStateParameterName The name that your identity provider (IdP) uses for its RelayState parameter. For example, RelayState or TargetSource. Specify this value when you use IAM authentication and want to let federated users log in to a Studio using the Studio URL. The RelayState parameter differs by IdP.
* @property name A descriptive name for the Amazon EMR Studio.
* @property serviceRole The IAM role that the Amazon EMR Studio assumes. The service role provides a way for Amazon EMR Studio to interoperate with other Amazon Web Services services.
* @property subnetIds 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 `vpc_id`. Studio users can create a Workspace in any of the specified subnets.
* @property tags list of tags to apply to the EMR Cluster. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
* @property userRole The IAM user role that users and groups assume when logged in to an Amazon EMR Studio. Only specify a User Role when you use Amazon Web Services SSO authentication. The permissions attached to the User Role can be scoped down for each user or group using session policies.
* @property vpcId The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.
* @property workspaceSecurityGroupId The ID of the Amazon EMR Studio Workspace security group. The Workspace security group allows outbound network traffic to resources in the Engine security group, and it must be in the same VPC specified by `vpc_id`.
* The following arguments are optional:
*/
public data class StudioArgs(
public val authMode: Output? = null,
public val defaultS3Location: Output? = null,
public val description: Output? = null,
public val engineSecurityGroupId: Output? = null,
public val idpAuthUrl: Output? = null,
public val idpRelayStateParameterName: Output? = null,
public val name: Output? = null,
public val serviceRole: Output? = null,
public val subnetIds: Output>? = null,
public val tags: Output>? = null,
public val userRole: Output? = null,
public val vpcId: Output? = null,
public val workspaceSecurityGroupId: Output? = null,
) : ConvertibleToJava {
override fun toJava(): com.pulumi.aws.emr.StudioArgs = com.pulumi.aws.emr.StudioArgs.builder()
.authMode(authMode?.applyValue({ args0 -> args0 }))
.defaultS3Location(defaultS3Location?.applyValue({ args0 -> args0 }))
.description(description?.applyValue({ args0 -> args0 }))
.engineSecurityGroupId(engineSecurityGroupId?.applyValue({ args0 -> args0 }))
.idpAuthUrl(idpAuthUrl?.applyValue({ args0 -> args0 }))
.idpRelayStateParameterName(idpRelayStateParameterName?.applyValue({ args0 -> args0 }))
.name(name?.applyValue({ args0 -> args0 }))
.serviceRole(serviceRole?.applyValue({ args0 -> args0 }))
.subnetIds(subnetIds?.applyValue({ args0 -> args0.map({ args0 -> args0 }) }))
.tags(tags?.applyValue({ args0 -> args0.map({ args0 -> args0.key.to(args0.value) }).toMap() }))
.userRole(userRole?.applyValue({ args0 -> args0 }))
.vpcId(vpcId?.applyValue({ args0 -> args0 }))
.workspaceSecurityGroupId(workspaceSecurityGroupId?.applyValue({ args0 -> args0 })).build()
}
/**
* Builder for [StudioArgs].
*/
@PulumiTagMarker
public class StudioArgsBuilder internal constructor() {
private var authMode: Output? = null
private var defaultS3Location: Output? = null
private var description: Output? = null
private var engineSecurityGroupId: Output? = null
private var idpAuthUrl: Output? = null
private var idpRelayStateParameterName: Output? = null
private var name: Output? = null
private var serviceRole: Output? = null
private var subnetIds: Output>? = null
private var tags: Output>? = null
private var userRole: Output? = null
private var vpcId: Output? = null
private var workspaceSecurityGroupId: Output? = null
/**
* @param value Specifies whether the Studio authenticates users using IAM or Amazon Web Services SSO. Valid values are `SSO` or `IAM`.
*/
@JvmName("okrdyiprnytogqua")
public suspend fun authMode(`value`: Output) {
this.authMode = value
}
/**
* @param value The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files.
*/
@JvmName("gmjrmnopavbpfast")
public suspend fun defaultS3Location(`value`: Output) {
this.defaultS3Location = value
}
/**
* @param value A detailed description of the Amazon EMR Studio.
*/
@JvmName("spdcvdrdyojrepac")
public suspend fun description(`value`: Output) {
this.description = value
}
/**
* @param value 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 `vpc_id`.
*/
@JvmName("ahihnnxrfrubhplv")
public suspend fun engineSecurityGroupId(`value`: Output) {
this.engineSecurityGroupId = value
}
/**
* @param value The authentication endpoint of your identity provider (IdP). Specify this value when you use IAM authentication and want to let federated users log in to a Studio with the Studio URL and credentials from your IdP. Amazon EMR Studio redirects users to this endpoint to enter credentials.
*/
@JvmName("jsjbrmkqerpexein")
public suspend fun idpAuthUrl(`value`: Output) {
this.idpAuthUrl = value
}
/**
* @param value The name that your identity provider (IdP) uses for its RelayState parameter. For example, RelayState or TargetSource. Specify this value when you use IAM authentication and want to let federated users log in to a Studio using the Studio URL. The RelayState parameter differs by IdP.
*/
@JvmName("yrckugtojkytkshk")
public suspend fun idpRelayStateParameterName(`value`: Output) {
this.idpRelayStateParameterName = value
}
/**
* @param value A descriptive name for the Amazon EMR Studio.
*/
@JvmName("gdgkullnuplketbn")
public suspend fun name(`value`: Output) {
this.name = value
}
/**
* @param value The IAM role that the Amazon EMR Studio assumes. The service role provides a way for Amazon EMR Studio to interoperate with other Amazon Web Services services.
*/
@JvmName("yooupgtvpuugvfxe")
public suspend fun serviceRole(`value`: Output) {
this.serviceRole = value
}
/**
* @param value 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 `vpc_id`. Studio users can create a Workspace in any of the specified subnets.
*/
@JvmName("hhmgwuiloknktmgf")
public suspend fun subnetIds(`value`: Output>) {
this.subnetIds = value
}
@JvmName("lanpxynchfhektvr")
public suspend fun subnetIds(vararg values: Output) {
this.subnetIds = Output.all(values.asList())
}
/**
* @param values 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 `vpc_id`. Studio users can create a Workspace in any of the specified subnets.
*/
@JvmName("xuxgkbhpkubuygut")
public suspend fun subnetIds(values: List>) {
this.subnetIds = Output.all(values)
}
/**
* @param value list of tags to apply to the EMR Cluster. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
@JvmName("skbnwxujyxxojoxh")
public suspend fun tags(`value`: Output>) {
this.tags = value
}
/**
* @param value The IAM user role that users and groups assume when logged in to an Amazon EMR Studio. Only specify a User Role when you use Amazon Web Services SSO authentication. The permissions attached to the User Role can be scoped down for each user or group using session policies.
*/
@JvmName("daokvftfnoverogn")
public suspend fun userRole(`value`: Output) {
this.userRole = value
}
/**
* @param value The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.
*/
@JvmName("xmtkfibugueyqwss")
public suspend fun vpcId(`value`: Output) {
this.vpcId = value
}
/**
* @param value The ID of the Amazon EMR Studio Workspace security group. The Workspace security group allows outbound network traffic to resources in the Engine security group, and it must be in the same VPC specified by `vpc_id`.
* The following arguments are optional:
*/
@JvmName("rkouyplutemuuwes")
public suspend fun workspaceSecurityGroupId(`value`: Output) {
this.workspaceSecurityGroupId = value
}
/**
* @param value Specifies whether the Studio authenticates users using IAM or Amazon Web Services SSO. Valid values are `SSO` or `IAM`.
*/
@JvmName("feegudocgejpinjk")
public suspend fun authMode(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.authMode = mapped
}
/**
* @param value The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files.
*/
@JvmName("muaqifwaohioqmgm")
public suspend fun defaultS3Location(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.defaultS3Location = mapped
}
/**
* @param value A detailed description of the Amazon EMR Studio.
*/
@JvmName("gigtkvttuidyskjl")
public suspend fun description(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.description = mapped
}
/**
* @param value 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 `vpc_id`.
*/
@JvmName("vlbdsljiitbtjaem")
public suspend fun engineSecurityGroupId(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.engineSecurityGroupId = mapped
}
/**
* @param value The authentication endpoint of your identity provider (IdP). Specify this value when you use IAM authentication and want to let federated users log in to a Studio with the Studio URL and credentials from your IdP. Amazon EMR Studio redirects users to this endpoint to enter credentials.
*/
@JvmName("tnvfwrlntrxgasuk")
public suspend fun idpAuthUrl(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.idpAuthUrl = mapped
}
/**
* @param value The name that your identity provider (IdP) uses for its RelayState parameter. For example, RelayState or TargetSource. Specify this value when you use IAM authentication and want to let federated users log in to a Studio using the Studio URL. The RelayState parameter differs by IdP.
*/
@JvmName("ntvddpmtvhuuxtqb")
public suspend fun idpRelayStateParameterName(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.idpRelayStateParameterName = mapped
}
/**
* @param value A descriptive name for the Amazon EMR Studio.
*/
@JvmName("kvjhbhlitldbqibp")
public suspend fun name(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.name = mapped
}
/**
* @param value The IAM role that the Amazon EMR Studio assumes. The service role provides a way for Amazon EMR Studio to interoperate with other Amazon Web Services services.
*/
@JvmName("nhcixqadftmnuqor")
public suspend fun serviceRole(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.serviceRole = mapped
}
/**
* @param value 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 `vpc_id`. Studio users can create a Workspace in any of the specified subnets.
*/
@JvmName("qnjesnyiukbwcduf")
public suspend fun subnetIds(`value`: List?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.subnetIds = mapped
}
/**
* @param values 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 `vpc_id`. Studio users can create a Workspace in any of the specified subnets.
*/
@JvmName("ganbfvkbensfrstx")
public suspend fun subnetIds(vararg values: String) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.subnetIds = mapped
}
/**
* @param value list of tags to apply to the EMR Cluster. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
@JvmName("naburwrmpwysbyhx")
public suspend fun tags(`value`: Map?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.tags = mapped
}
/**
* @param values list of tags to apply to the EMR Cluster. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
@JvmName("jigujybcmpdtdugk")
public fun tags(vararg values: Pair) {
val toBeMapped = values.toMap()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.tags = mapped
}
/**
* @param value The IAM user role that users and groups assume when logged in to an Amazon EMR Studio. Only specify a User Role when you use Amazon Web Services SSO authentication. The permissions attached to the User Role can be scoped down for each user or group using session policies.
*/
@JvmName("qkcbbfdxfewimcmu")
public suspend fun userRole(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.userRole = mapped
}
/**
* @param value The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.
*/
@JvmName("fcvhhtxoduundkgg")
public suspend fun vpcId(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.vpcId = mapped
}
/**
* @param value The ID of the Amazon EMR Studio Workspace security group. The Workspace security group allows outbound network traffic to resources in the Engine security group, and it must be in the same VPC specified by `vpc_id`.
* The following arguments are optional:
*/
@JvmName("fpnrjlygdiubdnqy")
public suspend fun workspaceSecurityGroupId(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.workspaceSecurityGroupId = mapped
}
internal fun build(): StudioArgs = StudioArgs(
authMode = authMode,
defaultS3Location = defaultS3Location,
description = description,
engineSecurityGroupId = engineSecurityGroupId,
idpAuthUrl = idpAuthUrl,
idpRelayStateParameterName = idpRelayStateParameterName,
name = name,
serviceRole = serviceRole,
subnetIds = subnetIds,
tags = tags,
userRole = userRole,
vpcId = vpcId,
workspaceSecurityGroupId = workspaceSecurityGroupId,
)
}