com.pulumi.gcp.secretmanager.kotlin.Secret.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-gcp-kotlin Show documentation
Show all versions of pulumi-gcp-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.gcp.secretmanager.kotlin
import com.pulumi.core.Output
import com.pulumi.gcp.secretmanager.kotlin.outputs.SecretReplication
import com.pulumi.gcp.secretmanager.kotlin.outputs.SecretRotation
import com.pulumi.gcp.secretmanager.kotlin.outputs.SecretTopic
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.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import kotlin.collections.Map
import com.pulumi.gcp.secretmanager.kotlin.outputs.SecretReplication.Companion.toKotlin as secretReplicationToKotlin
import com.pulumi.gcp.secretmanager.kotlin.outputs.SecretRotation.Companion.toKotlin as secretRotationToKotlin
import com.pulumi.gcp.secretmanager.kotlin.outputs.SecretTopic.Companion.toKotlin as secretTopicToKotlin
/**
* Builder for [Secret].
*/
@PulumiTagMarker
public class SecretResourceBuilder internal constructor() {
public var name: String? = null
public var args: SecretArgs = SecretArgs()
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 SecretArgsBuilder.() -> Unit) {
val builder = SecretArgsBuilder()
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(): Secret {
val builtJavaResource = com.pulumi.gcp.secretmanager.Secret(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return Secret(builtJavaResource)
}
}
/**
* A Secret is a logical secret whose value and versions can be accessed.
* To get more information about Secret, see:
* * [API documentation](https://cloud.google.com/secret-manager/docs/reference/rest/v1/projects.secrets)
* ## Example Usage
* ### Secret Config Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
* const secret_basic = new gcp.secretmanager.Secret("secret-basic", {
* secretId: "secret",
* labels: {
* label: "my-label",
* },
* replication: {
* userManaged: {
* replicas: [
* {
* location: "us-central1",
* },
* {
* location: "us-east1",
* },
* ],
* },
* },
* });
* ```
* ```python
* import pulumi
* import pulumi_gcp as gcp
* secret_basic = gcp.secretmanager.Secret("secret-basic",
* secret_id="secret",
* labels={
* "label": "my-label",
* },
* replication=gcp.secretmanager.SecretReplicationArgs(
* user_managed=gcp.secretmanager.SecretReplicationUserManagedArgs(
* replicas=[
* gcp.secretmanager.SecretReplicationUserManagedReplicaArgs(
* location="us-central1",
* ),
* gcp.secretmanager.SecretReplicationUserManagedReplicaArgs(
* location="us-east1",
* ),
* ],
* ),
* ))
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Gcp = Pulumi.Gcp;
* return await Deployment.RunAsync(() =>
* {
* var secret_basic = new Gcp.SecretManager.Secret("secret-basic", new()
* {
* SecretId = "secret",
* Labels =
* {
* { "label", "my-label" },
* },
* Replication = new Gcp.SecretManager.Inputs.SecretReplicationArgs
* {
* UserManaged = new Gcp.SecretManager.Inputs.SecretReplicationUserManagedArgs
* {
* Replicas = new[]
* {
* new Gcp.SecretManager.Inputs.SecretReplicationUserManagedReplicaArgs
* {
* Location = "us-central1",
* },
* new Gcp.SecretManager.Inputs.SecretReplicationUserManagedReplicaArgs
* {
* Location = "us-east1",
* },
* },
* },
* },
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/secretmanager"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* _, err := secretmanager.NewSecret(ctx, "secret-basic", &secretmanager.SecretArgs{
* SecretId: pulumi.String("secret"),
* Labels: pulumi.StringMap{
* "label": pulumi.String("my-label"),
* },
* Replication: &secretmanager.SecretReplicationArgs{
* UserManaged: &secretmanager.SecretReplicationUserManagedArgs{
* Replicas: secretmanager.SecretReplicationUserManagedReplicaArray{
* &secretmanager.SecretReplicationUserManagedReplicaArgs{
* Location: pulumi.String("us-central1"),
* },
* &secretmanager.SecretReplicationUserManagedReplicaArgs{
* Location: pulumi.String("us-east1"),
* },
* },
* },
* },
* })
* 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.gcp.secretmanager.Secret;
* import com.pulumi.gcp.secretmanager.SecretArgs;
* import com.pulumi.gcp.secretmanager.inputs.SecretReplicationArgs;
* import com.pulumi.gcp.secretmanager.inputs.SecretReplicationUserManagedArgs;
* 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 secret_basic = new Secret("secret-basic", SecretArgs.builder()
* .secretId("secret")
* .labels(Map.of("label", "my-label"))
* .replication(SecretReplicationArgs.builder()
* .userManaged(SecretReplicationUserManagedArgs.builder()
* .replicas(
* SecretReplicationUserManagedReplicaArgs.builder()
* .location("us-central1")
* .build(),
* SecretReplicationUserManagedReplicaArgs.builder()
* .location("us-east1")
* .build())
* .build())
* .build())
* .build());
* }
* }
* ```
* ```yaml
* resources:
* secret-basic:
* type: gcp:secretmanager:Secret
* properties:
* secretId: secret
* labels:
* label: my-label
* replication:
* userManaged:
* replicas:
* - location: us-central1
* - location: us-east1
* ```
*
* ### Secret With Annotations
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
* const secret_with_annotations = new gcp.secretmanager.Secret("secret-with-annotations", {
* secretId: "secret",
* labels: {
* label: "my-label",
* },
* annotations: {
* key1: "someval",
* key2: "someval2",
* key3: "someval3",
* key4: "someval4",
* key5: "someval5",
* },
* replication: {
* auto: {},
* },
* });
* ```
* ```python
* import pulumi
* import pulumi_gcp as gcp
* secret_with_annotations = gcp.secretmanager.Secret("secret-with-annotations",
* secret_id="secret",
* labels={
* "label": "my-label",
* },
* annotations={
* "key1": "someval",
* "key2": "someval2",
* "key3": "someval3",
* "key4": "someval4",
* "key5": "someval5",
* },
* replication=gcp.secretmanager.SecretReplicationArgs(
* auto=gcp.secretmanager.SecretReplicationAutoArgs(),
* ))
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Gcp = Pulumi.Gcp;
* return await Deployment.RunAsync(() =>
* {
* var secret_with_annotations = new Gcp.SecretManager.Secret("secret-with-annotations", new()
* {
* SecretId = "secret",
* Labels =
* {
* { "label", "my-label" },
* },
* Annotations =
* {
* { "key1", "someval" },
* { "key2", "someval2" },
* { "key3", "someval3" },
* { "key4", "someval4" },
* { "key5", "someval5" },
* },
* Replication = new Gcp.SecretManager.Inputs.SecretReplicationArgs
* {
* Auto = null,
* },
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/secretmanager"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* _, err := secretmanager.NewSecret(ctx, "secret-with-annotations", &secretmanager.SecretArgs{
* SecretId: pulumi.String("secret"),
* Labels: pulumi.StringMap{
* "label": pulumi.String("my-label"),
* },
* Annotations: pulumi.StringMap{
* "key1": pulumi.String("someval"),
* "key2": pulumi.String("someval2"),
* "key3": pulumi.String("someval3"),
* "key4": pulumi.String("someval4"),
* "key5": pulumi.String("someval5"),
* },
* Replication: &secretmanager.SecretReplicationArgs{
* Auto: nil,
* },
* })
* 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.gcp.secretmanager.Secret;
* import com.pulumi.gcp.secretmanager.SecretArgs;
* import com.pulumi.gcp.secretmanager.inputs.SecretReplicationArgs;
* import com.pulumi.gcp.secretmanager.inputs.SecretReplicationAutoArgs;
* 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 secret_with_annotations = new Secret("secret-with-annotations", SecretArgs.builder()
* .secretId("secret")
* .labels(Map.of("label", "my-label"))
* .annotations(Map.ofEntries(
* Map.entry("key1", "someval"),
* Map.entry("key2", "someval2"),
* Map.entry("key3", "someval3"),
* Map.entry("key4", "someval4"),
* Map.entry("key5", "someval5")
* ))
* .replication(SecretReplicationArgs.builder()
* .auto()
* .build())
* .build());
* }
* }
* ```
* ```yaml
* resources:
* secret-with-annotations:
* type: gcp:secretmanager:Secret
* properties:
* secretId: secret
* labels:
* label: my-label
* annotations:
* key1: someval
* key2: someval2
* key3: someval3
* key4: someval4
* key5: someval5
* replication:
* auto: {}
* ```
*
* ### Secret With Version Destroy Ttl
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
* const secret_with_version_destroy_ttl = new gcp.secretmanager.Secret("secret-with-version-destroy-ttl", {
* secretId: "secret",
* versionDestroyTtl: "2592000s",
* replication: {
* auto: {},
* },
* });
* ```
* ```python
* import pulumi
* import pulumi_gcp as gcp
* secret_with_version_destroy_ttl = gcp.secretmanager.Secret("secret-with-version-destroy-ttl",
* secret_id="secret",
* version_destroy_ttl="2592000s",
* replication=gcp.secretmanager.SecretReplicationArgs(
* auto=gcp.secretmanager.SecretReplicationAutoArgs(),
* ))
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Gcp = Pulumi.Gcp;
* return await Deployment.RunAsync(() =>
* {
* var secret_with_version_destroy_ttl = new Gcp.SecretManager.Secret("secret-with-version-destroy-ttl", new()
* {
* SecretId = "secret",
* VersionDestroyTtl = "2592000s",
* Replication = new Gcp.SecretManager.Inputs.SecretReplicationArgs
* {
* Auto = null,
* },
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/secretmanager"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* _, err := secretmanager.NewSecret(ctx, "secret-with-version-destroy-ttl", &secretmanager.SecretArgs{
* SecretId: pulumi.String("secret"),
* VersionDestroyTtl: pulumi.String("2592000s"),
* Replication: &secretmanager.SecretReplicationArgs{
* Auto: nil,
* },
* })
* 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.gcp.secretmanager.Secret;
* import com.pulumi.gcp.secretmanager.SecretArgs;
* import com.pulumi.gcp.secretmanager.inputs.SecretReplicationArgs;
* import com.pulumi.gcp.secretmanager.inputs.SecretReplicationAutoArgs;
* 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 secret_with_version_destroy_ttl = new Secret("secret-with-version-destroy-ttl", SecretArgs.builder()
* .secretId("secret")
* .versionDestroyTtl("2592000s")
* .replication(SecretReplicationArgs.builder()
* .auto()
* .build())
* .build());
* }
* }
* ```
* ```yaml
* resources:
* secret-with-version-destroy-ttl:
* type: gcp:secretmanager:Secret
* properties:
* secretId: secret
* versionDestroyTtl: 2592000s
* replication:
* auto: {}
* ```
*
* ### Secret With Automatic Cmek
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
* const project = gcp.organizations.getProject({});
* const kms_secret_binding = new gcp.kms.CryptoKeyIAMMember("kms-secret-binding", {
* cryptoKeyId: "kms-key",
* role: "roles/cloudkms.cryptoKeyEncrypterDecrypter",
* member: project.then(project => `serviceAccount:service-${project.number}@gcp-sa-secretmanager.iam.gserviceaccount.com`),
* });
* const secret_with_automatic_cmek = new gcp.secretmanager.Secret("secret-with-automatic-cmek", {
* secretId: "secret",
* replication: {
* auto: {
* customerManagedEncryption: {
* kmsKeyName: "kms-key",
* },
* },
* },
* });
* ```
* ```python
* import pulumi
* import pulumi_gcp as gcp
* project = gcp.organizations.get_project()
* kms_secret_binding = gcp.kms.CryptoKeyIAMMember("kms-secret-binding",
* crypto_key_id="kms-key",
* role="roles/cloudkms.cryptoKeyEncrypterDecrypter",
* member=f"serviceAccount:service-{project.number}@gcp-sa-secretmanager.iam.gserviceaccount.com")
* secret_with_automatic_cmek = gcp.secretmanager.Secret("secret-with-automatic-cmek",
* secret_id="secret",
* replication=gcp.secretmanager.SecretReplicationArgs(
* auto=gcp.secretmanager.SecretReplicationAutoArgs(
* customer_managed_encryption=gcp.secretmanager.SecretReplicationAutoCustomerManagedEncryptionArgs(
* kms_key_name="kms-key",
* ),
* ),
* ))
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Gcp = Pulumi.Gcp;
* return await Deployment.RunAsync(() =>
* {
* var project = Gcp.Organizations.GetProject.Invoke();
* var kms_secret_binding = new Gcp.Kms.CryptoKeyIAMMember("kms-secret-binding", new()
* {
* CryptoKeyId = "kms-key",
* Role = "roles/cloudkms.cryptoKeyEncrypterDecrypter",
* Member = $"serviceAccount:service-{project.Apply(getProjectResult => getProjectResult.Number)}@gcp-sa-secretmanager.iam.gserviceaccount.com",
* });
* var secret_with_automatic_cmek = new Gcp.SecretManager.Secret("secret-with-automatic-cmek", new()
* {
* SecretId = "secret",
* Replication = new Gcp.SecretManager.Inputs.SecretReplicationArgs
* {
* Auto = new Gcp.SecretManager.Inputs.SecretReplicationAutoArgs
* {
* CustomerManagedEncryption = new Gcp.SecretManager.Inputs.SecretReplicationAutoCustomerManagedEncryptionArgs
* {
* KmsKeyName = "kms-key",
* },
* },
* },
* });
* });
* ```
* ```go
* package main
* import (
* "fmt"
* "github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/kms"
* "github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/organizations"
* "github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/secretmanager"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* project, err := organizations.LookupProject(ctx, nil, nil)
* if err != nil {
* return err
* }
* _, err = kms.NewCryptoKeyIAMMember(ctx, "kms-secret-binding", &kms.CryptoKeyIAMMemberArgs{
* CryptoKeyId: pulumi.String("kms-key"),
* Role: pulumi.String("roles/cloudkms.cryptoKeyEncrypterDecrypter"),
* Member: pulumi.String(fmt.Sprintf("serviceAccount:service-%[email protected]", project.Number)),
* })
* if err != nil {
* return err
* }
* _, err = secretmanager.NewSecret(ctx, "secret-with-automatic-cmek", &secretmanager.SecretArgs{
* SecretId: pulumi.String("secret"),
* Replication: &secretmanager.SecretReplicationArgs{
* Auto: &secretmanager.SecretReplicationAutoArgs{
* CustomerManagedEncryption: &secretmanager.SecretReplicationAutoCustomerManagedEncryptionArgs{
* KmsKeyName: pulumi.String("kms-key"),
* },
* },
* },
* })
* 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.gcp.organizations.OrganizationsFunctions;
* import com.pulumi.gcp.organizations.inputs.GetProjectArgs;
* import com.pulumi.gcp.kms.CryptoKeyIAMMember;
* import com.pulumi.gcp.kms.CryptoKeyIAMMemberArgs;
* import com.pulumi.gcp.secretmanager.Secret;
* import com.pulumi.gcp.secretmanager.SecretArgs;
* import com.pulumi.gcp.secretmanager.inputs.SecretReplicationArgs;
* import com.pulumi.gcp.secretmanager.inputs.SecretReplicationAutoArgs;
* import com.pulumi.gcp.secretmanager.inputs.SecretReplicationAutoCustomerManagedEncryptionArgs;
* 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) {
* final var project = OrganizationsFunctions.getProject();
* var kms_secret_binding = new CryptoKeyIAMMember("kms-secret-binding", CryptoKeyIAMMemberArgs.builder()
* .cryptoKeyId("kms-key")
* .role("roles/cloudkms.cryptoKeyEncrypterDecrypter")
* .member(String.format("serviceAccount:service-%[email protected]", project.applyValue(getProjectResult -> getProjectResult.number())))
* .build());
* var secret_with_automatic_cmek = new Secret("secret-with-automatic-cmek", SecretArgs.builder()
* .secretId("secret")
* .replication(SecretReplicationArgs.builder()
* .auto(SecretReplicationAutoArgs.builder()
* .customerManagedEncryption(SecretReplicationAutoCustomerManagedEncryptionArgs.builder()
* .kmsKeyName("kms-key")
* .build())
* .build())
* .build())
* .build());
* }
* }
* ```
* ```yaml
* resources:
* kms-secret-binding:
* type: gcp:kms:CryptoKeyIAMMember
* properties:
* cryptoKeyId: kms-key
* role: roles/cloudkms.cryptoKeyEncrypterDecrypter
* member: serviceAccount:service-${project.number}@gcp-sa-secretmanager.iam.gserviceaccount.com
* secret-with-automatic-cmek:
* type: gcp:secretmanager:Secret
* properties:
* secretId: secret
* replication:
* auto:
* customerManagedEncryption:
* kmsKeyName: kms-key
* variables:
* project:
* fn::invoke:
* Function: gcp:organizations:getProject
* Arguments: {}
* ```
*
* ## Import
* Secret can be imported using any of these accepted formats:
* * `projects/{{project}}/secrets/{{secret_id}}`
* * `{{project}}/{{secret_id}}`
* * `{{secret_id}}`
* When using the `pulumi import` command, Secret can be imported using one of the formats above. For example:
* ```sh
* $ pulumi import gcp:secretmanager/secret:Secret default projects/{{project}}/secrets/{{secret_id}}
* ```
* ```sh
* $ pulumi import gcp:secretmanager/secret:Secret default {{project}}/{{secret_id}}
* ```
* ```sh
* $ pulumi import gcp:secretmanager/secret:Secret default {{secret_id}}
* ```
*/
public class Secret internal constructor(
override val javaResource: com.pulumi.gcp.secretmanager.Secret,
) : KotlinCustomResource(javaResource, SecretMapper) {
/**
* Custom metadata about the secret. Annotations are distinct from various forms of labels. Annotations exist to allow
* client tools to store their own state information without requiring a database. Annotation keys must be between 1 and 63
* characters long, have a UTF-8 encoding of maximum 128 bytes, begin and end with an alphanumeric character ([a-z0-9A-Z]),
* and may have dashes (-), underscores (_), dots (.), and alphanumerics in between these symbols. The total size of
* annotation keys and values must be less than 16KiB. An object containing a list of "key": value pairs. Example: {
* "name": "wrench", "mass": "1.3kg", "count": "3" }. **Note**: This field is non-authoritative, and will only manage the
* annotations present in your configuration. Please refer to the field 'effective_annotations' for all of the annotations
* present on the resource.
*/
public val annotations: Output
© 2015 - 2024 Weber Informatics LLC | Privacy Policy