1. Registry
  2. Packages
  3. Google Cloud Native
  4. API Docs
  5. storage
  6. storage/v1
  7. HmacKey

This package is deprecated. Active development has stopped. We recommend using the Google Cloud package instead.

Viewing docs for Google Cloud Native v0.32.0
published on Wednesday, Nov 29, 2023 by Pulumi
google-native logo Google Cloud Native

This package is deprecated. Active development has stopped. We recommend using the Google Cloud package instead.

Viewing docs for Google Cloud Native v0.32.0
published on Wednesday, Nov 29, 2023 by Pulumi

    Creates a new HMAC key for the specified service account. Auto-naming is currently not supported for this resource.

    Create HmacKey Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new HmacKey(name: string, args: HmacKeyArgs, opts?: CustomResourceOptions);
    @overload
    def HmacKey(resource_name: str,
                args: HmacKeyArgs,
                opts: Optional[ResourceOptions] = None)
    
    @overload
    def HmacKey(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                service_account_email: Optional[str] = None,
                project: Optional[str] = None,
                user_project: Optional[str] = None)
    func NewHmacKey(ctx *Context, name string, args HmacKeyArgs, opts ...ResourceOption) (*HmacKey, error)
    public HmacKey(string name, HmacKeyArgs args, CustomResourceOptions? opts = null)
    public HmacKey(String name, HmacKeyArgs args)
    public HmacKey(String name, HmacKeyArgs args, CustomResourceOptions options)
    
    type: google-native:storage/v1:HmacKey
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "google-native_storage_v1_hmac_key" "name" {
        # resource properties
    }

    Parameters

    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.
    args HmacKeyArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control 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.
    name String
    The unique name of the resource.
    args HmacKeyArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var hmacKeyResource = new GoogleNative.Storage.V1.HmacKey("hmacKeyResource", new()
    {
        ServiceAccountEmail = "string",
        Project = "string",
        UserProject = "string",
    });
    
    example, err := storage.NewHmacKey(ctx, "hmacKeyResource", &storage.HmacKeyArgs{
    	ServiceAccountEmail: pulumi.String("string"),
    	Project:             pulumi.String("string"),
    	UserProject:         pulumi.String("string"),
    })
    
    resource "google-native_storage_v1_hmac_key" "hmacKeyResource" {
      lifecycle {
        create_before_destroy = true
      }
      service_account_email = "string"
      project               = "string"
      user_project          = "string"
    }
    
    var hmacKeyResource = new HmacKey("hmacKeyResource", HmacKeyArgs.builder()
        .serviceAccountEmail("string")
        .project("string")
        .userProject("string")
        .build());
    
    hmac_key_resource = google_native.storage.v1.HmacKey("hmacKeyResource",
        service_account_email="string",
        project="string",
        user_project="string")
    
    const hmacKeyResource = new google_native.storage.v1.HmacKey("hmacKeyResource", {
        serviceAccountEmail: "string",
        project: "string",
        userProject: "string",
    });
    
    type: google-native:storage/v1:HmacKey
    properties:
        project: string
        serviceAccountEmail: string
        userProject: string
    

    HmacKey Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The HmacKey resource accepts the following input properties:

    ServiceAccountEmail string
    Email address of the service account.
    Project string
    UserProject string
    The project to be billed for this request.
    ServiceAccountEmail string
    Email address of the service account.
    Project string
    UserProject string
    The project to be billed for this request.
    service_account_email string
    Email address of the service account.
    project string
    user_project string
    The project to be billed for this request.
    serviceAccountEmail String
    Email address of the service account.
    project String
    userProject String
    The project to be billed for this request.
    serviceAccountEmail string
    Email address of the service account.
    project string
    userProject string
    The project to be billed for this request.
    service_account_email str
    Email address of the service account.
    project str
    user_project str
    The project to be billed for this request.
    serviceAccountEmail String
    Email address of the service account.
    project String
    userProject String
    The project to be billed for this request.

    Outputs

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

    AccessId string
    The ID of the HMAC Key.
    Etag string
    HTTP 1.1 Entity tag for the HMAC key.
    Id string
    The provider-assigned unique ID for this managed resource.
    Kind string
    The kind of item this is. For HMAC Key metadata, this is always storage#hmacKeyMetadata.
    SelfLink string
    The link to this resource.
    State string
    The state of the key. Can be one of ACTIVE, INACTIVE, or DELETED.
    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 ID of the HMAC Key.
    Etag string
    HTTP 1.1 Entity tag for the HMAC key.
    Id string
    The provider-assigned unique ID for this managed resource.
    Kind string
    The kind of item this is. For HMAC Key metadata, this is always storage#hmacKeyMetadata.
    SelfLink string
    The link to this resource.
    State string
    The state of the key. Can be one of ACTIVE, INACTIVE, or DELETED.
    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 string
    The ID of the HMAC Key.
    etag string
    HTTP 1.1 Entity tag for the HMAC key.
    id string
    The provider-assigned unique ID for this managed resource.
    kind string
    The kind of item this is. For HMAC Key metadata, this is always storage#hmacKeyMetadata.
    self_link string
    The link to this resource.
    state string
    The state of the key. Can be one of ACTIVE, INACTIVE, or DELETED.
    time_created 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 ID of the HMAC Key.
    etag String
    HTTP 1.1 Entity tag for the HMAC key.
    id String
    The provider-assigned unique ID for this managed resource.
    kind String
    The kind of item this is. For HMAC Key metadata, this is always storage#hmacKeyMetadata.
    selfLink String
    The link to this resource.
    state String
    The state of the key. Can be one of ACTIVE, INACTIVE, or DELETED.
    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 ID of the HMAC Key.
    etag string
    HTTP 1.1 Entity tag for the HMAC key.
    id string
    The provider-assigned unique ID for this managed resource.
    kind string
    The kind of item this is. For HMAC Key metadata, this is always storage#hmacKeyMetadata.
    selfLink string
    The link to this resource.
    state string
    The state of the key. Can be one of ACTIVE, INACTIVE, or DELETED.
    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 ID of the HMAC Key.
    etag str
    HTTP 1.1 Entity tag for the HMAC key.
    id str
    The provider-assigned unique ID for this managed resource.
    kind str
    The kind of item this is. For HMAC Key metadata, this is always storage#hmacKeyMetadata.
    self_link str
    The link to this resource.
    state str
    The state of the key. Can be one of ACTIVE, INACTIVE, or DELETED.
    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.
    accessId String
    The ID of the HMAC Key.
    etag String
    HTTP 1.1 Entity tag for the HMAC key.
    id String
    The provider-assigned unique ID for this managed resource.
    kind String
    The kind of item this is. For HMAC Key metadata, this is always storage#hmacKeyMetadata.
    selfLink String
    The link to this resource.
    state String
    The state of the key. Can be one of ACTIVE, INACTIVE, or DELETED.
    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.

    Look up 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>, opts?: CustomResourceOptions): HmacKey
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None) -> HmacKey
    func GetHmacKey(ctx *Context, name string, id IDInput, state *HmacKeyState, opts ...ResourceOption) (*HmacKey, error)
    public static HmacKey Get(string name, Input<string> id, CustomResourceOptions? opts = null)
    public static HmacKey get(String name, Output<String> id, CustomResourceOptions options)
    resources:  existingHmacKey:    type: google-native:storage/v1:HmacKey    get:      id: ${id}
    import {
      to = google-native_storage_v1_hmac_key.example
      id = "${id}"
    }
    
    name string
    The unique name of the resulting resource.
    id Input<ID>
    The unique provider ID of the resource to look up.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resulting resource.
    id str
    The unique provider ID of the resource to look up.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resulting resource.
    id IDInput
    The unique provider ID of the resource to look up.
    state HmacKeyState
    Pass nil. This resource has no state arguments.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resulting resource.
    id Input<string>
    The unique provider ID of the resource to look up.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resulting resource.
    id Output<String>
    The unique provider ID of the resource to look up.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo Google Cloud Native

    This package is deprecated. Active development has stopped. We recommend using the Google Cloud package instead.

    Viewing docs for Google Cloud Native v0.32.0
    published on Wednesday, Nov 29, 2023 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial