HmacKey

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

Warning: All arguments including the secret value will be stored in the raw state as plain-text. Read more about secrets in state. On import, the secret value will not be retrieved.
Warning: All arguments including secret will be stored in the raw state as plain-text. Read more about secrets in state.

Create a HmacKey Resource

new HmacKey(name: string, args: HmacKeyArgs, opts?: CustomResourceOptions);

def HmacKey(resource_name, opts=None, project=None, service_account_email=None, state=None, __props__=None);

func NewHmacKey(ctx *Context, name string, args HmacKeyArgs, opts ...ResourceOption) (*HmacKey, error)

public HmacKey(string name, HmacKeyArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args HmacKeyArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args HmacKeyArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args HmacKeyArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

HmacKey Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The HmacKey resource accepts the following input properties:

ServiceAccountEmail string: The email address of the key’s associated service account.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
State string: The state of the key. Can be set to one of ACTIVE, INACTIVE.

ServiceAccountEmail string: The email address of the key’s associated service account.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
State string: The state of the key. Can be set to one of ACTIVE, INACTIVE.

serviceAccountEmail string: The email address of the key’s associated service account.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
state string: The state of the key. Can be set to one of ACTIVE, INACTIVE.

service_account_email str: The email address of the key’s associated service account.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
state str: The state of the key. Can be set to one of ACTIVE, INACTIVE.

Outputs

All input properties are implicitly available as output properties. Additionally, the HmacKey resource produces the following output properties:

AccessId string: The access ID of the HMAC Key.
Id string: The provider-assigned unique ID for this managed resource.
Secret string: HMAC secret key material.
TimeCreated string: ‘The creation time of the HMAC key in RFC 3339 format. ‘
Updated string: ‘The last modification time of the HMAC key metadata in RFC 3339 format.’

AccessId string: The access ID of the HMAC Key.
Id string: The provider-assigned unique ID for this managed resource.
Secret string: HMAC secret key material.
TimeCreated string: ‘The creation time of the HMAC key in RFC 3339 format. ‘
Updated string: ‘The last modification time of the HMAC key metadata in RFC 3339 format.’

accessId string: The access ID of the HMAC Key.
id string: The provider-assigned unique ID for this managed resource.
secret string: HMAC secret key material.
timeCreated string: ‘The creation time of the HMAC key in RFC 3339 format. ‘
updated string: ‘The last modification time of the HMAC key metadata in RFC 3339 format.’

access_id str: The access ID of the HMAC Key.
id str: The provider-assigned unique ID for this managed resource.
secret str: HMAC secret key material.
time_created str: ‘The creation time of the HMAC key in RFC 3339 format. ‘
updated str: ‘The last modification time of the HMAC key metadata in RFC 3339 format.’

Look up an Existing HmacKey Resource

Get an existing HmacKey resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: HmacKeyState, opts?: CustomResourceOptions): HmacKey

static get(resource_name, id, opts=None, access_id=None, project=None, secret=None, service_account_email=None, state=None, time_created=None, updated=None, __props__=None);

func GetHmacKey(ctx *Context, name string, id IDInput, state *HmacKeyState, opts ...ResourceOption) (*HmacKey, error)

public static HmacKey Get(string name, Input<string> id, HmacKeyState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AccessId string: The access ID of the HMAC Key.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Secret string: HMAC secret key material.
ServiceAccountEmail string: The email address of the key’s associated service account.
State string: The state of the key. Can be set to one of ACTIVE, INACTIVE.
TimeCreated string: ‘The creation time of the HMAC key in RFC 3339 format. ‘
Updated string: ‘The last modification time of the HMAC key metadata in RFC 3339 format.’

AccessId string: The access ID of the HMAC Key.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Secret string: HMAC secret key material.
ServiceAccountEmail string: The email address of the key’s associated service account.
State string: The state of the key. Can be set to one of ACTIVE, INACTIVE.
TimeCreated string: ‘The creation time of the HMAC key in RFC 3339 format. ‘
Updated string: ‘The last modification time of the HMAC key metadata in RFC 3339 format.’

accessId string: The access ID of the HMAC Key.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
secret string: HMAC secret key material.
serviceAccountEmail string: The email address of the key’s associated service account.
state string: The state of the key. Can be set to one of ACTIVE, INACTIVE.
timeCreated string: ‘The creation time of the HMAC key in RFC 3339 format. ‘
updated string: ‘The last modification time of the HMAC key metadata in RFC 3339 format.’

access_id str: The access ID of the HMAC Key.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
secret str: HMAC secret key material.
service_account_email str: The email address of the key’s associated service account.
state str: The state of the key. Can be set to one of ACTIVE, INACTIVE.
time_created str: ‘The creation time of the HMAC key in RFC 3339 format. ‘
updated str: ‘The last modification time of the HMAC key metadata in RFC 3339 format.’

Package Details

Repository: https://github.com/pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud