Please wait. This can take some minutes ...
Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
com.pulumi.aws.iam.kotlin.UserArgs.kt Maven / Gradle / Ivy
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.aws.iam.kotlin
import com.pulumi.aws.iam.UserArgs.builder
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import kotlin.Boolean
import kotlin.Pair
import kotlin.String
import kotlin.Suppress
import kotlin.collections.Map
import kotlin.jvm.JvmName
/**
* Provides an IAM user.
* > *NOTE:* If policies are attached to the user via the `aws.iam.PolicyAttachment` resource and you are modifying the user `name` or `path`, the `force_destroy` argument must be set to `true` and applied before attempting the operation otherwise you will encounter a `DeleteConflict` error. The `aws.iam.UserPolicyAttachment` resource (recommended) does not have this requirement.
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
* const lb = new aws.iam.User("lb", {
* name: "loadbalancer",
* path: "/system/",
* tags: {
* "tag-key": "tag-value",
* },
* });
* const lbAccessKey = new aws.iam.AccessKey("lb", {user: lb.name});
* const lbRo = aws.iam.getPolicyDocument({
* statements: [{
* effect: "Allow",
* actions: ["ec2:Describe*"],
* resources: ["*"],
* }],
* });
* const lbRoUserPolicy = new aws.iam.UserPolicy("lb_ro", {
* name: "test",
* user: lb.name,
* policy: lbRo.then(lbRo => lbRo.json),
* });
* ```
* ```python
* import pulumi
* import pulumi_aws as aws
* lb = aws.iam.User("lb",
* name="loadbalancer",
* path="/system/",
* tags={
* "tag-key": "tag-value",
* })
* lb_access_key = aws.iam.AccessKey("lb", user=lb.name)
* lb_ro = aws.iam.get_policy_document(statements=[{
* "effect": "Allow",
* "actions": ["ec2:Describe*"],
* "resources": ["*"],
* }])
* lb_ro_user_policy = aws.iam.UserPolicy("lb_ro",
* name="test",
* user=lb.name,
* policy=lb_ro.json)
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Aws = Pulumi.Aws;
* return await Deployment.RunAsync(() =>
* {
* var lb = new Aws.Iam.User("lb", new()
* {
* Name = "loadbalancer",
* Path = "/system/",
* Tags =
* {
* { "tag-key", "tag-value" },
* },
* });
* var lbAccessKey = new Aws.Iam.AccessKey("lb", new()
* {
* User = lb.Name,
* });
* var lbRo = Aws.Iam.GetPolicyDocument.Invoke(new()
* {
* Statements = new[]
* {
* new Aws.Iam.Inputs.GetPolicyDocumentStatementInputArgs
* {
* Effect = "Allow",
* Actions = new[]
* {
* "ec2:Describe*",
* },
* Resources = new[]
* {
* "*",
* },
* },
* },
* });
* var lbRoUserPolicy = new Aws.Iam.UserPolicy("lb_ro", new()
* {
* Name = "test",
* User = lb.Name,
* Policy = lbRo.Apply(getPolicyDocumentResult => getPolicyDocumentResult.Json),
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-aws/sdk/v6/go/aws/iam"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* lb, err := iam.NewUser(ctx, "lb", &iam.UserArgs{
* Name: pulumi.String("loadbalancer"),
* Path: pulumi.String("/system/"),
* Tags: pulumi.StringMap{
* "tag-key": pulumi.String("tag-value"),
* },
* })
* if err != nil {
* return err
* }
* _, err = iam.NewAccessKey(ctx, "lb", &iam.AccessKeyArgs{
* User: lb.Name,
* })
* if err != nil {
* return err
* }
* lbRo, err := iam.GetPolicyDocument(ctx, &iam.GetPolicyDocumentArgs{
* Statements: []iam.GetPolicyDocumentStatement{
* {
* Effect: pulumi.StringRef("Allow"),
* Actions: []string{
* "ec2:Describe*",
* },
* Resources: []string{
* "*",
* },
* },
* },
* }, nil)
* if err != nil {
* return err
* }
* _, err = iam.NewUserPolicy(ctx, "lb_ro", &iam.UserPolicyArgs{
* Name: pulumi.String("test"),
* User: lb.Name,
* Policy: pulumi.String(lbRo.Json),
* })
* 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.iam.User;
* import com.pulumi.aws.iam.UserArgs;
* import com.pulumi.aws.iam.AccessKey;
* import com.pulumi.aws.iam.AccessKeyArgs;
* import com.pulumi.aws.iam.IamFunctions;
* import com.pulumi.aws.iam.inputs.GetPolicyDocumentArgs;
* import com.pulumi.aws.iam.UserPolicy;
* import com.pulumi.aws.iam.UserPolicyArgs;
* 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 lb = new User("lb", UserArgs.builder()
* .name("loadbalancer")
* .path("/system/")
* .tags(Map.of("tag-key", "tag-value"))
* .build());
* var lbAccessKey = new AccessKey("lbAccessKey", AccessKeyArgs.builder()
* .user(lb.name())
* .build());
* final var lbRo = IamFunctions.getPolicyDocument(GetPolicyDocumentArgs.builder()
* .statements(GetPolicyDocumentStatementArgs.builder()
* .effect("Allow")
* .actions("ec2:Describe*")
* .resources("*")
* .build())
* .build());
* var lbRoUserPolicy = new UserPolicy("lbRoUserPolicy", UserPolicyArgs.builder()
* .name("test")
* .user(lb.name())
* .policy(lbRo.applyValue(getPolicyDocumentResult -> getPolicyDocumentResult.json()))
* .build());
* }
* }
* ```
* ```yaml
* resources:
* lb:
* type: aws:iam:User
* properties:
* name: loadbalancer
* path: /system/
* tags:
* tag-key: tag-value
* lbAccessKey:
* type: aws:iam:AccessKey
* name: lb
* properties:
* user: ${lb.name}
* lbRoUserPolicy:
* type: aws:iam:UserPolicy
* name: lb_ro
* properties:
* name: test
* user: ${lb.name}
* policy: ${lbRo.json}
* variables:
* lbRo:
* fn::invoke:
* Function: aws:iam:getPolicyDocument
* Arguments:
* statements:
* - effect: Allow
* actions:
* - ec2:Describe*
* resources:
* - '*'
* ```
*
* ## Import
* Using `pulumi import`, import IAM Users using the `name`. For example:
* ```sh
* $ pulumi import aws:iam/user:User lb loadbalancer
* ```
* @property forceDestroy When destroying this user, destroy even if it
* has non-provider-managed IAM access keys, login profile or MFA devices. Without `force_destroy`
* a user with non-provider-managed access keys and login profile will fail to be destroyed.
* @property name The user's name. The name must consist of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: `=,.@-_.`. User names are not distinguished by case. For example, you cannot create users named both "TESTUSER" and "testuser".
* @property path Path in which to create the user.
* @property permissionsBoundary The ARN of the policy that is used to set the permissions boundary for the user.
* @property tags Key-value mapping of tags for the IAM user. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
public data class UserArgs(
public val forceDestroy: Output? = null,
public val name: Output? = null,
public val path: Output? = null,
public val permissionsBoundary: Output? = null,
public val tags: Output>? = null,
) : ConvertibleToJava {
override fun toJava(): com.pulumi.aws.iam.UserArgs = com.pulumi.aws.iam.UserArgs.builder()
.forceDestroy(forceDestroy?.applyValue({ args0 -> args0 }))
.name(name?.applyValue({ args0 -> args0 }))
.path(path?.applyValue({ args0 -> args0 }))
.permissionsBoundary(permissionsBoundary?.applyValue({ args0 -> args0 }))
.tags(
tags?.applyValue({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
}),
).build()
}
/**
* Builder for [UserArgs].
*/
@PulumiTagMarker
public class UserArgsBuilder internal constructor() {
private var forceDestroy: Output? = null
private var name: Output? = null
private var path: Output? = null
private var permissionsBoundary: Output? = null
private var tags: Output>? = null
/**
* @param value When destroying this user, destroy even if it
* has non-provider-managed IAM access keys, login profile or MFA devices. Without `force_destroy`
* a user with non-provider-managed access keys and login profile will fail to be destroyed.
*/
@JvmName("trlhyvqfjqakgcgm")
public suspend fun forceDestroy(`value`: Output) {
this.forceDestroy = value
}
/**
* @param value The user's name. The name must consist of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: `=,.@-_.`. User names are not distinguished by case. For example, you cannot create users named both "TESTUSER" and "testuser".
*/
@JvmName("bbetoyvdnfamugxh")
public suspend fun name(`value`: Output) {
this.name = value
}
/**
* @param value Path in which to create the user.
*/
@JvmName("erppvltciqcewtde")
public suspend fun path(`value`: Output) {
this.path = value
}
/**
* @param value The ARN of the policy that is used to set the permissions boundary for the user.
*/
@JvmName("bgdktsiyvgybmcwh")
public suspend fun permissionsBoundary(`value`: Output) {
this.permissionsBoundary = value
}
/**
* @param value Key-value mapping of tags for the IAM user. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
@JvmName("olrmfgtvlwsgbmpj")
public suspend fun tags(`value`: Output>) {
this.tags = value
}
/**
* @param value When destroying this user, destroy even if it
* has non-provider-managed IAM access keys, login profile or MFA devices. Without `force_destroy`
* a user with non-provider-managed access keys and login profile will fail to be destroyed.
*/
@JvmName("ejmpbfsqxijpaain")
public suspend fun forceDestroy(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.forceDestroy = mapped
}
/**
* @param value The user's name. The name must consist of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: `=,.@-_.`. User names are not distinguished by case. For example, you cannot create users named both "TESTUSER" and "testuser".
*/
@JvmName("conanykxivehskgw")
public suspend fun name(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.name = mapped
}
/**
* @param value Path in which to create the user.
*/
@JvmName("gqrqobjdhaljmdvc")
public suspend fun path(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.path = mapped
}
/**
* @param value The ARN of the policy that is used to set the permissions boundary for the user.
*/
@JvmName("catsweeirwpcdwfa")
public suspend fun permissionsBoundary(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.permissionsBoundary = mapped
}
/**
* @param value Key-value mapping of tags for the IAM user. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
@JvmName("okkurbpmbukjprfe")
public suspend fun tags(`value`: Map?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.tags = mapped
}
/**
* @param values Key-value mapping of tags for the IAM user. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
@JvmName("sfvgtxhtwdrfqeso")
public fun tags(vararg values: Pair) {
val toBeMapped = values.toMap()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.tags = mapped
}
internal fun build(): UserArgs = UserArgs(
forceDestroy = forceDestroy,
name = name,
path = path,
permissionsBoundary = permissionsBoundary,
tags = tags,
)
}