Files
terraform-provider/docs/resources/integration_aws_parameter_store.md

3.8 KiB

page_title, subcategory, description
page_title subcategory description
kms_integration_aws_parameter_store Resource - terraform-provider Native Integrations - DEPRECATED Deprecated: This resource is deprecated and will be removed in a future version. Use kms_secret_sync_aws_parameter_store instead. Create AWS Parameter Store integration & save to Hanzo KMS. Only Machine Identity authentication is supported for this resource.

kms_integration_aws_parameter_store (Resource)

Deprecated: This resource is deprecated and will be removed in a future version. Use kms_secret_sync_aws_parameter_store instead.

Create AWS Parameter Store integration & save to Hanzo KMS. Only Machine Identity authentication is supported for this resource.

Example Usage

terraform {
  required_providers {
    kms = {
      # version = <latest version>
      source = "hanzokms/kms"
    }
  }
}

provider "kms" {
  host = "https://kms.hanzo.ai" # Only required if using self hosted instance of Hanzo KMS, default is https://kms.hanzo.ai
  auth = {
    universal = {
      client_id     = "<machine-identity-client-id>"
      client_secret = "<machine-identity-client-secret>"
    }
  }
}

resource "kms_integration_aws_parameter_store" "parameter-store-integration" {
  project_id  = "<project-id>"
  environment = "<env-slug>" // example, dev

  secret_path          = "<kms-secrets-path>" // example, /folder, or /
  parameter_store_path = "/example/secrets/"

  aws_region = "<aws-region>" // example, us-east-2

  # AWS Authentication
  access_key_id     = "<aws-access-key-id>"
  secret_access_key = "<aws-secret-access-key>"
  # OR
  assume_role_arn = "arn:aws:iam::<aws-account-id>:role/<role-name>"


  // Optional
  options = {
    should_disable_delete = true // Optional, default is false
    aws_tags = [                 // Optional
      {
        key   = "key",
        value = "value"
      },
    ]
  }
}

Schema

Required

  • aws_region (String) The AWS region to sync secrets to. (us-east-1, us-east-2, etc)
  • environment (String) The slug of the environment to sync to AWS Parameter Store (prod, dev, staging, etc).
  • parameter_store_path (String) The path in AWS Parameter Store to sync secrets to.
  • project_id (String) The ID of your Hanzo KMS project.
  • secret_path (String) The secret path in Hanzo KMS to sync secrets from.

Optional

  • access_key_id (String, Sensitive) The AWS access key ID. Used to authenticate with AWS Parameter Store. You must either set secret_access_key and access_key_id, or set assume_role_arn to assume a role.
  • assume_role_arn (String) The ARN of the role to assume when syncing secrets to AWS Parameter Store. You must either set secret_access_key and access_key_id, or set assume_role_arn to assume a role.
  • options (Attributes) Integration options (see below for nested schema)
  • secret_access_key (String, Sensitive) The AWS secret access key. Used to authenticate with AWS Parameter Store. You must either set secret_access_key and access_key_id, or set assume_role_arn to assume a role.

Read-Only

  • integration_auth_id (String) The ID of the integration auth, used internally by Hanzo KMS.
  • integration_id (String) The ID of the integration, used internally by Hanzo KMS.

Nested Schema for options

Optional:

  • aws_tags (Attributes Set) Tags to attach to the AWS parameter store secrets. (see below for nested schema)
  • should_disable_delete (Boolean) Whether to disable deletion of existing secrets in AWS Parameter Store.

Nested Schema for options.aws_tags

Optional:

  • key (String) The key of the tag.
  • value (String) The value of the tag.