com.pulumi.aws.iam.kotlin.GroupPolicyArgs.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.iam.kotlin
import com.pulumi.aws.iam.GroupPolicyArgs.builder
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import kotlin.String
import kotlin.Suppress
import kotlin.jvm.JvmName
/**
* Provides an IAM policy attached to a group.
* > **NOTE:** We suggest using explicit JSON encoding or `aws.iam.getPolicyDocument` when assigning a value to `policy`. They seamlessly translate configuration to JSON, enabling you to maintain consistency within your configuration without the need for context switches. Also, you can sidestep potential complications arising from formatting discrepancies, whitespace inconsistencies, and other nuances inherent to JSON.
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
* const myDevelopers = new aws.iam.Group("my_developers", {
* name: "developers",
* path: "/users/",
* });
* const myDeveloperPolicy = new aws.iam.GroupPolicy("my_developer_policy", {
* name: "my_developer_policy",
* group: myDevelopers.name,
* policy: JSON.stringify({
* Version: "2012-10-17",
* Statement: [{
* Action: ["ec2:Describe*"],
* Effect: "Allow",
* Resource: "*",
* }],
* }),
* });
* ```
* ```python
* import pulumi
* import json
* import pulumi_aws as aws
* my_developers = aws.iam.Group("my_developers",
* name="developers",
* path="/users/")
* my_developer_policy = aws.iam.GroupPolicy("my_developer_policy",
* name="my_developer_policy",
* group=my_developers.name,
* policy=json.dumps({
* "Version": "2012-10-17",
* "Statement": [{
* "Action": ["ec2:Describe*"],
* "Effect": "Allow",
* "Resource": "*",
* }],
* }))
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using System.Text.Json;
* using Pulumi;
* using Aws = Pulumi.Aws;
* return await Deployment.RunAsync(() =>
* {
* var myDevelopers = new Aws.Iam.Group("my_developers", new()
* {
* Name = "developers",
* Path = "/users/",
* });
* var myDeveloperPolicy = new Aws.Iam.GroupPolicy("my_developer_policy", new()
* {
* Name = "my_developer_policy",
* Group = myDevelopers.Name,
* Policy = JsonSerializer.Serialize(new Dictionary
* {
* ["Version"] = "2012-10-17",
* ["Statement"] = new[]
* {
* new Dictionary
* {
* ["Action"] = new[]
* {
* "ec2:Describe*",
* },
* ["Effect"] = "Allow",
* ["Resource"] = "*",
* },
* },
* }),
* });
* });
* ```
* ```go
* package main
* import (
* "encoding/json"
* "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 {
* myDevelopers, err := iam.NewGroup(ctx, "my_developers", &iam.GroupArgs{
* Name: pulumi.String("developers"),
* Path: pulumi.String("/users/"),
* })
* if err != nil {
* return err
* }
* tmpJSON0, err := json.Marshal(map[string]interface{}{
* "Version": "2012-10-17",
* "Statement": []map[string]interface{}{
* map[string]interface{}{
* "Action": []string{
* "ec2:Describe*",
* },
* "Effect": "Allow",
* "Resource": "*",
* },
* },
* })
* if err != nil {
* return err
* }
* json0 := string(tmpJSON0)
* _, err = iam.NewGroupPolicy(ctx, "my_developer_policy", &iam.GroupPolicyArgs{
* Name: pulumi.String("my_developer_policy"),
* Group: myDevelopers.Name,
* Policy: pulumi.String(json0),
* })
* 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.Group;
* import com.pulumi.aws.iam.GroupArgs;
* import com.pulumi.aws.iam.GroupPolicy;
* import com.pulumi.aws.iam.GroupPolicyArgs;
* import static com.pulumi.codegen.internal.Serialization.*;
* 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 myDevelopers = new Group("myDevelopers", GroupArgs.builder()
* .name("developers")
* .path("/users/")
* .build());
* var myDeveloperPolicy = new GroupPolicy("myDeveloperPolicy", GroupPolicyArgs.builder()
* .name("my_developer_policy")
* .group(myDevelopers.name())
* .policy(serializeJson(
* jsonObject(
* jsonProperty("Version", "2012-10-17"),
* jsonProperty("Statement", jsonArray(jsonObject(
* jsonProperty("Action", jsonArray("ec2:Describe*")),
* jsonProperty("Effect", "Allow"),
* jsonProperty("Resource", "*")
* )))
* )))
* .build());
* }
* }
* ```
* ```yaml
* resources:
* myDeveloperPolicy:
* type: aws:iam:GroupPolicy
* name: my_developer_policy
* properties:
* name: my_developer_policy
* group: ${myDevelopers.name}
* policy:
* fn::toJSON:
* Version: 2012-10-17
* Statement:
* - Action:
* - ec2:Describe*
* Effect: Allow
* Resource: '*'
* myDevelopers:
* type: aws:iam:Group
* name: my_developers
* properties:
* name: developers
* path: /users/
* ```
*
* ## Import
* Using `pulumi import`, import IAM Group Policies using the `group_name:group_policy_name`. For example:
* ```sh
* $ pulumi import aws:iam/groupPolicy:GroupPolicy mypolicy group_of_mypolicy_name:mypolicy_name
* ```
* @property group The IAM group to attach to the policy.
* @property name The name of the policy. If omitted, the provider will
* assign a random, unique name.
* @property namePrefix Creates a unique name beginning with the specified
* prefix. Conflicts with `name`.
* @property policy The policy document. This is a JSON formatted string.
*/
public data class GroupPolicyArgs(
public val group: Output? = null,
public val name: Output? = null,
public val namePrefix: Output? = null,
public val policy: Output? = null,
) : ConvertibleToJava {
override fun toJava(): com.pulumi.aws.iam.GroupPolicyArgs =
com.pulumi.aws.iam.GroupPolicyArgs.builder()
.group(group?.applyValue({ args0 -> args0 }))
.name(name?.applyValue({ args0 -> args0 }))
.namePrefix(namePrefix?.applyValue({ args0 -> args0 }))
.policy(policy?.applyValue({ args0 -> args0 })).build()
}
/**
* Builder for [GroupPolicyArgs].
*/
@PulumiTagMarker
public class GroupPolicyArgsBuilder internal constructor() {
private var group: Output? = null
private var name: Output? = null
private var namePrefix: Output? = null
private var policy: Output? = null
/**
* @param value The IAM group to attach to the policy.
*/
@JvmName("vyifipnngtmvcpus")
public suspend fun group(`value`: Output) {
this.group = value
}
/**
* @param value The name of the policy. If omitted, the provider will
* assign a random, unique name.
*/
@JvmName("qibblwicojrulxou")
public suspend fun name(`value`: Output) {
this.name = value
}
/**
* @param value Creates a unique name beginning with the specified
* prefix. Conflicts with `name`.
*/
@JvmName("surwwbswuwyusgrm")
public suspend fun namePrefix(`value`: Output) {
this.namePrefix = value
}
/**
* @param value The policy document. This is a JSON formatted string.
*/
@JvmName("oocysuepdmquwbxg")
public suspend fun policy(`value`: Output) {
this.policy = value
}
/**
* @param value The IAM group to attach to the policy.
*/
@JvmName("abtyvbdvckjjgboj")
public suspend fun group(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.group = mapped
}
/**
* @param value The name of the policy. If omitted, the provider will
* assign a random, unique name.
*/
@JvmName("ptscwohvwpuetnou")
public suspend fun name(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.name = mapped
}
/**
* @param value Creates a unique name beginning with the specified
* prefix. Conflicts with `name`.
*/
@JvmName("bbtfrwpmblyvuvku")
public suspend fun namePrefix(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.namePrefix = mapped
}
/**
* @param value The policy document. This is a JSON formatted string.
*/
@JvmName("gnvwotgaeuountvi")
public suspend fun policy(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.policy = mapped
}
internal fun build(): GroupPolicyArgs = GroupPolicyArgs(
group = group,
name = name,
namePrefix = namePrefix,
policy = policy,
)
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy