ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm.getHpcsKeystore
Explore with Pulumi AI
Provides a read-only data source for keystore. You can then reference the fields of the data source in other resources within the same configuration using interpolation syntax.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";
const keystore = ibm.getHpcsKeystore({
instanceId: "76195d24-8a31-4c6d-9050-c35f09375cfb",
region: "us-east",
keystoreId: "d8cc1ef7-d13b-4731-95be-1f7c98c9f524",
ukoVault: ibm_hpcs_vault.vault.vault_id,
});
import pulumi
import pulumi_ibm as ibm
keystore = ibm.get_hpcs_keystore(instance_id="76195d24-8a31-4c6d-9050-c35f09375cfb",
region="us-east",
keystore_id="d8cc1ef7-d13b-4731-95be-1f7c98c9f524",
uko_vault=ibm_hpcs_vault["vault"]["vault_id"])
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := ibm.LookupHpcsKeystore(ctx, &ibm.LookupHpcsKeystoreArgs{
InstanceId: "76195d24-8a31-4c6d-9050-c35f09375cfb",
Region: "us-east",
KeystoreId: "d8cc1ef7-d13b-4731-95be-1f7c98c9f524",
UkoVault: ibm_hpcs_vault.Vault.Vault_id,
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;
return await Deployment.RunAsync(() =>
{
var keystore = Ibm.GetHpcsKeystore.Invoke(new()
{
InstanceId = "76195d24-8a31-4c6d-9050-c35f09375cfb",
Region = "us-east",
KeystoreId = "d8cc1ef7-d13b-4731-95be-1f7c98c9f524",
UkoVault = ibm_hpcs_vault.Vault.Vault_id,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IbmFunctions;
import com.pulumi.ibm.inputs.GetHpcsKeystoreArgs;
import java.util.List;
import java.util.ArrayList;
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) {
final var keystore = IbmFunctions.getHpcsKeystore(GetHpcsKeystoreArgs.builder()
.instanceId("76195d24-8a31-4c6d-9050-c35f09375cfb")
.region("us-east")
.keystoreId("d8cc1ef7-d13b-4731-95be-1f7c98c9f524")
.ukoVault(ibm_hpcs_vault.vault().vault_id())
.build());
}
}
variables:
keystore:
fn::invoke:
function: ibm:getHpcsKeystore
arguments:
instanceId: 76195d24-8a31-4c6d-9050-c35f09375cfb
region: us-east
keystoreId: d8cc1ef7-d13b-4731-95be-1f7c98c9f524
ukoVault: ${ibm_hpcs_vault.vault.vault_id}
Using getHpcsKeystore
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 getHpcsKeystore(args: GetHpcsKeystoreArgs, opts?: InvokeOptions): Promise<GetHpcsKeystoreResult>
function getHpcsKeystoreOutput(args: GetHpcsKeystoreOutputArgs, opts?: InvokeOptions): Output<GetHpcsKeystoreResult>
def get_hpcs_keystore(id: Optional[str] = None,
instance_id: Optional[str] = None,
keystore_id: Optional[str] = None,
region: Optional[str] = None,
uko_vault: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetHpcsKeystoreResult
def get_hpcs_keystore_output(id: Optional[pulumi.Input[str]] = None,
instance_id: Optional[pulumi.Input[str]] = None,
keystore_id: Optional[pulumi.Input[str]] = None,
region: Optional[pulumi.Input[str]] = None,
uko_vault: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetHpcsKeystoreResult]
func LookupHpcsKeystore(ctx *Context, args *LookupHpcsKeystoreArgs, opts ...InvokeOption) (*LookupHpcsKeystoreResult, error)
func LookupHpcsKeystoreOutput(ctx *Context, args *LookupHpcsKeystoreOutputArgs, opts ...InvokeOption) LookupHpcsKeystoreResultOutput
> Note: This function is named LookupHpcsKeystore
in the Go SDK.
public static class GetHpcsKeystore
{
public static Task<GetHpcsKeystoreResult> InvokeAsync(GetHpcsKeystoreArgs args, InvokeOptions? opts = null)
public static Output<GetHpcsKeystoreResult> Invoke(GetHpcsKeystoreInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetHpcsKeystoreResult> getHpcsKeystore(GetHpcsKeystoreArgs args, InvokeOptions options)
public static Output<GetHpcsKeystoreResult> getHpcsKeystore(GetHpcsKeystoreArgs args, InvokeOptions options)
fn::invoke:
function: ibm:index/getHpcsKeystore:getHpcsKeystore
arguments:
# arguments dictionary
The following arguments are supported:
- Instance
Id string - ID of UKO Instance
- Constraints: Must match the ID of the UKO instance you are trying to work with.
- Keystore
Id string - UUID of the keystore.
- Region string
- Region of the UKO Instance
- Constraints: Allowable values are:
au-syd
,in-che
,jp-osa
,jp-tok
,kr-seo
,eu-de
,eu-gb
,ca-tor
,us-south
,us-south-test
,us-east
,br-sao
.
- Constraints: Allowable values are:
- Uko
Vault string - The UUID of the Vault in which the update is to take place.
- Id string
- (String) The v4 UUID used to uniquely identify the resource, as specified by RFC 4122.
- Constraints: The maximum length is
36
characters. The minimum length is36
characters. The value must match regular expression/^[-0-9a-z]+$/
.
- Constraints: The maximum length is
- Instance
Id string - ID of UKO Instance
- Constraints: Must match the ID of the UKO instance you are trying to work with.
- Keystore
Id string - UUID of the keystore.
- Region string
- Region of the UKO Instance
- Constraints: Allowable values are:
au-syd
,in-che
,jp-osa
,jp-tok
,kr-seo
,eu-de
,eu-gb
,ca-tor
,us-south
,us-south-test
,us-east
,br-sao
.
- Constraints: Allowable values are:
- Uko
Vault string - The UUID of the Vault in which the update is to take place.
- Id string
- (String) The v4 UUID used to uniquely identify the resource, as specified by RFC 4122.
- Constraints: The maximum length is
36
characters. The minimum length is36
characters. The value must match regular expression/^[-0-9a-z]+$/
.
- Constraints: The maximum length is
- instance
Id String - ID of UKO Instance
- Constraints: Must match the ID of the UKO instance you are trying to work with.
- keystore
Id String - UUID of the keystore.
- region String
- Region of the UKO Instance
- Constraints: Allowable values are:
au-syd
,in-che
,jp-osa
,jp-tok
,kr-seo
,eu-de
,eu-gb
,ca-tor
,us-south
,us-south-test
,us-east
,br-sao
.
- Constraints: Allowable values are:
- uko
Vault String - The UUID of the Vault in which the update is to take place.
- id String
- (String) The v4 UUID used to uniquely identify the resource, as specified by RFC 4122.
- Constraints: The maximum length is
36
characters. The minimum length is36
characters. The value must match regular expression/^[-0-9a-z]+$/
.
- Constraints: The maximum length is
- instance
Id string - ID of UKO Instance
- Constraints: Must match the ID of the UKO instance you are trying to work with.
- keystore
Id string - UUID of the keystore.
- region string
- Region of the UKO Instance
- Constraints: Allowable values are:
au-syd
,in-che
,jp-osa
,jp-tok
,kr-seo
,eu-de
,eu-gb
,ca-tor
,us-south
,us-south-test
,us-east
,br-sao
.
- Constraints: Allowable values are:
- uko
Vault string - The UUID of the Vault in which the update is to take place.
- id string
- (String) The v4 UUID used to uniquely identify the resource, as specified by RFC 4122.
- Constraints: The maximum length is
36
characters. The minimum length is36
characters. The value must match regular expression/^[-0-9a-z]+$/
.
- Constraints: The maximum length is
- instance_
id str - ID of UKO Instance
- Constraints: Must match the ID of the UKO instance you are trying to work with.
- keystore_
id str - UUID of the keystore.
- region str
- Region of the UKO Instance
- Constraints: Allowable values are:
au-syd
,in-che
,jp-osa
,jp-tok
,kr-seo
,eu-de
,eu-gb
,ca-tor
,us-south
,us-south-test
,us-east
,br-sao
.
- Constraints: Allowable values are:
- uko_
vault str - The UUID of the Vault in which the update is to take place.
- id str
- (String) The v4 UUID used to uniquely identify the resource, as specified by RFC 4122.
- Constraints: The maximum length is
36
characters. The minimum length is36
characters. The value must match regular expression/^[-0-9a-z]+$/
.
- Constraints: The maximum length is
- instance
Id String - ID of UKO Instance
- Constraints: Must match the ID of the UKO instance you are trying to work with.
- keystore
Id String - UUID of the keystore.
- region String
- Region of the UKO Instance
- Constraints: Allowable values are:
au-syd
,in-che
,jp-osa
,jp-tok
,kr-seo
,eu-de
,eu-gb
,ca-tor
,us-south
,us-south-test
,us-east
,br-sao
.
- Constraints: Allowable values are:
- uko
Vault String - The UUID of the Vault in which the update is to take place.
- id String
- (String) The v4 UUID used to uniquely identify the resource, as specified by RFC 4122.
- Constraints: The maximum length is
36
characters. The minimum length is36
characters. The value must match regular expression/^[-0-9a-z]+$/
.
- Constraints: The maximum length is
getHpcsKeystore Result
The following output properties are available:
- Aws
Access stringKey Id - (String) The access key id used for connecting to this instance of AWS KMS.
- Constraints: The maximum length is
512
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9-_]*$/
.
- Constraints: The maximum length is
- Aws
Region string - (String) AWS Region.
- Constraints: Allowable values are:
af_south_1
,ap_east_1
,ap_northeast_1
,ap_northeast_2
,ap_south_1
,ap_southeast_1
,ap_southeast_2
,aws_cn_global
,aws_global
,aws_iso_global
,aws_iso_b_global
,aws_us_gov_global
,ca_central_1
,cn_north_1
,cn_northwest_1
,eu_central_1
,eu_west_1
,eu_west_2
,eu_west_3
,me_south_1
,sa_east_1
,us_east_1
,us_east_2
,us_gov_east_1
,us_gov_west_1
,us_iso_east_1
,us_isob_east_1
,us_west_1
,us_west_2
.
- Constraints: Allowable values are:
- Aws
Secret stringAccess Key - (String) The secret access key used for connecting to this instance of AWS KMS.
- Constraints: The maximum length is
512
characters. The minimum length is1
character. The value must match regular expression/.*/
.
- Constraints: The maximum length is
- Azure
Environment string - (String) Azure environment, usually 'Azure'.
- Constraints: Allowable values are:
azure
,azure_china
,azure_germany
,azure_us_government
.
- Constraints: Allowable values are:
- Azure
Location string - (String) Location of the Azure Key Vault.
- Constraints: Allowable values are:
asia_east
,asia_southeast
,australia_central
,australia_central_2
,australia_east
,australia_southeast
,brazil_south
,canada_central
,canada_east
,china_east
,china_east_2
,china_north
,china_north_2
,europe_north
,europe_west
,france_central
,france_south
,germany_central
,germany_northeast
,india_central
,india_south
,india_west
,japan_east
,japan_west
,korea_central
,korea_south
,south_africa_north
,south_africa_west
,uk_south
,uk_west
,us_central
,us_dod_central
,us_dod_east
,us_east
,us_east_2
,us_gov_arizona
,us_gov_iowa
,us_gov_texas
,us_gov_virginia
,us_north_central
,us_south_central
,us_west
,us_west_2
,us_west_central
.
- Constraints: Allowable values are:
- Azure
Resource stringGroup - (String) Resource group in Azure.
- Constraints: The maximum length is
90
characters. The minimum length is1
character. The value must match regular expression/^[-\\w\\._\\(\\)]*[^\\.]$/
.
- Constraints: The maximum length is
- Azure
Service stringName - (String) Service name of the key vault instance from the Azure portal.
- Constraints: The maximum length is
24
characters. The minimum length is3
characters. The value must match regular expression/^[A-Za-z0-9-]+$/
.
- Constraints: The maximum length is
- Azure
Service stringPrincipal Client Id - (String) Azure service principal client ID.
- Constraints: The maximum length is
36
characters. The minimum length is1
character. The value must match regular expression/^[-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- Azure
Service stringPrincipal Password - (String) Azure service principal password.
- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/.*/
.
- Constraints: The maximum length is
- Azure
Subscription stringId - (String) Subscription ID in Azure.
- Constraints: The maximum length is
36
characters. The minimum length is1
character. The value must match regular expression/^[-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- Azure
Tenant string - (String) Azure tenant that the Key Vault is associated with,.
- Constraints: The maximum length is
36
characters. The minimum length is1
character. The value must match regular expression/^[-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- Created
At string - (String) Date and time when the target keystore was created.
- Created
By string - (String) ID of the user that created the key.
- Constraints: The maximum length is
100
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9-]+$/
.
- Constraints: The maximum length is
- Description string
- (String) Description of the keystore.
- Constraints: The maximum length is
200
characters. The minimum length is0
characters. The value must match regular expression/(.|\\n)*/
.
- Constraints: The maximum length is
- Google
Credentials string - (String) The value of the JSON key represented in the Base64 format.
- Constraints: The maximum length is
524288
characters. The minimum length is1
character. The value must match regular expression/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/
.
- Constraints: The maximum length is
- Google
Key stringRing - (String) A key ring organizes keys in a specific Google Cloud location and allows you to manage access control on groups of keys.
- Constraints: The maximum length is
1024
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9-]*$/
.
- Constraints: The maximum length is
- Google
Location string - (String) Location represents the geographical region where a Cloud KMS resource is stored and can be accessed. A key's location impacts the performance of applications using the key.
- Constraints: The maximum length is
512
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9-]*$/
.
- Constraints: The maximum length is
- Google
Private stringKey Id - (String) The private key id associated with this keystore.
- Constraints: The maximum length is
512
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9-_]*$/
.
- Constraints: The maximum length is
- Google
Project stringId - (String) The project id associated with this keystore.
- Constraints: The maximum length is
512
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9-_]*$/
.
- Constraints: The maximum length is
- Groups List<string>
- (List) List of groups that this keystore belongs to.
- Constraints: The list items must match regular expression
/^[A-Za-z0-9][A-Za-z0-9-_ ]+$/
. The maximum length is128
items. The minimum length is1
item.
- Constraints: The list items must match regular expression
- Href string
- (String) A URL that uniquely identifies your cloud resource.
- Constraints: The maximum length is
200
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9._~:\/?&=-]+$/
.
- Constraints: The maximum length is
- Ibm
Api stringEndpoint - (String) API endpoint of the IBM Cloud keystore.
- Constraints: The maximum length is
512
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9._~:\/-]+$/
.
- Constraints: The maximum length is
- Ibm
Api stringKey - (String) The IBM Cloud API key to be used for connecting to this IBM Cloud keystore.
- Constraints: The maximum length is
64
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9-_&.]*$/
.
- Constraints: The maximum length is
- Ibm
Iam stringEndpoint - (String) Endpoint of the IAM service for this IBM Cloud keystore.
- Constraints: The maximum length is
512
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9._~:\/-]+$/
.
- Constraints: The maximum length is
- Ibm
Instance stringId - (String) The instance ID of the IBM Cloud keystore.
- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9-]*$/
.
- Constraints: The maximum length is
- Ibm
Key stringRing - (String) The key ring of an IBM Cloud KMS Keystore.
- Constraints: The default value is
Default
. The maximum length is100
characters. The minimum length is2
characters. The value must match regular expression/^[a-zA-Z0-9-]*$/
.
- Constraints: The default value is
- Ibm
Variant string - (String) Possible IBM Cloud KMS variants.
- Constraints: Allowable values are:
hpcs
,internal
,key_protect
.
- Constraints: Allowable values are:
- Id string
- (String) The v4 UUID used to uniquely identify the resource, as specified by RFC 4122.
- Constraints: The maximum length is
36
characters. The minimum length is36
characters. The value must match regular expression/^[-0-9a-z]+$/
.
- Constraints: The maximum length is
- Instance
Id string - Keystore
Id string - The unique identifier of the keystore.
- Location string
- (String) Geographic location of the keystore, if available.
- Constraints: The maximum length is
100
characters. The minimum length is0
characters. The value must match regular expression/^[A-Za-z0-9][A-Za-z0-9 ._-]*$/
.
- Constraints: The maximum length is
- Name string
- (String) Name of the referenced vault.
- Constraints: The maximum length is
100
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9#@!$%'_-][A-Za-z0-9#@!$% '_-]*$/
.
- Constraints: The maximum length is
- Region string
- Type string
- (String) Type of keystore.
- Constraints: Allowable values are:
aws_kms
,azure_key_vault
,ibm_cloud_kms
,google_kms
.
- Constraints: Allowable values are:
- Uko
Vault string - Updated
At string - (String) Date and time when the target keystore was last updated.
- Updated
By string - (String) ID of the user that last updated the key.
- Constraints: The maximum length is
100
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9-]+$/
.
- Constraints: The maximum length is
- Vaults
List<Get
Hpcs Keystore Vault> - (List) Reference to a vault. Nested scheme for vault:
- Aws
Access stringKey Id - (String) The access key id used for connecting to this instance of AWS KMS.
- Constraints: The maximum length is
512
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9-_]*$/
.
- Constraints: The maximum length is
- Aws
Region string - (String) AWS Region.
- Constraints: Allowable values are:
af_south_1
,ap_east_1
,ap_northeast_1
,ap_northeast_2
,ap_south_1
,ap_southeast_1
,ap_southeast_2
,aws_cn_global
,aws_global
,aws_iso_global
,aws_iso_b_global
,aws_us_gov_global
,ca_central_1
,cn_north_1
,cn_northwest_1
,eu_central_1
,eu_west_1
,eu_west_2
,eu_west_3
,me_south_1
,sa_east_1
,us_east_1
,us_east_2
,us_gov_east_1
,us_gov_west_1
,us_iso_east_1
,us_isob_east_1
,us_west_1
,us_west_2
.
- Constraints: Allowable values are:
- Aws
Secret stringAccess Key - (String) The secret access key used for connecting to this instance of AWS KMS.
- Constraints: The maximum length is
512
characters. The minimum length is1
character. The value must match regular expression/.*/
.
- Constraints: The maximum length is
- Azure
Environment string - (String) Azure environment, usually 'Azure'.
- Constraints: Allowable values are:
azure
,azure_china
,azure_germany
,azure_us_government
.
- Constraints: Allowable values are:
- Azure
Location string - (String) Location of the Azure Key Vault.
- Constraints: Allowable values are:
asia_east
,asia_southeast
,australia_central
,australia_central_2
,australia_east
,australia_southeast
,brazil_south
,canada_central
,canada_east
,china_east
,china_east_2
,china_north
,china_north_2
,europe_north
,europe_west
,france_central
,france_south
,germany_central
,germany_northeast
,india_central
,india_south
,india_west
,japan_east
,japan_west
,korea_central
,korea_south
,south_africa_north
,south_africa_west
,uk_south
,uk_west
,us_central
,us_dod_central
,us_dod_east
,us_east
,us_east_2
,us_gov_arizona
,us_gov_iowa
,us_gov_texas
,us_gov_virginia
,us_north_central
,us_south_central
,us_west
,us_west_2
,us_west_central
.
- Constraints: Allowable values are:
- Azure
Resource stringGroup - (String) Resource group in Azure.
- Constraints: The maximum length is
90
characters. The minimum length is1
character. The value must match regular expression/^[-\\w\\._\\(\\)]*[^\\.]$/
.
- Constraints: The maximum length is
- Azure
Service stringName - (String) Service name of the key vault instance from the Azure portal.
- Constraints: The maximum length is
24
characters. The minimum length is3
characters. The value must match regular expression/^[A-Za-z0-9-]+$/
.
- Constraints: The maximum length is
- Azure
Service stringPrincipal Client Id - (String) Azure service principal client ID.
- Constraints: The maximum length is
36
characters. The minimum length is1
character. The value must match regular expression/^[-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- Azure
Service stringPrincipal Password - (String) Azure service principal password.
- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/.*/
.
- Constraints: The maximum length is
- Azure
Subscription stringId - (String) Subscription ID in Azure.
- Constraints: The maximum length is
36
characters. The minimum length is1
character. The value must match regular expression/^[-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- Azure
Tenant string - (String) Azure tenant that the Key Vault is associated with,.
- Constraints: The maximum length is
36
characters. The minimum length is1
character. The value must match regular expression/^[-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- Created
At string - (String) Date and time when the target keystore was created.
- Created
By string - (String) ID of the user that created the key.
- Constraints: The maximum length is
100
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9-]+$/
.
- Constraints: The maximum length is
- Description string
- (String) Description of the keystore.
- Constraints: The maximum length is
200
characters. The minimum length is0
characters. The value must match regular expression/(.|\\n)*/
.
- Constraints: The maximum length is
- Google
Credentials string - (String) The value of the JSON key represented in the Base64 format.
- Constraints: The maximum length is
524288
characters. The minimum length is1
character. The value must match regular expression/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/
.
- Constraints: The maximum length is
- Google
Key stringRing - (String) A key ring organizes keys in a specific Google Cloud location and allows you to manage access control on groups of keys.
- Constraints: The maximum length is
1024
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9-]*$/
.
- Constraints: The maximum length is
- Google
Location string - (String) Location represents the geographical region where a Cloud KMS resource is stored and can be accessed. A key's location impacts the performance of applications using the key.
- Constraints: The maximum length is
512
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9-]*$/
.
- Constraints: The maximum length is
- Google
Private stringKey Id - (String) The private key id associated with this keystore.
- Constraints: The maximum length is
512
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9-_]*$/
.
- Constraints: The maximum length is
- Google
Project stringId - (String) The project id associated with this keystore.
- Constraints: The maximum length is
512
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9-_]*$/
.
- Constraints: The maximum length is
- Groups []string
- (List) List of groups that this keystore belongs to.
- Constraints: The list items must match regular expression
/^[A-Za-z0-9][A-Za-z0-9-_ ]+$/
. The maximum length is128
items. The minimum length is1
item.
- Constraints: The list items must match regular expression
- Href string
- (String) A URL that uniquely identifies your cloud resource.
- Constraints: The maximum length is
200
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9._~:\/?&=-]+$/
.
- Constraints: The maximum length is
- Ibm
Api stringEndpoint - (String) API endpoint of the IBM Cloud keystore.
- Constraints: The maximum length is
512
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9._~:\/-]+$/
.
- Constraints: The maximum length is
- Ibm
Api stringKey - (String) The IBM Cloud API key to be used for connecting to this IBM Cloud keystore.
- Constraints: The maximum length is
64
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9-_&.]*$/
.
- Constraints: The maximum length is
- Ibm
Iam stringEndpoint - (String) Endpoint of the IAM service for this IBM Cloud keystore.
- Constraints: The maximum length is
512
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9._~:\/-]+$/
.
- Constraints: The maximum length is
- Ibm
Instance stringId - (String) The instance ID of the IBM Cloud keystore.
- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9-]*$/
.
- Constraints: The maximum length is
- Ibm
Key stringRing - (String) The key ring of an IBM Cloud KMS Keystore.
- Constraints: The default value is
Default
. The maximum length is100
characters. The minimum length is2
characters. The value must match regular expression/^[a-zA-Z0-9-]*$/
.
- Constraints: The default value is
- Ibm
Variant string - (String) Possible IBM Cloud KMS variants.
- Constraints: Allowable values are:
hpcs
,internal
,key_protect
.
- Constraints: Allowable values are:
- Id string
- (String) The v4 UUID used to uniquely identify the resource, as specified by RFC 4122.
- Constraints: The maximum length is
36
characters. The minimum length is36
characters. The value must match regular expression/^[-0-9a-z]+$/
.
- Constraints: The maximum length is
- Instance
Id string - Keystore
Id string - The unique identifier of the keystore.
- Location string
- (String) Geographic location of the keystore, if available.
- Constraints: The maximum length is
100
characters. The minimum length is0
characters. The value must match regular expression/^[A-Za-z0-9][A-Za-z0-9 ._-]*$/
.
- Constraints: The maximum length is
- Name string
- (String) Name of the referenced vault.
- Constraints: The maximum length is
100
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9#@!$%'_-][A-Za-z0-9#@!$% '_-]*$/
.
- Constraints: The maximum length is
- Region string
- Type string
- (String) Type of keystore.
- Constraints: Allowable values are:
aws_kms
,azure_key_vault
,ibm_cloud_kms
,google_kms
.
- Constraints: Allowable values are:
- Uko
Vault string - Updated
At string - (String) Date and time when the target keystore was last updated.
- Updated
By string - (String) ID of the user that last updated the key.
- Constraints: The maximum length is
100
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9-]+$/
.
- Constraints: The maximum length is
- Vaults
[]Get
Hpcs Keystore Vault - (List) Reference to a vault. Nested scheme for vault:
- aws
Access StringKey Id - (String) The access key id used for connecting to this instance of AWS KMS.
- Constraints: The maximum length is
512
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9-_]*$/
.
- Constraints: The maximum length is
- aws
Region String - (String) AWS Region.
- Constraints: Allowable values are:
af_south_1
,ap_east_1
,ap_northeast_1
,ap_northeast_2
,ap_south_1
,ap_southeast_1
,ap_southeast_2
,aws_cn_global
,aws_global
,aws_iso_global
,aws_iso_b_global
,aws_us_gov_global
,ca_central_1
,cn_north_1
,cn_northwest_1
,eu_central_1
,eu_west_1
,eu_west_2
,eu_west_3
,me_south_1
,sa_east_1
,us_east_1
,us_east_2
,us_gov_east_1
,us_gov_west_1
,us_iso_east_1
,us_isob_east_1
,us_west_1
,us_west_2
.
- Constraints: Allowable values are:
- aws
Secret StringAccess Key - (String) The secret access key used for connecting to this instance of AWS KMS.
- Constraints: The maximum length is
512
characters. The minimum length is1
character. The value must match regular expression/.*/
.
- Constraints: The maximum length is
- azure
Environment String - (String) Azure environment, usually 'Azure'.
- Constraints: Allowable values are:
azure
,azure_china
,azure_germany
,azure_us_government
.
- Constraints: Allowable values are:
- azure
Location String - (String) Location of the Azure Key Vault.
- Constraints: Allowable values are:
asia_east
,asia_southeast
,australia_central
,australia_central_2
,australia_east
,australia_southeast
,brazil_south
,canada_central
,canada_east
,china_east
,china_east_2
,china_north
,china_north_2
,europe_north
,europe_west
,france_central
,france_south
,germany_central
,germany_northeast
,india_central
,india_south
,india_west
,japan_east
,japan_west
,korea_central
,korea_south
,south_africa_north
,south_africa_west
,uk_south
,uk_west
,us_central
,us_dod_central
,us_dod_east
,us_east
,us_east_2
,us_gov_arizona
,us_gov_iowa
,us_gov_texas
,us_gov_virginia
,us_north_central
,us_south_central
,us_west
,us_west_2
,us_west_central
.
- Constraints: Allowable values are:
- azure
Resource StringGroup - (String) Resource group in Azure.
- Constraints: The maximum length is
90
characters. The minimum length is1
character. The value must match regular expression/^[-\\w\\._\\(\\)]*[^\\.]$/
.
- Constraints: The maximum length is
- azure
Service StringName - (String) Service name of the key vault instance from the Azure portal.
- Constraints: The maximum length is
24
characters. The minimum length is3
characters. The value must match regular expression/^[A-Za-z0-9-]+$/
.
- Constraints: The maximum length is
- azure
Service StringPrincipal Client Id - (String) Azure service principal client ID.
- Constraints: The maximum length is
36
characters. The minimum length is1
character. The value must match regular expression/^[-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- azure
Service StringPrincipal Password - (String) Azure service principal password.
- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/.*/
.
- Constraints: The maximum length is
- azure
Subscription StringId - (String) Subscription ID in Azure.
- Constraints: The maximum length is
36
characters. The minimum length is1
character. The value must match regular expression/^[-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- azure
Tenant String - (String) Azure tenant that the Key Vault is associated with,.
- Constraints: The maximum length is
36
characters. The minimum length is1
character. The value must match regular expression/^[-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- created
At String - (String) Date and time when the target keystore was created.
- created
By String - (String) ID of the user that created the key.
- Constraints: The maximum length is
100
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9-]+$/
.
- Constraints: The maximum length is
- description String
- (String) Description of the keystore.
- Constraints: The maximum length is
200
characters. The minimum length is0
characters. The value must match regular expression/(.|\\n)*/
.
- Constraints: The maximum length is
- google
Credentials String - (String) The value of the JSON key represented in the Base64 format.
- Constraints: The maximum length is
524288
characters. The minimum length is1
character. The value must match regular expression/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/
.
- Constraints: The maximum length is
- google
Key StringRing - (String) A key ring organizes keys in a specific Google Cloud location and allows you to manage access control on groups of keys.
- Constraints: The maximum length is
1024
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9-]*$/
.
- Constraints: The maximum length is
- google
Location String - (String) Location represents the geographical region where a Cloud KMS resource is stored and can be accessed. A key's location impacts the performance of applications using the key.
- Constraints: The maximum length is
512
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9-]*$/
.
- Constraints: The maximum length is
- google
Private StringKey Id - (String) The private key id associated with this keystore.
- Constraints: The maximum length is
512
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9-_]*$/
.
- Constraints: The maximum length is
- google
Project StringId - (String) The project id associated with this keystore.
- Constraints: The maximum length is
512
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9-_]*$/
.
- Constraints: The maximum length is
- groups List<String>
- (List) List of groups that this keystore belongs to.
- Constraints: The list items must match regular expression
/^[A-Za-z0-9][A-Za-z0-9-_ ]+$/
. The maximum length is128
items. The minimum length is1
item.
- Constraints: The list items must match regular expression
- href String
- (String) A URL that uniquely identifies your cloud resource.
- Constraints: The maximum length is
200
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9._~:\/?&=-]+$/
.
- Constraints: The maximum length is
- ibm
Api StringEndpoint - (String) API endpoint of the IBM Cloud keystore.
- Constraints: The maximum length is
512
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9._~:\/-]+$/
.
- Constraints: The maximum length is
- ibm
Api StringKey - (String) The IBM Cloud API key to be used for connecting to this IBM Cloud keystore.
- Constraints: The maximum length is
64
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9-_&.]*$/
.
- Constraints: The maximum length is
- ibm
Iam StringEndpoint - (String) Endpoint of the IAM service for this IBM Cloud keystore.
- Constraints: The maximum length is
512
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9._~:\/-]+$/
.
- Constraints: The maximum length is
- ibm
Instance StringId - (String) The instance ID of the IBM Cloud keystore.
- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9-]*$/
.
- Constraints: The maximum length is
- ibm
Key StringRing - (String) The key ring of an IBM Cloud KMS Keystore.
- Constraints: The default value is
Default
. The maximum length is100
characters. The minimum length is2
characters. The value must match regular expression/^[a-zA-Z0-9-]*$/
.
- Constraints: The default value is
- ibm
Variant String - (String) Possible IBM Cloud KMS variants.
- Constraints: Allowable values are:
hpcs
,internal
,key_protect
.
- Constraints: Allowable values are:
- id String
- (String) The v4 UUID used to uniquely identify the resource, as specified by RFC 4122.
- Constraints: The maximum length is
36
characters. The minimum length is36
characters. The value must match regular expression/^[-0-9a-z]+$/
.
- Constraints: The maximum length is
- instance
Id String - keystore
Id String - The unique identifier of the keystore.
- location String
- (String) Geographic location of the keystore, if available.
- Constraints: The maximum length is
100
characters. The minimum length is0
characters. The value must match regular expression/^[A-Za-z0-9][A-Za-z0-9 ._-]*$/
.
- Constraints: The maximum length is
- name String
- (String) Name of the referenced vault.
- Constraints: The maximum length is
100
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9#@!$%'_-][A-Za-z0-9#@!$% '_-]*$/
.
- Constraints: The maximum length is
- region String
- type String
- (String) Type of keystore.
- Constraints: Allowable values are:
aws_kms
,azure_key_vault
,ibm_cloud_kms
,google_kms
.
- Constraints: Allowable values are:
- uko
Vault String - updated
At String - (String) Date and time when the target keystore was last updated.
- updated
By String - (String) ID of the user that last updated the key.
- Constraints: The maximum length is
100
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9-]+$/
.
- Constraints: The maximum length is
- vaults
List<Get
Hpcs Keystore Vault> - (List) Reference to a vault. Nested scheme for vault:
- aws
Access stringKey Id - (String) The access key id used for connecting to this instance of AWS KMS.
- Constraints: The maximum length is
512
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9-_]*$/
.
- Constraints: The maximum length is
- aws
Region string - (String) AWS Region.
- Constraints: Allowable values are:
af_south_1
,ap_east_1
,ap_northeast_1
,ap_northeast_2
,ap_south_1
,ap_southeast_1
,ap_southeast_2
,aws_cn_global
,aws_global
,aws_iso_global
,aws_iso_b_global
,aws_us_gov_global
,ca_central_1
,cn_north_1
,cn_northwest_1
,eu_central_1
,eu_west_1
,eu_west_2
,eu_west_3
,me_south_1
,sa_east_1
,us_east_1
,us_east_2
,us_gov_east_1
,us_gov_west_1
,us_iso_east_1
,us_isob_east_1
,us_west_1
,us_west_2
.
- Constraints: Allowable values are:
- aws
Secret stringAccess Key - (String) The secret access key used for connecting to this instance of AWS KMS.
- Constraints: The maximum length is
512
characters. The minimum length is1
character. The value must match regular expression/.*/
.
- Constraints: The maximum length is
- azure
Environment string - (String) Azure environment, usually 'Azure'.
- Constraints: Allowable values are:
azure
,azure_china
,azure_germany
,azure_us_government
.
- Constraints: Allowable values are:
- azure
Location string - (String) Location of the Azure Key Vault.
- Constraints: Allowable values are:
asia_east
,asia_southeast
,australia_central
,australia_central_2
,australia_east
,australia_southeast
,brazil_south
,canada_central
,canada_east
,china_east
,china_east_2
,china_north
,china_north_2
,europe_north
,europe_west
,france_central
,france_south
,germany_central
,germany_northeast
,india_central
,india_south
,india_west
,japan_east
,japan_west
,korea_central
,korea_south
,south_africa_north
,south_africa_west
,uk_south
,uk_west
,us_central
,us_dod_central
,us_dod_east
,us_east
,us_east_2
,us_gov_arizona
,us_gov_iowa
,us_gov_texas
,us_gov_virginia
,us_north_central
,us_south_central
,us_west
,us_west_2
,us_west_central
.
- Constraints: Allowable values are:
- azure
Resource stringGroup - (String) Resource group in Azure.
- Constraints: The maximum length is
90
characters. The minimum length is1
character. The value must match regular expression/^[-\\w\\._\\(\\)]*[^\\.]$/
.
- Constraints: The maximum length is
- azure
Service stringName - (String) Service name of the key vault instance from the Azure portal.
- Constraints: The maximum length is
24
characters. The minimum length is3
characters. The value must match regular expression/^[A-Za-z0-9-]+$/
.
- Constraints: The maximum length is
- azure
Service stringPrincipal Client Id - (String) Azure service principal client ID.
- Constraints: The maximum length is
36
characters. The minimum length is1
character. The value must match regular expression/^[-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- azure
Service stringPrincipal Password - (String) Azure service principal password.
- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/.*/
.
- Constraints: The maximum length is
- azure
Subscription stringId - (String) Subscription ID in Azure.
- Constraints: The maximum length is
36
characters. The minimum length is1
character. The value must match regular expression/^[-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- azure
Tenant string - (String) Azure tenant that the Key Vault is associated with,.
- Constraints: The maximum length is
36
characters. The minimum length is1
character. The value must match regular expression/^[-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- created
At string - (String) Date and time when the target keystore was created.
- created
By string - (String) ID of the user that created the key.
- Constraints: The maximum length is
100
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9-]+$/
.
- Constraints: The maximum length is
- description string
- (String) Description of the keystore.
- Constraints: The maximum length is
200
characters. The minimum length is0
characters. The value must match regular expression/(.|\\n)*/
.
- Constraints: The maximum length is
- google
Credentials string - (String) The value of the JSON key represented in the Base64 format.
- Constraints: The maximum length is
524288
characters. The minimum length is1
character. The value must match regular expression/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/
.
- Constraints: The maximum length is
- google
Key stringRing - (String) A key ring organizes keys in a specific Google Cloud location and allows you to manage access control on groups of keys.
- Constraints: The maximum length is
1024
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9-]*$/
.
- Constraints: The maximum length is
- google
Location string - (String) Location represents the geographical region where a Cloud KMS resource is stored and can be accessed. A key's location impacts the performance of applications using the key.
- Constraints: The maximum length is
512
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9-]*$/
.
- Constraints: The maximum length is
- google
Private stringKey Id - (String) The private key id associated with this keystore.
- Constraints: The maximum length is
512
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9-_]*$/
.
- Constraints: The maximum length is
- google
Project stringId - (String) The project id associated with this keystore.
- Constraints: The maximum length is
512
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9-_]*$/
.
- Constraints: The maximum length is
- groups string[]
- (List) List of groups that this keystore belongs to.
- Constraints: The list items must match regular expression
/^[A-Za-z0-9][A-Za-z0-9-_ ]+$/
. The maximum length is128
items. The minimum length is1
item.
- Constraints: The list items must match regular expression
- href string
- (String) A URL that uniquely identifies your cloud resource.
- Constraints: The maximum length is
200
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9._~:\/?&=-]+$/
.
- Constraints: The maximum length is
- ibm
Api stringEndpoint - (String) API endpoint of the IBM Cloud keystore.
- Constraints: The maximum length is
512
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9._~:\/-]+$/
.
- Constraints: The maximum length is
- ibm
Api stringKey - (String) The IBM Cloud API key to be used for connecting to this IBM Cloud keystore.
- Constraints: The maximum length is
64
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9-_&.]*$/
.
- Constraints: The maximum length is
- ibm
Iam stringEndpoint - (String) Endpoint of the IAM service for this IBM Cloud keystore.
- Constraints: The maximum length is
512
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9._~:\/-]+$/
.
- Constraints: The maximum length is
- ibm
Instance stringId - (String) The instance ID of the IBM Cloud keystore.
- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9-]*$/
.
- Constraints: The maximum length is
- ibm
Key stringRing - (String) The key ring of an IBM Cloud KMS Keystore.
- Constraints: The default value is
Default
. The maximum length is100
characters. The minimum length is2
characters. The value must match regular expression/^[a-zA-Z0-9-]*$/
.
- Constraints: The default value is
- ibm
Variant string - (String) Possible IBM Cloud KMS variants.
- Constraints: Allowable values are:
hpcs
,internal
,key_protect
.
- Constraints: Allowable values are:
- id string
- (String) The v4 UUID used to uniquely identify the resource, as specified by RFC 4122.
- Constraints: The maximum length is
36
characters. The minimum length is36
characters. The value must match regular expression/^[-0-9a-z]+$/
.
- Constraints: The maximum length is
- instance
Id string - keystore
Id string - The unique identifier of the keystore.
- location string
- (String) Geographic location of the keystore, if available.
- Constraints: The maximum length is
100
characters. The minimum length is0
characters. The value must match regular expression/^[A-Za-z0-9][A-Za-z0-9 ._-]*$/
.
- Constraints: The maximum length is
- name string
- (String) Name of the referenced vault.
- Constraints: The maximum length is
100
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9#@!$%'_-][A-Za-z0-9#@!$% '_-]*$/
.
- Constraints: The maximum length is
- region string
- type string
- (String) Type of keystore.
- Constraints: Allowable values are:
aws_kms
,azure_key_vault
,ibm_cloud_kms
,google_kms
.
- Constraints: Allowable values are:
- uko
Vault string - updated
At string - (String) Date and time when the target keystore was last updated.
- updated
By string - (String) ID of the user that last updated the key.
- Constraints: The maximum length is
100
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9-]+$/
.
- Constraints: The maximum length is
- vaults
Get
Hpcs Keystore Vault[] - (List) Reference to a vault. Nested scheme for vault:
- aws_
access_ strkey_ id - (String) The access key id used for connecting to this instance of AWS KMS.
- Constraints: The maximum length is
512
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9-_]*$/
.
- Constraints: The maximum length is
- aws_
region str - (String) AWS Region.
- Constraints: Allowable values are:
af_south_1
,ap_east_1
,ap_northeast_1
,ap_northeast_2
,ap_south_1
,ap_southeast_1
,ap_southeast_2
,aws_cn_global
,aws_global
,aws_iso_global
,aws_iso_b_global
,aws_us_gov_global
,ca_central_1
,cn_north_1
,cn_northwest_1
,eu_central_1
,eu_west_1
,eu_west_2
,eu_west_3
,me_south_1
,sa_east_1
,us_east_1
,us_east_2
,us_gov_east_1
,us_gov_west_1
,us_iso_east_1
,us_isob_east_1
,us_west_1
,us_west_2
.
- Constraints: Allowable values are:
- aws_
secret_ straccess_ key - (String) The secret access key used for connecting to this instance of AWS KMS.
- Constraints: The maximum length is
512
characters. The minimum length is1
character. The value must match regular expression/.*/
.
- Constraints: The maximum length is
- azure_
environment str - (String) Azure environment, usually 'Azure'.
- Constraints: Allowable values are:
azure
,azure_china
,azure_germany
,azure_us_government
.
- Constraints: Allowable values are:
- azure_
location str - (String) Location of the Azure Key Vault.
- Constraints: Allowable values are:
asia_east
,asia_southeast
,australia_central
,australia_central_2
,australia_east
,australia_southeast
,brazil_south
,canada_central
,canada_east
,china_east
,china_east_2
,china_north
,china_north_2
,europe_north
,europe_west
,france_central
,france_south
,germany_central
,germany_northeast
,india_central
,india_south
,india_west
,japan_east
,japan_west
,korea_central
,korea_south
,south_africa_north
,south_africa_west
,uk_south
,uk_west
,us_central
,us_dod_central
,us_dod_east
,us_east
,us_east_2
,us_gov_arizona
,us_gov_iowa
,us_gov_texas
,us_gov_virginia
,us_north_central
,us_south_central
,us_west
,us_west_2
,us_west_central
.
- Constraints: Allowable values are:
- azure_
resource_ strgroup - (String) Resource group in Azure.
- Constraints: The maximum length is
90
characters. The minimum length is1
character. The value must match regular expression/^[-\\w\\._\\(\\)]*[^\\.]$/
.
- Constraints: The maximum length is
- azure_
service_ strname - (String) Service name of the key vault instance from the Azure portal.
- Constraints: The maximum length is
24
characters. The minimum length is3
characters. The value must match regular expression/^[A-Za-z0-9-]+$/
.
- Constraints: The maximum length is
- azure_
service_ strprincipal_ client_ id - (String) Azure service principal client ID.
- Constraints: The maximum length is
36
characters. The minimum length is1
character. The value must match regular expression/^[-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- azure_
service_ strprincipal_ password - (String) Azure service principal password.
- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/.*/
.
- Constraints: The maximum length is
- azure_
subscription_ strid - (String) Subscription ID in Azure.
- Constraints: The maximum length is
36
characters. The minimum length is1
character. The value must match regular expression/^[-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- azure_
tenant str - (String) Azure tenant that the Key Vault is associated with,.
- Constraints: The maximum length is
36
characters. The minimum length is1
character. The value must match regular expression/^[-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- created_
at str - (String) Date and time when the target keystore was created.
- created_
by str - (String) ID of the user that created the key.
- Constraints: The maximum length is
100
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9-]+$/
.
- Constraints: The maximum length is
- description str
- (String) Description of the keystore.
- Constraints: The maximum length is
200
characters. The minimum length is0
characters. The value must match regular expression/(.|\\n)*/
.
- Constraints: The maximum length is
- google_
credentials str - (String) The value of the JSON key represented in the Base64 format.
- Constraints: The maximum length is
524288
characters. The minimum length is1
character. The value must match regular expression/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/
.
- Constraints: The maximum length is
- google_
key_ strring - (String) A key ring organizes keys in a specific Google Cloud location and allows you to manage access control on groups of keys.
- Constraints: The maximum length is
1024
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9-]*$/
.
- Constraints: The maximum length is
- google_
location str - (String) Location represents the geographical region where a Cloud KMS resource is stored and can be accessed. A key's location impacts the performance of applications using the key.
- Constraints: The maximum length is
512
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9-]*$/
.
- Constraints: The maximum length is
- google_
private_ strkey_ id - (String) The private key id associated with this keystore.
- Constraints: The maximum length is
512
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9-_]*$/
.
- Constraints: The maximum length is
- google_
project_ strid - (String) The project id associated with this keystore.
- Constraints: The maximum length is
512
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9-_]*$/
.
- Constraints: The maximum length is
- groups Sequence[str]
- (List) List of groups that this keystore belongs to.
- Constraints: The list items must match regular expression
/^[A-Za-z0-9][A-Za-z0-9-_ ]+$/
. The maximum length is128
items. The minimum length is1
item.
- Constraints: The list items must match regular expression
- href str
- (String) A URL that uniquely identifies your cloud resource.
- Constraints: The maximum length is
200
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9._~:\/?&=-]+$/
.
- Constraints: The maximum length is
- ibm_
api_ strendpoint - (String) API endpoint of the IBM Cloud keystore.
- Constraints: The maximum length is
512
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9._~:\/-]+$/
.
- Constraints: The maximum length is
- ibm_
api_ strkey - (String) The IBM Cloud API key to be used for connecting to this IBM Cloud keystore.
- Constraints: The maximum length is
64
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9-_&.]*$/
.
- Constraints: The maximum length is
- ibm_
iam_ strendpoint - (String) Endpoint of the IAM service for this IBM Cloud keystore.
- Constraints: The maximum length is
512
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9._~:\/-]+$/
.
- Constraints: The maximum length is
- ibm_
instance_ strid - (String) The instance ID of the IBM Cloud keystore.
- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9-]*$/
.
- Constraints: The maximum length is
- ibm_
key_ strring - (String) The key ring of an IBM Cloud KMS Keystore.
- Constraints: The default value is
Default
. The maximum length is100
characters. The minimum length is2
characters. The value must match regular expression/^[a-zA-Z0-9-]*$/
.
- Constraints: The default value is
- ibm_
variant str - (String) Possible IBM Cloud KMS variants.
- Constraints: Allowable values are:
hpcs
,internal
,key_protect
.
- Constraints: Allowable values are:
- id str
- (String) The v4 UUID used to uniquely identify the resource, as specified by RFC 4122.
- Constraints: The maximum length is
36
characters. The minimum length is36
characters. The value must match regular expression/^[-0-9a-z]+$/
.
- Constraints: The maximum length is
- instance_
id str - keystore_
id str - The unique identifier of the keystore.
- location str
- (String) Geographic location of the keystore, if available.
- Constraints: The maximum length is
100
characters. The minimum length is0
characters. The value must match regular expression/^[A-Za-z0-9][A-Za-z0-9 ._-]*$/
.
- Constraints: The maximum length is
- name str
- (String) Name of the referenced vault.
- Constraints: The maximum length is
100
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9#@!$%'_-][A-Za-z0-9#@!$% '_-]*$/
.
- Constraints: The maximum length is
- region str
- type str
- (String) Type of keystore.
- Constraints: Allowable values are:
aws_kms
,azure_key_vault
,ibm_cloud_kms
,google_kms
.
- Constraints: Allowable values are:
- uko_
vault str - updated_
at str - (String) Date and time when the target keystore was last updated.
- updated_
by str - (String) ID of the user that last updated the key.
- Constraints: The maximum length is
100
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9-]+$/
.
- Constraints: The maximum length is
- vaults
Sequence[Get
Hpcs Keystore Vault] - (List) Reference to a vault. Nested scheme for vault:
- aws
Access StringKey Id - (String) The access key id used for connecting to this instance of AWS KMS.
- Constraints: The maximum length is
512
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9-_]*$/
.
- Constraints: The maximum length is
- aws
Region String - (String) AWS Region.
- Constraints: Allowable values are:
af_south_1
,ap_east_1
,ap_northeast_1
,ap_northeast_2
,ap_south_1
,ap_southeast_1
,ap_southeast_2
,aws_cn_global
,aws_global
,aws_iso_global
,aws_iso_b_global
,aws_us_gov_global
,ca_central_1
,cn_north_1
,cn_northwest_1
,eu_central_1
,eu_west_1
,eu_west_2
,eu_west_3
,me_south_1
,sa_east_1
,us_east_1
,us_east_2
,us_gov_east_1
,us_gov_west_1
,us_iso_east_1
,us_isob_east_1
,us_west_1
,us_west_2
.
- Constraints: Allowable values are:
- aws
Secret StringAccess Key - (String) The secret access key used for connecting to this instance of AWS KMS.
- Constraints: The maximum length is
512
characters. The minimum length is1
character. The value must match regular expression/.*/
.
- Constraints: The maximum length is
- azure
Environment String - (String) Azure environment, usually 'Azure'.
- Constraints: Allowable values are:
azure
,azure_china
,azure_germany
,azure_us_government
.
- Constraints: Allowable values are:
- azure
Location String - (String) Location of the Azure Key Vault.
- Constraints: Allowable values are:
asia_east
,asia_southeast
,australia_central
,australia_central_2
,australia_east
,australia_southeast
,brazil_south
,canada_central
,canada_east
,china_east
,china_east_2
,china_north
,china_north_2
,europe_north
,europe_west
,france_central
,france_south
,germany_central
,germany_northeast
,india_central
,india_south
,india_west
,japan_east
,japan_west
,korea_central
,korea_south
,south_africa_north
,south_africa_west
,uk_south
,uk_west
,us_central
,us_dod_central
,us_dod_east
,us_east
,us_east_2
,us_gov_arizona
,us_gov_iowa
,us_gov_texas
,us_gov_virginia
,us_north_central
,us_south_central
,us_west
,us_west_2
,us_west_central
.
- Constraints: Allowable values are:
- azure
Resource StringGroup - (String) Resource group in Azure.
- Constraints: The maximum length is
90
characters. The minimum length is1
character. The value must match regular expression/^[-\\w\\._\\(\\)]*[^\\.]$/
.
- Constraints: The maximum length is
- azure
Service StringName - (String) Service name of the key vault instance from the Azure portal.
- Constraints: The maximum length is
24
characters. The minimum length is3
characters. The value must match regular expression/^[A-Za-z0-9-]+$/
.
- Constraints: The maximum length is
- azure
Service StringPrincipal Client Id - (String) Azure service principal client ID.
- Constraints: The maximum length is
36
characters. The minimum length is1
character. The value must match regular expression/^[-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- azure
Service StringPrincipal Password - (String) Azure service principal password.
- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/.*/
.
- Constraints: The maximum length is
- azure
Subscription StringId - (String) Subscription ID in Azure.
- Constraints: The maximum length is
36
characters. The minimum length is1
character. The value must match regular expression/^[-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- azure
Tenant String - (String) Azure tenant that the Key Vault is associated with,.
- Constraints: The maximum length is
36
characters. The minimum length is1
character. The value must match regular expression/^[-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- created
At String - (String) Date and time when the target keystore was created.
- created
By String - (String) ID of the user that created the key.
- Constraints: The maximum length is
100
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9-]+$/
.
- Constraints: The maximum length is
- description String
- (String) Description of the keystore.
- Constraints: The maximum length is
200
characters. The minimum length is0
characters. The value must match regular expression/(.|\\n)*/
.
- Constraints: The maximum length is
- google
Credentials String - (String) The value of the JSON key represented in the Base64 format.
- Constraints: The maximum length is
524288
characters. The minimum length is1
character. The value must match regular expression/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/
.
- Constraints: The maximum length is
- google
Key StringRing - (String) A key ring organizes keys in a specific Google Cloud location and allows you to manage access control on groups of keys.
- Constraints: The maximum length is
1024
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9-]*$/
.
- Constraints: The maximum length is
- google
Location String - (String) Location represents the geographical region where a Cloud KMS resource is stored and can be accessed. A key's location impacts the performance of applications using the key.
- Constraints: The maximum length is
512
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9-]*$/
.
- Constraints: The maximum length is
- google
Private StringKey Id - (String) The private key id associated with this keystore.
- Constraints: The maximum length is
512
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9-_]*$/
.
- Constraints: The maximum length is
- google
Project StringId - (String) The project id associated with this keystore.
- Constraints: The maximum length is
512
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9-_]*$/
.
- Constraints: The maximum length is
- groups List<String>
- (List) List of groups that this keystore belongs to.
- Constraints: The list items must match regular expression
/^[A-Za-z0-9][A-Za-z0-9-_ ]+$/
. The maximum length is128
items. The minimum length is1
item.
- Constraints: The list items must match regular expression
- href String
- (String) A URL that uniquely identifies your cloud resource.
- Constraints: The maximum length is
200
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9._~:\/?&=-]+$/
.
- Constraints: The maximum length is
- ibm
Api StringEndpoint - (String) API endpoint of the IBM Cloud keystore.
- Constraints: The maximum length is
512
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9._~:\/-]+$/
.
- Constraints: The maximum length is
- ibm
Api StringKey - (String) The IBM Cloud API key to be used for connecting to this IBM Cloud keystore.
- Constraints: The maximum length is
64
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9-_&.]*$/
.
- Constraints: The maximum length is
- ibm
Iam StringEndpoint - (String) Endpoint of the IAM service for this IBM Cloud keystore.
- Constraints: The maximum length is
512
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9._~:\/-]+$/
.
- Constraints: The maximum length is
- ibm
Instance StringId - (String) The instance ID of the IBM Cloud keystore.
- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9-]*$/
.
- Constraints: The maximum length is
- ibm
Key StringRing - (String) The key ring of an IBM Cloud KMS Keystore.
- Constraints: The default value is
Default
. The maximum length is100
characters. The minimum length is2
characters. The value must match regular expression/^[a-zA-Z0-9-]*$/
.
- Constraints: The default value is
- ibm
Variant String - (String) Possible IBM Cloud KMS variants.
- Constraints: Allowable values are:
hpcs
,internal
,key_protect
.
- Constraints: Allowable values are:
- id String
- (String) The v4 UUID used to uniquely identify the resource, as specified by RFC 4122.
- Constraints: The maximum length is
36
characters. The minimum length is36
characters. The value must match regular expression/^[-0-9a-z]+$/
.
- Constraints: The maximum length is
- instance
Id String - keystore
Id String - The unique identifier of the keystore.
- location String
- (String) Geographic location of the keystore, if available.
- Constraints: The maximum length is
100
characters. The minimum length is0
characters. The value must match regular expression/^[A-Za-z0-9][A-Za-z0-9 ._-]*$/
.
- Constraints: The maximum length is
- name String
- (String) Name of the referenced vault.
- Constraints: The maximum length is
100
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9#@!$%'_-][A-Za-z0-9#@!$% '_-]*$/
.
- Constraints: The maximum length is
- region String
- type String
- (String) Type of keystore.
- Constraints: Allowable values are:
aws_kms
,azure_key_vault
,ibm_cloud_kms
,google_kms
.
- Constraints: Allowable values are:
- uko
Vault String - updated
At String - (String) Date and time when the target keystore was last updated.
- updated
By String - (String) ID of the user that last updated the key.
- Constraints: The maximum length is
100
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9-]+$/
.
- Constraints: The maximum length is
- vaults List<Property Map>
- (List) Reference to a vault. Nested scheme for vault:
Supporting Types
GetHpcsKeystoreVault
- Href string
- (String) A URL that uniquely identifies your cloud resource.
- Constraints: The maximum length is
200
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9._~:\/?&=-]+$/
.
- Constraints: The maximum length is
- Id string
- (String) The v4 UUID used to uniquely identify the resource, as specified by RFC 4122.
- Constraints: The maximum length is
36
characters. The minimum length is36
characters. The value must match regular expression/^[-0-9a-z]+$/
.
- Constraints: The maximum length is
- Name string
- (String) Name of the referenced vault.
- Constraints: The maximum length is
100
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9#@!$%'_-][A-Za-z0-9#@!$% '_-]*$/
.
- Constraints: The maximum length is
- Href string
- (String) A URL that uniquely identifies your cloud resource.
- Constraints: The maximum length is
200
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9._~:\/?&=-]+$/
.
- Constraints: The maximum length is
- Id string
- (String) The v4 UUID used to uniquely identify the resource, as specified by RFC 4122.
- Constraints: The maximum length is
36
characters. The minimum length is36
characters. The value must match regular expression/^[-0-9a-z]+$/
.
- Constraints: The maximum length is
- Name string
- (String) Name of the referenced vault.
- Constraints: The maximum length is
100
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9#@!$%'_-][A-Za-z0-9#@!$% '_-]*$/
.
- Constraints: The maximum length is
- href String
- (String) A URL that uniquely identifies your cloud resource.
- Constraints: The maximum length is
200
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9._~:\/?&=-]+$/
.
- Constraints: The maximum length is
- id String
- (String) The v4 UUID used to uniquely identify the resource, as specified by RFC 4122.
- Constraints: The maximum length is
36
characters. The minimum length is36
characters. The value must match regular expression/^[-0-9a-z]+$/
.
- Constraints: The maximum length is
- name String
- (String) Name of the referenced vault.
- Constraints: The maximum length is
100
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9#@!$%'_-][A-Za-z0-9#@!$% '_-]*$/
.
- Constraints: The maximum length is
- href string
- (String) A URL that uniquely identifies your cloud resource.
- Constraints: The maximum length is
200
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9._~:\/?&=-]+$/
.
- Constraints: The maximum length is
- id string
- (String) The v4 UUID used to uniquely identify the resource, as specified by RFC 4122.
- Constraints: The maximum length is
36
characters. The minimum length is36
characters. The value must match regular expression/^[-0-9a-z]+$/
.
- Constraints: The maximum length is
- name string
- (String) Name of the referenced vault.
- Constraints: The maximum length is
100
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9#@!$%'_-][A-Za-z0-9#@!$% '_-]*$/
.
- Constraints: The maximum length is
- href str
- (String) A URL that uniquely identifies your cloud resource.
- Constraints: The maximum length is
200
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9._~:\/?&=-]+$/
.
- Constraints: The maximum length is
- id str
- (String) The v4 UUID used to uniquely identify the resource, as specified by RFC 4122.
- Constraints: The maximum length is
36
characters. The minimum length is36
characters. The value must match regular expression/^[-0-9a-z]+$/
.
- Constraints: The maximum length is
- name str
- (String) Name of the referenced vault.
- Constraints: The maximum length is
100
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9#@!$%'_-][A-Za-z0-9#@!$% '_-]*$/
.
- Constraints: The maximum length is
- href String
- (String) A URL that uniquely identifies your cloud resource.
- Constraints: The maximum length is
200
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9._~:\/?&=-]+$/
.
- Constraints: The maximum length is
- id String
- (String) The v4 UUID used to uniquely identify the resource, as specified by RFC 4122.
- Constraints: The maximum length is
36
characters. The minimum length is36
characters. The value must match regular expression/^[-0-9a-z]+$/
.
- Constraints: The maximum length is
- name String
- (String) Name of the referenced vault.
- Constraints: The maximum length is
100
characters. The minimum length is1
character. The value must match regular expression/^[A-Za-z0-9#@!$%'_-][A-Za-z0-9#@!$% '_-]*$/
.
- Constraints: The maximum length is
Package Details
- Repository
- ibm ibm-cloud/terraform-provider-ibm
- License
- Notes
- This Pulumi package is based on the
ibm
Terraform Provider.