Kmsconfig class

NetApp Volumes always encrypts your data at rest using volume-specific keys.

A CMEK policy (customer-managed encryption key) warps such volume-specific keys in a key stored in Cloud Key Management Service (KMS).

To get more information about kmsconfig, see:

Example Usage

Kms Config Create

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const kmsConfig = new gcp.netapp.Kmsconfig("kmsConfig", {
    name: "kms-test",
    description: "this is a test description",
    cryptoKeyName: "crypto-name",
    location: "us-central1",
});

import pulumi
import pulumi_gcp as gcp

kms_config = gcp.netapp.Kmsconfig("kmsConfig",
    name="kms-test",
    description="this is a test description",
    crypto_key_name="crypto-name",
    location="us-central1")

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var kmsConfig = new Gcp.Netapp.Kmsconfig("kmsConfig", new()
    {
        Name = "kms-test",
        Description = "this is a test description",
        CryptoKeyName = "crypto-name",
        Location = "us-central1",
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/netapp"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := netapp.NewKmsconfig(ctx, "kmsConfig", &netapp.KmsconfigArgs{
			Name:          pulumi.String("kms-test"),
			Description:   pulumi.String("this is a test description"),
			CryptoKeyName: pulumi.String("crypto-name"),
			Location:      pulumi.String("us-central1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_netapp_kmsconfig" "kmsConfig" {
  name            = "kms-test"
  description     = "this is a test description"
  crypto_key_name = "crypto-name"
  location        = "us-central1"
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.netapp.Kmsconfig;
import com.pulumi.gcp.netapp.KmsconfigArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 kmsConfig = new Kmsconfig("kmsConfig", KmsconfigArgs.builder()
            .name("kms-test")
            .description("this is a test description")
            .cryptoKeyName("crypto-name")
            .location("us-central1")
            .build());

    }
}

resources:
  kmsConfig:
    type: gcp:netapp:Kmsconfig
    properties:
      name: kms-test
      description: this is a test description
      cryptoKeyName: crypto-name
      location: us-central1

Import

kmsconfig can be imported using any of these accepted formats:

projects/{{project}}/locations/{{location}}/kmsConfigs/{{name}}
{{project}}/{{location}}/{{name}}
{{location}}/{{name}}

When using the pulumi import command, kmsconfig can be imported using one of the formats above. For example:

$ pulumi import gcp:netapp/kmsconfig:Kmsconfig default projects/{{project}}/locations/{{location}}/kmsConfigs/{{name}}
$ pulumi import gcp:netapp/kmsconfig:Kmsconfig default {{project}}/{{location}}/{{name}}
$ pulumi import gcp:netapp/kmsconfig:Kmsconfig default {{location}}/{{name}}

Constructors

Kmsconfig(String name, {KmsconfigArgs? args, CustomResourceOptions? options}): Creates a new Kmsconfig. name The Pulumi resource name. args Arguments used to configure this Kmsconfig. The set of arguments for Kmsconfig. options Resource options controlling this resource's behavior.
Kmsconfig.reference(String urn): Creates a typed reference to an existing Kmsconfig resource.

Properties

childResources → Set<Resource>: finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>: latefinalinherited
cryptoKeyName ↔ Output<String>: Resource name of the KMS key to use. Only regional keys are supported. Format: projects/{{project}}/locations/{{location}}/keyRings/{{key_ring}}/cryptoKeys/{{key}}.
latefinal
deletionPolicy ↔ Output<String>: Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
latefinal
description ↔ Output<String?>: Description for the CMEK policy.
latefinal
effectiveLabels ↔ Output<Map<String, String>>: All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
latefinal
hashCode → int: The hash code for this object.
no setterinherited
id ↔ Output<String>: getter/setter pairinherited
instructions ↔ Output<String>: Access to the key needs to be granted. The instructions contain gcloud commands to run to grant access. To make the policy work, a CMEK policy check is required, which verifies key access.
latefinal
isCustom → bool: Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool: Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool: Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool: Whether this instance represents a resource value returned over RPC.
finalinherited
labels ↔ Output<Map<String, String>?>: Labels as key value pairs. Example: { "owner": "Bob", "department": "finance", "purpose": "testing" }.
latefinal
location ↔ Output<String>: Name of the policy location. CMEK policies apply to the whole region.
latefinal
name ↔ Output<String>: Name of the CMEK policy.
latefinal
project ↔ Output<String>: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
latefinal
pulumiLabels ↔ Output<Map<String, String>>: The combination of labels configured directly on the resource and default labels configured on the provider.
latefinal
resourceTransforms → List<ResourceTransform>: Inherited/explicit async transforms.
no setterinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
serviceAccount ↔ Output<String>: The Service account which needs to have access to the provided KMS key.
latefinal
transformations → List<ResourceTransformation>: Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>: latefinalinherited

Methods

failId(Object error) → void: Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void: Completes all output properties with error.
inherited
failUrn(Object error) → void: Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?: Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String: Returns this resource's logical name.
inherited
getResourceType() → String: Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>: Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void: Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void: Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void: Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>: Serializes resource properties for RPC transmission.
inherited
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {KmsconfigState? state, CustomResourceOptions? options}) → Kmsconfig: Gets an existing Kmsconfig resource's state with the given name and id.