HmacKey class

The hmacKeys resource represents an HMAC key within Cloud Storage. The resource consists of a secret and HMAC key metadata. HMAC keys can be used as credentials for service accounts.

To get more information about HmacKey, see:

• API documentation
• How-to Guides
• Official Documentation

On import, the secret value will not be retrieved.

Example Usage

Storage Hmac Key

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

// Create a new service account
const serviceAccount = new gcp.serviceaccount.Account("service_account", {accountId: "my-svc-acc"});
//Create the HMAC key for the associated service account
const key = new gcp.storage.HmacKey("key", {serviceAccountEmail: serviceAccount.email});

import pulumi
import pulumi_gcp as gcp

# Create a new service account
service_account = gcp.serviceaccount.Account("service_account", account_id="my-svc-acc")
#Create the HMAC key for the associated service account
key = gcp.storage.HmacKey("key", service_account_email=service_account.email)

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

return await Deployment.RunAsync(() =>
{
    // Create a new service account
    var serviceAccount = new Gcp.ServiceAccount.Account("service_account", new()
    {
        AccountId = "my-svc-acc",
    });

    //Create the HMAC key for the associated service account
    var key = new Gcp.Storage.HmacKey("key", new()
    {
        ServiceAccountEmail = serviceAccount.Email,
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Create a new service account
		serviceAccount, err := serviceaccount.NewAccount(ctx, "service_account", &serviceaccount.AccountArgs{
			AccountId: pulumi.String("my-svc-acc"),
		})
		if err != nil {
			return err
		}
		// Create the HMAC key for the associated service account
		_, err = storage.NewHmacKey(ctx, "key", &storage.HmacKeyArgs{
			ServiceAccountEmail: serviceAccount.Email,
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

# Create a new service account
resource "gcp_serviceaccount_account" "service_account" {
  account_id = "my-svc-acc"
}
#Create the HMAC key for the associated service account
resource "gcp_storage_hmackey" "key" {
  service_account_email = gcp_serviceaccount_account.service_account.email
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.serviceaccount.Account;
import com.pulumi.gcp.serviceaccount.AccountArgs;
import com.pulumi.gcp.storage.HmacKey;
import com.pulumi.gcp.storage.HmacKeyArgs;
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) {
        // Create a new service account
        var serviceAccount = new Account("serviceAccount", AccountArgs.builder()
            .accountId("my-svc-acc")
            .build());

        //Create the HMAC key for the associated service account
        var key = new HmacKey("key", HmacKeyArgs.builder()
            .serviceAccountEmail(serviceAccount.email())
            .build());

    }
}

resources:
  # Create a new service account
  serviceAccount:
    type: gcp:serviceaccount:Account
    name: service_account
    properties:
      accountId: my-svc-acc
  #Create the HMAC key for the associated service account
  key:
    type: gcp:storage:HmacKey
    properties:
      serviceAccountEmail: ${serviceAccount.email}

Import

HmacKey can be imported using any of these accepted formats:

• projects/{{project}}/hmacKeys/{{access_id}}
• {{project}}/{{access_id}}
• {{access_id}}

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

$ pulumi import gcp:storage/hmacKey:HmacKey default projects/{{project}}/hmacKeys/{{access_id}}
$ pulumi import gcp:storage/hmacKey:HmacKey default {{project}}/{{access_id}}
$ pulumi import gcp:storage/hmacKey:HmacKey default {{access_id}}

Constructors

HmacKey(String name, {HmacKeyArgs? args, CustomResourceOptions? options})

Creates a new HmacKey. name The Pulumi resource name. args Arguments used to configure this HmacKey. The set of arguments for HmacKey. options Resource options controlling this resource's behavior.

HmacKey.reference(String urn)

Creates a typed reference to an existing HmacKey resource.

Properties

accessId ↔ Output<String>

The access ID of the HMAC Key.

late, final

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

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.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

project ↔ Output<String>

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

secret ↔ Output<String>

HMAC secret key material. Note: This property is sensitive and will not be displayed in the plan.

late, final

serviceAccountEmail ↔ Output<String>

The email address of the key's associated service account.

late, final

state ↔ Output<String?>

The state of the key. Can be set to one of ACTIVE, INACTIVE. Default value is ACTIVE. Possible values are: ACTIVE, INACTIVE.

late, final

timeCreated ↔ Output<String>

'The creation time of the HMAC key in RFC 3339 format. '

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

updated ↔ Output<String>

'The last modification time of the HMAC key metadata in RFC 3339 format.'

late, final

urn ↔ Output<String>

late, final, inherited

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, {HmacKeyState? state, CustomResourceOptions? options}) → HmacKey

Gets an existing HmacKey resource's state with the given name and id.