com.pulumi.aws.elasticache.kotlin.UserGroup.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.elasticache.kotlin
import com.pulumi.core.Output
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.Deprecated
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import kotlin.collections.Map
/**
* Builder for [UserGroup].
*/
@PulumiTagMarker
public class UserGroupResourceBuilder internal constructor() {
public var name: String? = null
public var args: UserGroupArgs = UserGroupArgs()
public var opts: CustomResourceOptions = CustomResourceOptions()
/**
* @param name The _unique_ name of the resulting resource.
*/
public fun name(`value`: String) {
this.name = value
}
/**
* @param block The arguments to use to populate this resource's properties.
*/
public suspend fun args(block: suspend UserGroupArgsBuilder.() -> Unit) {
val builder = UserGroupArgsBuilder()
block(builder)
this.args = builder.build()
}
/**
* @param block A bag of options that control this resource's behavior.
*/
public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
}
internal fun build(): UserGroup {
val builtJavaResource = com.pulumi.aws.elasticache.UserGroup(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return UserGroup(builtJavaResource)
}
}
/**
* Provides an ElastiCache user group resource.
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
* const test = new aws.elasticache.User("test", {
* userId: "testUserId",
* userName: "default",
* accessString: "on ~app::* -@all +@read +@hash +@bitmap +@geo -setbit -bitfield -hset -hsetnx -hmset -hincrby -hincrbyfloat -hdel -bitop -geoadd -georadius -georadiusbymember",
* engine: "REDIS",
* passwords: ["password123456789"],
* });
* const testUserGroup = new aws.elasticache.UserGroup("test", {
* engine: "REDIS",
* userGroupId: "userGroupId",
* userIds: [test.userId],
* });
* ```
* ```python
* import pulumi
* import pulumi_aws as aws
* test = aws.elasticache.User("test",
* user_id="testUserId",
* user_name="default",
* access_string="on ~app::* -@all +@read +@hash +@bitmap +@geo -setbit -bitfield -hset -hsetnx -hmset -hincrby -hincrbyfloat -hdel -bitop -geoadd -georadius -georadiusbymember",
* engine="REDIS",
* passwords=["password123456789"])
* test_user_group = aws.elasticache.UserGroup("test",
* engine="REDIS",
* user_group_id="userGroupId",
* user_ids=[test.user_id])
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Aws = Pulumi.Aws;
* return await Deployment.RunAsync(() =>
* {
* var test = new Aws.ElastiCache.User("test", new()
* {
* UserId = "testUserId",
* UserName = "default",
* AccessString = "on ~app::* -@all +@read +@hash +@bitmap +@geo -setbit -bitfield -hset -hsetnx -hmset -hincrby -hincrbyfloat -hdel -bitop -geoadd -georadius -georadiusbymember",
* Engine = "REDIS",
* Passwords = new[]
* {
* "password123456789",
* },
* });
* var testUserGroup = new Aws.ElastiCache.UserGroup("test", new()
* {
* Engine = "REDIS",
* UserGroupId = "userGroupId",
* UserIds = new[]
* {
* test.UserId,
* },
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-aws/sdk/v6/go/aws/elasticache"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* test, err := elasticache.NewUser(ctx, "test", &elasticache.UserArgs{
* UserId: pulumi.String("testUserId"),
* UserName: pulumi.String("default"),
* AccessString: pulumi.String("on ~app::* -@all +@read +@hash +@bitmap +@geo -setbit -bitfield -hset -hsetnx -hmset -hincrby -hincrbyfloat -hdel -bitop -geoadd -georadius -georadiusbymember"),
* Engine: pulumi.String("REDIS"),
* Passwords: pulumi.StringArray{
* pulumi.String("password123456789"),
* },
* })
* if err != nil {
* return err
* }
* _, err = elasticache.NewUserGroup(ctx, "test", &elasticache.UserGroupArgs{
* Engine: pulumi.String("REDIS"),
* UserGroupId: pulumi.String("userGroupId"),
* UserIds: pulumi.StringArray{
* test.UserId,
* },
* })
* 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.elasticache.User;
* import com.pulumi.aws.elasticache.UserArgs;
* import com.pulumi.aws.elasticache.UserGroup;
* import com.pulumi.aws.elasticache.UserGroupArgs;
* 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 test = new User("test", UserArgs.builder()
* .userId("testUserId")
* .userName("default")
* .accessString("on ~app::* -@all +@read +@hash +@bitmap +@geo -setbit -bitfield -hset -hsetnx -hmset -hincrby -hincrbyfloat -hdel -bitop -geoadd -georadius -georadiusbymember")
* .engine("REDIS")
* .passwords("password123456789")
* .build());
* var testUserGroup = new UserGroup("testUserGroup", UserGroupArgs.builder()
* .engine("REDIS")
* .userGroupId("userGroupId")
* .userIds(test.userId())
* .build());
* }
* }
* ```
* ```yaml
* resources:
* test:
* type: aws:elasticache:User
* properties:
* userId: testUserId
* userName: default
* accessString: on ~app::* -@all +@read +@hash +@bitmap +@geo -setbit -bitfield -hset -hsetnx -hmset -hincrby -hincrbyfloat -hdel -bitop -geoadd -georadius -georadiusbymember
* engine: REDIS
* passwords:
* - password123456789
* testUserGroup:
* type: aws:elasticache:UserGroup
* name: test
* properties:
* engine: REDIS
* userGroupId: userGroupId
* userIds:
* - ${test.userId}
* ```
*
* ## Import
* Using `pulumi import`, import ElastiCache user groups using the `user_group_id`. For example:
* ```sh
* $ pulumi import aws:elasticache/userGroup:UserGroup my_user_group userGoupId1
* ```
*/
public class UserGroup internal constructor(
override val javaResource: com.pulumi.aws.elasticache.UserGroup,
) : KotlinCustomResource(javaResource, UserGroupMapper) {
/**
* The ARN that identifies the user group.
*/
public val arn: Output
get() = javaResource.arn().applyValue({ args0 -> args0 })
/**
* The current supported value is `REDIS`.
*/
public val engine: Output
get() = javaResource.engine().applyValue({ args0 -> args0 })
/**
* Key-value map of resource tags. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
public val tags: Output>?
get() = javaResource.tags().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
}).orElse(null)
})
/**
* A map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.
*/
@Deprecated(
message = """
Please use `tags` instead.
""",
)
public val tagsAll: Output>
get() = javaResource.tagsAll().applyValue({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
})
/**
* The ID of the user group.
* The following arguments are optional:
*/
public val userGroupId: Output
get() = javaResource.userGroupId().applyValue({ args0 -> args0 })
/**
* The list of user IDs that belong to the user group.
*/
public val userIds: Output>?
get() = javaResource.userIds().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0
})
}).orElse(null)
})
}
public object UserGroupMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.aws.elasticache.UserGroup::class == javaResource::class
override fun map(javaResource: Resource): UserGroup = UserGroup(
javaResource as
com.pulumi.aws.elasticache.UserGroup,
)
}
/**
* @see [UserGroup].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [UserGroup].
*/
public suspend fun userGroup(name: String, block: suspend UserGroupResourceBuilder.() -> Unit): UserGroup {
val builder = UserGroupResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [UserGroup].
* @param name The _unique_ name of the resulting resource.
*/
public fun userGroup(name: String): UserGroup {
val builder = UserGroupResourceBuilder()
builder.name(name)
return builder.build()
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy