1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. kms
  5. getKMSSecretCiphertext
Google Cloud Classic v6.58.0 published on Tuesday, Jun 6, 2023 by Pulumi

gcp.kms.getKMSSecretCiphertext

Explore with Pulumi AI

gcp logo
Google Cloud Classic v6.58.0 published on Tuesday, Jun 6, 2023 by Pulumi

    !> Warning: This data source is deprecated. Use the gcp.kms.SecretCiphertext resource instead.

    This data source allows you to encrypt data with Google Cloud KMS and use the ciphertext within your resource definitions.

    For more information see the official documentation.

    NOTE: Using this data source will allow you to conceal secret data within your resource definitions, but it does not take care of protecting that data in the logging output, plan output, or state output. Please take care to secure your secret data outside of resource definitions.

    Using getKMSSecretCiphertext

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getKMSSecretCiphertext(args: GetKMSSecretCiphertextArgs, opts?: InvokeOptions): Promise<GetKMSSecretCiphertextResult>
    function getKMSSecretCiphertextOutput(args: GetKMSSecretCiphertextOutputArgs, opts?: InvokeOptions): Output<GetKMSSecretCiphertextResult>
    def get_kms_secret_ciphertext(crypto_key: Optional[str] = None,
                                  plaintext: Optional[str] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetKMSSecretCiphertextResult
    def get_kms_secret_ciphertext_output(crypto_key: Optional[pulumi.Input[str]] = None,
                                  plaintext: Optional[pulumi.Input[str]] = None,
                                  opts: Optional[InvokeOptions] = None) -> Output[GetKMSSecretCiphertextResult]
    func GetKMSSecretCiphertext(ctx *Context, args *GetKMSSecretCiphertextArgs, opts ...InvokeOption) (*GetKMSSecretCiphertextResult, error)
    func GetKMSSecretCiphertextOutput(ctx *Context, args *GetKMSSecretCiphertextOutputArgs, opts ...InvokeOption) GetKMSSecretCiphertextResultOutput

    > Note: This function is named GetKMSSecretCiphertext in the Go SDK.

    public static class GetKMSSecretCiphertext 
    {
        public static Task<GetKMSSecretCiphertextResult> InvokeAsync(GetKMSSecretCiphertextArgs args, InvokeOptions? opts = null)
        public static Output<GetKMSSecretCiphertextResult> Invoke(GetKMSSecretCiphertextInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetKMSSecretCiphertextResult> getKMSSecretCiphertext(GetKMSSecretCiphertextArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: gcp:kms/getKMSSecretCiphertext:getKMSSecretCiphertext
      arguments:
        # arguments dictionary

    The following arguments are supported:

    CryptoKey string

    The id of the CryptoKey that will be used to encrypt the provided plaintext. This is represented by the format {projectId}/{location}/{keyRingName}/{cryptoKeyName}.

    Plaintext string

    The plaintext to be encrypted

    CryptoKey string

    The id of the CryptoKey that will be used to encrypt the provided plaintext. This is represented by the format {projectId}/{location}/{keyRingName}/{cryptoKeyName}.

    Plaintext string

    The plaintext to be encrypted

    cryptoKey String

    The id of the CryptoKey that will be used to encrypt the provided plaintext. This is represented by the format {projectId}/{location}/{keyRingName}/{cryptoKeyName}.

    plaintext String

    The plaintext to be encrypted

    cryptoKey string

    The id of the CryptoKey that will be used to encrypt the provided plaintext. This is represented by the format {projectId}/{location}/{keyRingName}/{cryptoKeyName}.

    plaintext string

    The plaintext to be encrypted

    crypto_key str

    The id of the CryptoKey that will be used to encrypt the provided plaintext. This is represented by the format {projectId}/{location}/{keyRingName}/{cryptoKeyName}.

    plaintext str

    The plaintext to be encrypted

    cryptoKey String

    The id of the CryptoKey that will be used to encrypt the provided plaintext. This is represented by the format {projectId}/{location}/{keyRingName}/{cryptoKeyName}.

    plaintext String

    The plaintext to be encrypted

    getKMSSecretCiphertext Result

    The following output properties are available:

    Ciphertext string

    Contains the result of encrypting the provided plaintext, encoded in base64.

    CryptoKey string
    Id string

    The provider-assigned unique ID for this managed resource.

    Plaintext string
    Ciphertext string

    Contains the result of encrypting the provided plaintext, encoded in base64.

    CryptoKey string
    Id string

    The provider-assigned unique ID for this managed resource.

    Plaintext string
    ciphertext String

    Contains the result of encrypting the provided plaintext, encoded in base64.

    cryptoKey String
    id String

    The provider-assigned unique ID for this managed resource.

    plaintext String
    ciphertext string

    Contains the result of encrypting the provided plaintext, encoded in base64.

    cryptoKey string
    id string

    The provider-assigned unique ID for this managed resource.

    plaintext string
    ciphertext str

    Contains the result of encrypting the provided plaintext, encoded in base64.

    crypto_key str
    id str

    The provider-assigned unique ID for this managed resource.

    plaintext str
    ciphertext String

    Contains the result of encrypting the provided plaintext, encoded in base64.

    cryptoKey String
    id String

    The provider-assigned unique ID for this managed resource.

    plaintext String

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the google-beta Terraform Provider.

    gcp logo
    Google Cloud Classic v6.58.0 published on Tuesday, Jun 6, 2023 by Pulumi