ibm.SmImportedCertificate
Explore with Pulumi AI
Provides a resource for ImportedCertificate. This allows ImportedCertificate to be created, updated and deleted.
Static credentials
You can provide your static credentials by adding the ibmcloud_api_key
, iaas_classic_username
, and iaas_classic_api_key
arguments in the IBM Cloud provider block.
Usage:
provider "ibm" {
ibmcloud_api_key = ""
iaas_classic_username = ""
iaas_classic_api_key = ""
}
Environment variables
You can provide your credentials by exporting the IC_API_KEY
, IAAS_CLASSIC_USERNAME
, and IAAS_CLASSIC_API_KEY
environment variables, representing your IBM Cloud platform API key, IBM Cloud Classic Infrastructure (SoftLayer) user name, and IBM Cloud infrastructure API key, respectively.
provider "ibm" {}
Usage:
export IC_API_KEY="ibmcloud_api_key"
export IAAS_CLASSIC_USERNAME="iaas_classic_username"
export IAAS_CLASSIC_API_KEY="iaas_classic_api_key"
pulumi preview
Note:
- Create or find your
ibmcloud_api_key
andiaas_classic_api_key
here.
- Select
My IBM Cloud API Keys
option from view dropdown foribmcloud_api_key
- Select
Classic Infrastructure API Keys
option from view dropdown foriaas_classic_api_key
- For iaas_classic_username
- Go to Users
- Click on user.
- Find user name in the
VPN password
section underUser Details
tab
For more informaton, see here.
Create SmImportedCertificate Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new SmImportedCertificate(name: string, args: SmImportedCertificateArgs, opts?: CustomResourceOptions);
@overload
def SmImportedCertificate(resource_name: str,
args: SmImportedCertificateArgs,
opts: Optional[ResourceOptions] = None)
@overload
def SmImportedCertificate(resource_name: str,
opts: Optional[ResourceOptions] = None,
instance_id: Optional[str] = None,
labels: Optional[Sequence[str]] = None,
description: Optional[str] = None,
endpoint_type: Optional[str] = None,
custom_metadata: Optional[Mapping[str, str]] = None,
intermediate: Optional[str] = None,
certificate: Optional[str] = None,
managed_csr: Optional[SmImportedCertificateManagedCsrArgs] = None,
name: Optional[str] = None,
private_key: Optional[str] = None,
region: Optional[str] = None,
secret_group_id: Optional[str] = None,
sm_imported_certificate_id: Optional[str] = None,
version_custom_metadata: Optional[Mapping[str, str]] = None)
func NewSmImportedCertificate(ctx *Context, name string, args SmImportedCertificateArgs, opts ...ResourceOption) (*SmImportedCertificate, error)
public SmImportedCertificate(string name, SmImportedCertificateArgs args, CustomResourceOptions? opts = null)
public SmImportedCertificate(String name, SmImportedCertificateArgs args)
public SmImportedCertificate(String name, SmImportedCertificateArgs args, CustomResourceOptions options)
type: ibm:SmImportedCertificate
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args SmImportedCertificateArgs
- 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 SmImportedCertificateArgs
- 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 SmImportedCertificateArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args SmImportedCertificateArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args SmImportedCertificateArgs
- 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 smImportedCertificateResource = new Ibm.SmImportedCertificate("smImportedCertificateResource", new()
{
InstanceId = "string",
Labels = new[]
{
"string",
},
Description = "string",
EndpointType = "string",
CustomMetadata =
{
{ "string", "string" },
},
Intermediate = "string",
Certificate = "string",
ManagedCsr = new Ibm.Inputs.SmImportedCertificateManagedCsrArgs
{
AltNames = "string",
ClientFlag = false,
CodeSigningFlag = false,
CommonName = "string",
Countries = new[]
{
"string",
},
Csr = "string",
EmailProtectionFlag = false,
ExcludeCnFromSans = false,
ExtKeyUsage = "string",
ExtKeyUsageOids = "string",
IpSans = "string",
KeyBits = 0,
KeyType = "string",
KeyUsage = "string",
Localities = new[]
{
"string",
},
Organizations = new[]
{
"string",
},
OtherSans = "string",
Ous = new[]
{
"string",
},
PolicyIdentifiers = "string",
PostalCodes = new[]
{
"string",
},
Provinces = new[]
{
"string",
},
RequireCn = false,
RotateKeys = false,
ServerFlag = false,
StreetAddresses = new[]
{
"string",
},
UriSans = "string",
UserIds = "string",
},
Name = "string",
PrivateKey = "string",
Region = "string",
SecretGroupId = "string",
SmImportedCertificateId = "string",
VersionCustomMetadata =
{
{ "string", "string" },
},
});
example, err := ibm.NewSmImportedCertificate(ctx, "smImportedCertificateResource", &ibm.SmImportedCertificateArgs{
InstanceId: pulumi.String("string"),
Labels: pulumi.StringArray{
pulumi.String("string"),
},
Description: pulumi.String("string"),
EndpointType: pulumi.String("string"),
CustomMetadata: pulumi.StringMap{
"string": pulumi.String("string"),
},
Intermediate: pulumi.String("string"),
Certificate: pulumi.String("string"),
ManagedCsr: &ibm.SmImportedCertificateManagedCsrArgs{
AltNames: pulumi.String("string"),
ClientFlag: pulumi.Bool(false),
CodeSigningFlag: pulumi.Bool(false),
CommonName: pulumi.String("string"),
Countries: pulumi.StringArray{
pulumi.String("string"),
},
Csr: pulumi.String("string"),
EmailProtectionFlag: pulumi.Bool(false),
ExcludeCnFromSans: pulumi.Bool(false),
ExtKeyUsage: pulumi.String("string"),
ExtKeyUsageOids: pulumi.String("string"),
IpSans: pulumi.String("string"),
KeyBits: pulumi.Float64(0),
KeyType: pulumi.String("string"),
KeyUsage: pulumi.String("string"),
Localities: pulumi.StringArray{
pulumi.String("string"),
},
Organizations: pulumi.StringArray{
pulumi.String("string"),
},
OtherSans: pulumi.String("string"),
Ous: pulumi.StringArray{
pulumi.String("string"),
},
PolicyIdentifiers: pulumi.String("string"),
PostalCodes: pulumi.StringArray{
pulumi.String("string"),
},
Provinces: pulumi.StringArray{
pulumi.String("string"),
},
RequireCn: pulumi.Bool(false),
RotateKeys: pulumi.Bool(false),
ServerFlag: pulumi.Bool(false),
StreetAddresses: pulumi.StringArray{
pulumi.String("string"),
},
UriSans: pulumi.String("string"),
UserIds: pulumi.String("string"),
},
Name: pulumi.String("string"),
PrivateKey: pulumi.String("string"),
Region: pulumi.String("string"),
SecretGroupId: pulumi.String("string"),
SmImportedCertificateId: pulumi.String("string"),
VersionCustomMetadata: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var smImportedCertificateResource = new SmImportedCertificate("smImportedCertificateResource", SmImportedCertificateArgs.builder()
.instanceId("string")
.labels("string")
.description("string")
.endpointType("string")
.customMetadata(Map.of("string", "string"))
.intermediate("string")
.certificate("string")
.managedCsr(SmImportedCertificateManagedCsrArgs.builder()
.altNames("string")
.clientFlag(false)
.codeSigningFlag(false)
.commonName("string")
.countries("string")
.csr("string")
.emailProtectionFlag(false)
.excludeCnFromSans(false)
.extKeyUsage("string")
.extKeyUsageOids("string")
.ipSans("string")
.keyBits(0)
.keyType("string")
.keyUsage("string")
.localities("string")
.organizations("string")
.otherSans("string")
.ous("string")
.policyIdentifiers("string")
.postalCodes("string")
.provinces("string")
.requireCn(false)
.rotateKeys(false)
.serverFlag(false)
.streetAddresses("string")
.uriSans("string")
.userIds("string")
.build())
.name("string")
.privateKey("string")
.region("string")
.secretGroupId("string")
.smImportedCertificateId("string")
.versionCustomMetadata(Map.of("string", "string"))
.build());
sm_imported_certificate_resource = ibm.SmImportedCertificate("smImportedCertificateResource",
instance_id="string",
labels=["string"],
description="string",
endpoint_type="string",
custom_metadata={
"string": "string",
},
intermediate="string",
certificate="string",
managed_csr={
"alt_names": "string",
"client_flag": False,
"code_signing_flag": False,
"common_name": "string",
"countries": ["string"],
"csr": "string",
"email_protection_flag": False,
"exclude_cn_from_sans": False,
"ext_key_usage": "string",
"ext_key_usage_oids": "string",
"ip_sans": "string",
"key_bits": 0,
"key_type": "string",
"key_usage": "string",
"localities": ["string"],
"organizations": ["string"],
"other_sans": "string",
"ous": ["string"],
"policy_identifiers": "string",
"postal_codes": ["string"],
"provinces": ["string"],
"require_cn": False,
"rotate_keys": False,
"server_flag": False,
"street_addresses": ["string"],
"uri_sans": "string",
"user_ids": "string",
},
name="string",
private_key="string",
region="string",
secret_group_id="string",
sm_imported_certificate_id="string",
version_custom_metadata={
"string": "string",
})
const smImportedCertificateResource = new ibm.SmImportedCertificate("smImportedCertificateResource", {
instanceId: "string",
labels: ["string"],
description: "string",
endpointType: "string",
customMetadata: {
string: "string",
},
intermediate: "string",
certificate: "string",
managedCsr: {
altNames: "string",
clientFlag: false,
codeSigningFlag: false,
commonName: "string",
countries: ["string"],
csr: "string",
emailProtectionFlag: false,
excludeCnFromSans: false,
extKeyUsage: "string",
extKeyUsageOids: "string",
ipSans: "string",
keyBits: 0,
keyType: "string",
keyUsage: "string",
localities: ["string"],
organizations: ["string"],
otherSans: "string",
ous: ["string"],
policyIdentifiers: "string",
postalCodes: ["string"],
provinces: ["string"],
requireCn: false,
rotateKeys: false,
serverFlag: false,
streetAddresses: ["string"],
uriSans: "string",
userIds: "string",
},
name: "string",
privateKey: "string",
region: "string",
secretGroupId: "string",
smImportedCertificateId: "string",
versionCustomMetadata: {
string: "string",
},
});
type: ibm:SmImportedCertificate
properties:
certificate: string
customMetadata:
string: string
description: string
endpointType: string
instanceId: string
intermediate: string
labels:
- string
managedCsr:
altNames: string
clientFlag: false
codeSigningFlag: false
commonName: string
countries:
- string
csr: string
emailProtectionFlag: false
excludeCnFromSans: false
extKeyUsage: string
extKeyUsageOids: string
ipSans: string
keyBits: 0
keyType: string
keyUsage: string
localities:
- string
organizations:
- string
otherSans: string
ous:
- string
policyIdentifiers: string
postalCodes:
- string
provinces:
- string
requireCn: false
rotateKeys: false
serverFlag: false
streetAddresses:
- string
uriSans: string
userIds: string
name: string
privateKey: string
region: string
secretGroupId: string
smImportedCertificateId: string
versionCustomMetadata:
string: string
SmImportedCertificate 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 SmImportedCertificate resource accepts the following input properties:
- Instance
Id string - The GUID of the Secrets Manager instance.
- Certificate string
- The PEM-encoded contents of your certificate. You can manually rotate the secret by modifying this argument, together with the optional arguments
intermediate
andprivate_key
. Modifying the certificate creates a new version of the secret. If the secret is used to generate a Certificate Signing Reques (CSR) no certificate should be provided initially. Add the certificate value only after the CSR is signed.- Constraints: The maximum length is
100000
characters. The minimum length is50
characters. The value must match regular expression/^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/
.
- Constraints: The maximum length is
- Custom
Metadata Dictionary<string, string> - The secret metadata that a user can customize.
- Description string
- An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.
- Constraints: The maximum length is
1024
characters. The minimum length is0
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- Endpoint
Type string - The endpoint type. If not provided the endpoint type is determined by the
visibility
argument provided in the provider configuration.- Constraints: Allowable values are:
private
,public
.
- Constraints: Allowable values are:
- Intermediate string
- (Optional) The PEM-encoded intermediate certificate to associate with the root certificate.
- Constraints: The maximum length is
100000
characters. The minimum length is50
characters. The value must match regular expression/^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/
.
- Constraints: The maximum length is
- Labels List<string>
- Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.
- Constraints: The list items must match regular expression
/(.*?)/
. The maximum length is30
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- Managed
Csr SmImported Certificate Managed Csr - The data specified to create the CSR and the private key. Nested scheme for managed_csr:
- Name string
- The human-readable name of your secret.
- Constraints: The maximum length is
256
characters. The minimum length is2
characters. The value must match regular expression^[A-Za-z0-9_][A-Za-z0-9_]*(?:_*-*\.*[A-Za-z0-9]*)*[A-Za-z0-9]+$
.
- Constraints: The maximum length is
- Private
Key string - (Optional) The PEM-encoded private key to associate with the certificate.
- Constraints: The maximum length is
100000
characters. The minimum length is50
characters. The value must match regular expression/^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/
.
- Constraints: The maximum length is
- Region string
- The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
- Secret
Group stringId - A UUID identifier, or
default
secret group.- Constraints: The maximum length is
36
characters. The minimum length is7
characters. The value must match regular expression/^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|default)$/
.
- Constraints: The maximum length is
- Sm
Imported stringCertificate Id - Version
Custom Dictionary<string, string>Metadata - The secret version metadata that a user can customize.
- Instance
Id string - The GUID of the Secrets Manager instance.
- Certificate string
- The PEM-encoded contents of your certificate. You can manually rotate the secret by modifying this argument, together with the optional arguments
intermediate
andprivate_key
. Modifying the certificate creates a new version of the secret. If the secret is used to generate a Certificate Signing Reques (CSR) no certificate should be provided initially. Add the certificate value only after the CSR is signed.- Constraints: The maximum length is
100000
characters. The minimum length is50
characters. The value must match regular expression/^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/
.
- Constraints: The maximum length is
- Custom
Metadata map[string]string - The secret metadata that a user can customize.
- Description string
- An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.
- Constraints: The maximum length is
1024
characters. The minimum length is0
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- Endpoint
Type string - The endpoint type. If not provided the endpoint type is determined by the
visibility
argument provided in the provider configuration.- Constraints: Allowable values are:
private
,public
.
- Constraints: Allowable values are:
- Intermediate string
- (Optional) The PEM-encoded intermediate certificate to associate with the root certificate.
- Constraints: The maximum length is
100000
characters. The minimum length is50
characters. The value must match regular expression/^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/
.
- Constraints: The maximum length is
- Labels []string
- Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.
- Constraints: The list items must match regular expression
/(.*?)/
. The maximum length is30
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- Managed
Csr SmImported Certificate Managed Csr Args - The data specified to create the CSR and the private key. Nested scheme for managed_csr:
- Name string
- The human-readable name of your secret.
- Constraints: The maximum length is
256
characters. The minimum length is2
characters. The value must match regular expression^[A-Za-z0-9_][A-Za-z0-9_]*(?:_*-*\.*[A-Za-z0-9]*)*[A-Za-z0-9]+$
.
- Constraints: The maximum length is
- Private
Key string - (Optional) The PEM-encoded private key to associate with the certificate.
- Constraints: The maximum length is
100000
characters. The minimum length is50
characters. The value must match regular expression/^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/
.
- Constraints: The maximum length is
- Region string
- The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
- Secret
Group stringId - A UUID identifier, or
default
secret group.- Constraints: The maximum length is
36
characters. The minimum length is7
characters. The value must match regular expression/^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|default)$/
.
- Constraints: The maximum length is
- Sm
Imported stringCertificate Id - Version
Custom map[string]stringMetadata - The secret version metadata that a user can customize.
- instance
Id String - The GUID of the Secrets Manager instance.
- certificate String
- The PEM-encoded contents of your certificate. You can manually rotate the secret by modifying this argument, together with the optional arguments
intermediate
andprivate_key
. Modifying the certificate creates a new version of the secret. If the secret is used to generate a Certificate Signing Reques (CSR) no certificate should be provided initially. Add the certificate value only after the CSR is signed.- Constraints: The maximum length is
100000
characters. The minimum length is50
characters. The value must match regular expression/^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/
.
- Constraints: The maximum length is
- custom
Metadata Map<String,String> - The secret metadata that a user can customize.
- description String
- An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.
- Constraints: The maximum length is
1024
characters. The minimum length is0
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- endpoint
Type String - The endpoint type. If not provided the endpoint type is determined by the
visibility
argument provided in the provider configuration.- Constraints: Allowable values are:
private
,public
.
- Constraints: Allowable values are:
- intermediate String
- (Optional) The PEM-encoded intermediate certificate to associate with the root certificate.
- Constraints: The maximum length is
100000
characters. The minimum length is50
characters. The value must match regular expression/^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/
.
- Constraints: The maximum length is
- labels List<String>
- Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.
- Constraints: The list items must match regular expression
/(.*?)/
. The maximum length is30
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- managed
Csr SmImported Certificate Managed Csr - The data specified to create the CSR and the private key. Nested scheme for managed_csr:
- name String
- The human-readable name of your secret.
- Constraints: The maximum length is
256
characters. The minimum length is2
characters. The value must match regular expression^[A-Za-z0-9_][A-Za-z0-9_]*(?:_*-*\.*[A-Za-z0-9]*)*[A-Za-z0-9]+$
.
- Constraints: The maximum length is
- private
Key String - (Optional) The PEM-encoded private key to associate with the certificate.
- Constraints: The maximum length is
100000
characters. The minimum length is50
characters. The value must match regular expression/^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/
.
- Constraints: The maximum length is
- region String
- The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
- secret
Group StringId - A UUID identifier, or
default
secret group.- Constraints: The maximum length is
36
characters. The minimum length is7
characters. The value must match regular expression/^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|default)$/
.
- Constraints: The maximum length is
- sm
Imported StringCertificate Id - version
Custom Map<String,String>Metadata - The secret version metadata that a user can customize.
- instance
Id string - The GUID of the Secrets Manager instance.
- certificate string
- The PEM-encoded contents of your certificate. You can manually rotate the secret by modifying this argument, together with the optional arguments
intermediate
andprivate_key
. Modifying the certificate creates a new version of the secret. If the secret is used to generate a Certificate Signing Reques (CSR) no certificate should be provided initially. Add the certificate value only after the CSR is signed.- Constraints: The maximum length is
100000
characters. The minimum length is50
characters. The value must match regular expression/^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/
.
- Constraints: The maximum length is
- custom
Metadata {[key: string]: string} - The secret metadata that a user can customize.
- description string
- An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.
- Constraints: The maximum length is
1024
characters. The minimum length is0
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- endpoint
Type string - The endpoint type. If not provided the endpoint type is determined by the
visibility
argument provided in the provider configuration.- Constraints: Allowable values are:
private
,public
.
- Constraints: Allowable values are:
- intermediate string
- (Optional) The PEM-encoded intermediate certificate to associate with the root certificate.
- Constraints: The maximum length is
100000
characters. The minimum length is50
characters. The value must match regular expression/^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/
.
- Constraints: The maximum length is
- labels string[]
- Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.
- Constraints: The list items must match regular expression
/(.*?)/
. The maximum length is30
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- managed
Csr SmImported Certificate Managed Csr - The data specified to create the CSR and the private key. Nested scheme for managed_csr:
- name string
- The human-readable name of your secret.
- Constraints: The maximum length is
256
characters. The minimum length is2
characters. The value must match regular expression^[A-Za-z0-9_][A-Za-z0-9_]*(?:_*-*\.*[A-Za-z0-9]*)*[A-Za-z0-9]+$
.
- Constraints: The maximum length is
- private
Key string - (Optional) The PEM-encoded private key to associate with the certificate.
- Constraints: The maximum length is
100000
characters. The minimum length is50
characters. The value must match regular expression/^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/
.
- Constraints: The maximum length is
- region string
- The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
- secret
Group stringId - A UUID identifier, or
default
secret group.- Constraints: The maximum length is
36
characters. The minimum length is7
characters. The value must match regular expression/^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|default)$/
.
- Constraints: The maximum length is
- sm
Imported stringCertificate Id - version
Custom {[key: string]: string}Metadata - The secret version metadata that a user can customize.
- instance_
id str - The GUID of the Secrets Manager instance.
- certificate str
- The PEM-encoded contents of your certificate. You can manually rotate the secret by modifying this argument, together with the optional arguments
intermediate
andprivate_key
. Modifying the certificate creates a new version of the secret. If the secret is used to generate a Certificate Signing Reques (CSR) no certificate should be provided initially. Add the certificate value only after the CSR is signed.- Constraints: The maximum length is
100000
characters. The minimum length is50
characters. The value must match regular expression/^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/
.
- Constraints: The maximum length is
- custom_
metadata Mapping[str, str] - The secret metadata that a user can customize.
- description str
- An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.
- Constraints: The maximum length is
1024
characters. The minimum length is0
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- endpoint_
type str - The endpoint type. If not provided the endpoint type is determined by the
visibility
argument provided in the provider configuration.- Constraints: Allowable values are:
private
,public
.
- Constraints: Allowable values are:
- intermediate str
- (Optional) The PEM-encoded intermediate certificate to associate with the root certificate.
- Constraints: The maximum length is
100000
characters. The minimum length is50
characters. The value must match regular expression/^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/
.
- Constraints: The maximum length is
- labels Sequence[str]
- Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.
- Constraints: The list items must match regular expression
/(.*?)/
. The maximum length is30
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- managed_
csr SmImported Certificate Managed Csr Args - The data specified to create the CSR and the private key. Nested scheme for managed_csr:
- name str
- The human-readable name of your secret.
- Constraints: The maximum length is
256
characters. The minimum length is2
characters. The value must match regular expression^[A-Za-z0-9_][A-Za-z0-9_]*(?:_*-*\.*[A-Za-z0-9]*)*[A-Za-z0-9]+$
.
- Constraints: The maximum length is
- private_
key str - (Optional) The PEM-encoded private key to associate with the certificate.
- Constraints: The maximum length is
100000
characters. The minimum length is50
characters. The value must match regular expression/^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/
.
- Constraints: The maximum length is
- region str
- The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
- secret_
group_ strid - A UUID identifier, or
default
secret group.- Constraints: The maximum length is
36
characters. The minimum length is7
characters. The value must match regular expression/^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|default)$/
.
- Constraints: The maximum length is
- sm_
imported_ strcertificate_ id - version_
custom_ Mapping[str, str]metadata - The secret version metadata that a user can customize.
- instance
Id String - The GUID of the Secrets Manager instance.
- certificate String
- The PEM-encoded contents of your certificate. You can manually rotate the secret by modifying this argument, together with the optional arguments
intermediate
andprivate_key
. Modifying the certificate creates a new version of the secret. If the secret is used to generate a Certificate Signing Reques (CSR) no certificate should be provided initially. Add the certificate value only after the CSR is signed.- Constraints: The maximum length is
100000
characters. The minimum length is50
characters. The value must match regular expression/^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/
.
- Constraints: The maximum length is
- custom
Metadata Map<String> - The secret metadata that a user can customize.
- description String
- An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.
- Constraints: The maximum length is
1024
characters. The minimum length is0
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- endpoint
Type String - The endpoint type. If not provided the endpoint type is determined by the
visibility
argument provided in the provider configuration.- Constraints: Allowable values are:
private
,public
.
- Constraints: Allowable values are:
- intermediate String
- (Optional) The PEM-encoded intermediate certificate to associate with the root certificate.
- Constraints: The maximum length is
100000
characters. The minimum length is50
characters. The value must match regular expression/^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/
.
- Constraints: The maximum length is
- labels List<String>
- Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.
- Constraints: The list items must match regular expression
/(.*?)/
. The maximum length is30
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- managed
Csr Property Map - The data specified to create the CSR and the private key. Nested scheme for managed_csr:
- name String
- The human-readable name of your secret.
- Constraints: The maximum length is
256
characters. The minimum length is2
characters. The value must match regular expression^[A-Za-z0-9_][A-Za-z0-9_]*(?:_*-*\.*[A-Za-z0-9]*)*[A-Za-z0-9]+$
.
- Constraints: The maximum length is
- private
Key String - (Optional) The PEM-encoded private key to associate with the certificate.
- Constraints: The maximum length is
100000
characters. The minimum length is50
characters. The value must match regular expression/^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/
.
- Constraints: The maximum length is
- region String
- The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
- secret
Group StringId - A UUID identifier, or
default
secret group.- Constraints: The maximum length is
36
characters. The minimum length is7
characters. The value must match regular expression/^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|default)$/
.
- Constraints: The maximum length is
- sm
Imported StringCertificate Id - version
Custom Map<String>Metadata - The secret version metadata that a user can customize.
Outputs
All input properties are implicitly available as output properties. Additionally, the SmImportedCertificate resource produces the following output properties:
- Common
Name string - (Forces new resource, String) The Common Name (AKA CN) represents the server name protected by the SSL certificate.
- Constraints: The maximum length is
64
characters. The minimum length is4
characters. The value must match regular expression/^(\\*\\.)?(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])\\.?$/
.
- Constraints: The maximum length is
- Created
At string - (String) The date when a resource was created. The date format follows RFC 3339.
- Created
By string - (String) The unique identifier that is associated with the entity that created the secret.
- Constraints: The maximum length is
128
characters. The minimum length is4
characters.
- Constraints: The maximum length is
- Crn string
- (String) A CRN that uniquely identifies an IBM Cloud resource.
- Constraints: The maximum length is
512
characters. The minimum length is9
characters. The value must match regular expression/^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/
.
- Constraints: The maximum length is
- Csr string
- (String) The certificate signing request generated based on the parameters in the
managed_csr
data. The value may differ from thecsr
attribute withinmanaged_csr
if themanaged_csr
attributes have been modified. - Downloaded bool
- (Boolean) Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.
- Expiration
Date string - The date a secret is expired. The date format follows RFC 3339.
- Id string
- The provider-assigned unique ID for this managed resource.
- Intermediate
Included bool - (Boolean) Indicates whether the certificate was imported with an associated intermediate certificate.
- Issuer string
- (Forces new resource, String) The distinguished name that identifies the entity that signed and issued the certificate.
- Constraints: The maximum length is
128
characters. The minimum length is2
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- Key
Algorithm string - (String) The identifier for the cryptographic algorithm used to generate the public key that is associated with the certificate.
- Constraints: The maximum length is
10
characters. The minimum length is2
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- Locks
Total double - (Integer) The number of locks of the secret.
- Constraints: The maximum value is
1000
. The minimum value is0
.
- Constraints: The maximum value is
- Private
Key boolIncluded - (Boolean) Indicates whether the certificate was imported with an associated private key.
- Secret
Id string - The unique identifier of the ImportedCertificate.
- Secret
Type string - (String) The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.
- Constraints: Allowable values are:
arbitrary
,imported_cert
,public_cert
,iam_credentials
,kv
,username_password
,private_cert
.
- Constraints: Allowable values are:
- Serial
Number string - (String) The unique serial number that was assigned to a certificate by the issuing certificate authority.
- Constraints: The maximum length is
64
characters. The minimum length is2
characters. The value must match regular expression/[^a-fA-F0-9]/
.
- Constraints: The maximum length is
- Signing
Algorithm string - (String) The identifier for the cryptographic algorithm that was used by the issuing certificate authority to sign a certificate.
- Constraints: The maximum length is
64
characters. The minimum length is4
characters.
- Constraints: The maximum length is
- State double
- (Integer) The secret state that is based on NIST SP 800-57. States are integers and correspond to the
Pre-activation = 0
,Active = 1
,Suspended = 2
,Deactivated = 3
, andDestroyed = 5
values.- Constraints: Allowable values are:
0
,1
,2
,3
,5
.
- Constraints: Allowable values are:
- State
Description string - (String) A text representation of the secret state.
- Constraints: Allowable values are:
pre_activation
,active
,suspended
,deactivated
,destroyed
.
- Constraints: Allowable values are:
- Updated
At string - (String) The date when a resource was recently modified. The date format follows RFC 3339.
- Validities
List<Sm
Imported Certificate Validity> - (List) The date and time that the certificate validity period begins and ends. Nested scheme for validity:
- Versions
Total double - (Integer) The number of versions of the secret.
- Constraints: The maximum value is
50
. The minimum value is0
.
- Constraints: The maximum value is
- Common
Name string - (Forces new resource, String) The Common Name (AKA CN) represents the server name protected by the SSL certificate.
- Constraints: The maximum length is
64
characters. The minimum length is4
characters. The value must match regular expression/^(\\*\\.)?(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])\\.?$/
.
- Constraints: The maximum length is
- Created
At string - (String) The date when a resource was created. The date format follows RFC 3339.
- Created
By string - (String) The unique identifier that is associated with the entity that created the secret.
- Constraints: The maximum length is
128
characters. The minimum length is4
characters.
- Constraints: The maximum length is
- Crn string
- (String) A CRN that uniquely identifies an IBM Cloud resource.
- Constraints: The maximum length is
512
characters. The minimum length is9
characters. The value must match regular expression/^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/
.
- Constraints: The maximum length is
- Csr string
- (String) The certificate signing request generated based on the parameters in the
managed_csr
data. The value may differ from thecsr
attribute withinmanaged_csr
if themanaged_csr
attributes have been modified. - Downloaded bool
- (Boolean) Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.
- Expiration
Date string - The date a secret is expired. The date format follows RFC 3339.
- Id string
- The provider-assigned unique ID for this managed resource.
- Intermediate
Included bool - (Boolean) Indicates whether the certificate was imported with an associated intermediate certificate.
- Issuer string
- (Forces new resource, String) The distinguished name that identifies the entity that signed and issued the certificate.
- Constraints: The maximum length is
128
characters. The minimum length is2
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- Key
Algorithm string - (String) The identifier for the cryptographic algorithm used to generate the public key that is associated with the certificate.
- Constraints: The maximum length is
10
characters. The minimum length is2
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- Locks
Total float64 - (Integer) The number of locks of the secret.
- Constraints: The maximum value is
1000
. The minimum value is0
.
- Constraints: The maximum value is
- Private
Key boolIncluded - (Boolean) Indicates whether the certificate was imported with an associated private key.
- Secret
Id string - The unique identifier of the ImportedCertificate.
- Secret
Type string - (String) The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.
- Constraints: Allowable values are:
arbitrary
,imported_cert
,public_cert
,iam_credentials
,kv
,username_password
,private_cert
.
- Constraints: Allowable values are:
- Serial
Number string - (String) The unique serial number that was assigned to a certificate by the issuing certificate authority.
- Constraints: The maximum length is
64
characters. The minimum length is2
characters. The value must match regular expression/[^a-fA-F0-9]/
.
- Constraints: The maximum length is
- Signing
Algorithm string - (String) The identifier for the cryptographic algorithm that was used by the issuing certificate authority to sign a certificate.
- Constraints: The maximum length is
64
characters. The minimum length is4
characters.
- Constraints: The maximum length is
- State float64
- (Integer) The secret state that is based on NIST SP 800-57. States are integers and correspond to the
Pre-activation = 0
,Active = 1
,Suspended = 2
,Deactivated = 3
, andDestroyed = 5
values.- Constraints: Allowable values are:
0
,1
,2
,3
,5
.
- Constraints: Allowable values are:
- State
Description string - (String) A text representation of the secret state.
- Constraints: Allowable values are:
pre_activation
,active
,suspended
,deactivated
,destroyed
.
- Constraints: Allowable values are:
- Updated
At string - (String) The date when a resource was recently modified. The date format follows RFC 3339.
- Validities
[]Sm
Imported Certificate Validity - (List) The date and time that the certificate validity period begins and ends. Nested scheme for validity:
- Versions
Total float64 - (Integer) The number of versions of the secret.
- Constraints: The maximum value is
50
. The minimum value is0
.
- Constraints: The maximum value is
- common
Name String - (Forces new resource, String) The Common Name (AKA CN) represents the server name protected by the SSL certificate.
- Constraints: The maximum length is
64
characters. The minimum length is4
characters. The value must match regular expression/^(\\*\\.)?(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])\\.?$/
.
- Constraints: The maximum length is
- created
At String - (String) The date when a resource was created. The date format follows RFC 3339.
- created
By String - (String) The unique identifier that is associated with the entity that created the secret.
- Constraints: The maximum length is
128
characters. The minimum length is4
characters.
- Constraints: The maximum length is
- crn String
- (String) A CRN that uniquely identifies an IBM Cloud resource.
- Constraints: The maximum length is
512
characters. The minimum length is9
characters. The value must match regular expression/^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/
.
- Constraints: The maximum length is
- csr String
- (String) The certificate signing request generated based on the parameters in the
managed_csr
data. The value may differ from thecsr
attribute withinmanaged_csr
if themanaged_csr
attributes have been modified. - downloaded Boolean
- (Boolean) Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.
- expiration
Date String - The date a secret is expired. The date format follows RFC 3339.
- id String
- The provider-assigned unique ID for this managed resource.
- intermediate
Included Boolean - (Boolean) Indicates whether the certificate was imported with an associated intermediate certificate.
- issuer String
- (Forces new resource, String) The distinguished name that identifies the entity that signed and issued the certificate.
- Constraints: The maximum length is
128
characters. The minimum length is2
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- key
Algorithm String - (String) The identifier for the cryptographic algorithm used to generate the public key that is associated with the certificate.
- Constraints: The maximum length is
10
characters. The minimum length is2
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- locks
Total Double - (Integer) The number of locks of the secret.
- Constraints: The maximum value is
1000
. The minimum value is0
.
- Constraints: The maximum value is
- private
Key BooleanIncluded - (Boolean) Indicates whether the certificate was imported with an associated private key.
- secret
Id String - The unique identifier of the ImportedCertificate.
- secret
Type String - (String) The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.
- Constraints: Allowable values are:
arbitrary
,imported_cert
,public_cert
,iam_credentials
,kv
,username_password
,private_cert
.
- Constraints: Allowable values are:
- serial
Number String - (String) The unique serial number that was assigned to a certificate by the issuing certificate authority.
- Constraints: The maximum length is
64
characters. The minimum length is2
characters. The value must match regular expression/[^a-fA-F0-9]/
.
- Constraints: The maximum length is
- signing
Algorithm String - (String) The identifier for the cryptographic algorithm that was used by the issuing certificate authority to sign a certificate.
- Constraints: The maximum length is
64
characters. The minimum length is4
characters.
- Constraints: The maximum length is
- state Double
- (Integer) The secret state that is based on NIST SP 800-57. States are integers and correspond to the
Pre-activation = 0
,Active = 1
,Suspended = 2
,Deactivated = 3
, andDestroyed = 5
values.- Constraints: Allowable values are:
0
,1
,2
,3
,5
.
- Constraints: Allowable values are:
- state
Description String - (String) A text representation of the secret state.
- Constraints: Allowable values are:
pre_activation
,active
,suspended
,deactivated
,destroyed
.
- Constraints: Allowable values are:
- updated
At String - (String) The date when a resource was recently modified. The date format follows RFC 3339.
- validities
List<Sm
Imported Certificate Validity> - (List) The date and time that the certificate validity period begins and ends. Nested scheme for validity:
- versions
Total Double - (Integer) The number of versions of the secret.
- Constraints: The maximum value is
50
. The minimum value is0
.
- Constraints: The maximum value is
- common
Name string - (Forces new resource, String) The Common Name (AKA CN) represents the server name protected by the SSL certificate.
- Constraints: The maximum length is
64
characters. The minimum length is4
characters. The value must match regular expression/^(\\*\\.)?(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])\\.?$/
.
- Constraints: The maximum length is
- created
At string - (String) The date when a resource was created. The date format follows RFC 3339.
- created
By string - (String) The unique identifier that is associated with the entity that created the secret.
- Constraints: The maximum length is
128
characters. The minimum length is4
characters.
- Constraints: The maximum length is
- crn string
- (String) A CRN that uniquely identifies an IBM Cloud resource.
- Constraints: The maximum length is
512
characters. The minimum length is9
characters. The value must match regular expression/^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/
.
- Constraints: The maximum length is
- csr string
- (String) The certificate signing request generated based on the parameters in the
managed_csr
data. The value may differ from thecsr
attribute withinmanaged_csr
if themanaged_csr
attributes have been modified. - downloaded boolean
- (Boolean) Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.
- expiration
Date string - The date a secret is expired. The date format follows RFC 3339.
- id string
- The provider-assigned unique ID for this managed resource.
- intermediate
Included boolean - (Boolean) Indicates whether the certificate was imported with an associated intermediate certificate.
- issuer string
- (Forces new resource, String) The distinguished name that identifies the entity that signed and issued the certificate.
- Constraints: The maximum length is
128
characters. The minimum length is2
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- key
Algorithm string - (String) The identifier for the cryptographic algorithm used to generate the public key that is associated with the certificate.
- Constraints: The maximum length is
10
characters. The minimum length is2
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- locks
Total number - (Integer) The number of locks of the secret.
- Constraints: The maximum value is
1000
. The minimum value is0
.
- Constraints: The maximum value is
- private
Key booleanIncluded - (Boolean) Indicates whether the certificate was imported with an associated private key.
- secret
Id string - The unique identifier of the ImportedCertificate.
- secret
Type string - (String) The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.
- Constraints: Allowable values are:
arbitrary
,imported_cert
,public_cert
,iam_credentials
,kv
,username_password
,private_cert
.
- Constraints: Allowable values are:
- serial
Number string - (String) The unique serial number that was assigned to a certificate by the issuing certificate authority.
- Constraints: The maximum length is
64
characters. The minimum length is2
characters. The value must match regular expression/[^a-fA-F0-9]/
.
- Constraints: The maximum length is
- signing
Algorithm string - (String) The identifier for the cryptographic algorithm that was used by the issuing certificate authority to sign a certificate.
- Constraints: The maximum length is
64
characters. The minimum length is4
characters.
- Constraints: The maximum length is
- state number
- (Integer) The secret state that is based on NIST SP 800-57. States are integers and correspond to the
Pre-activation = 0
,Active = 1
,Suspended = 2
,Deactivated = 3
, andDestroyed = 5
values.- Constraints: Allowable values are:
0
,1
,2
,3
,5
.
- Constraints: Allowable values are:
- state
Description string - (String) A text representation of the secret state.
- Constraints: Allowable values are:
pre_activation
,active
,suspended
,deactivated
,destroyed
.
- Constraints: Allowable values are:
- updated
At string - (String) The date when a resource was recently modified. The date format follows RFC 3339.
- validities
Sm
Imported Certificate Validity[] - (List) The date and time that the certificate validity period begins and ends. Nested scheme for validity:
- versions
Total number - (Integer) The number of versions of the secret.
- Constraints: The maximum value is
50
. The minimum value is0
.
- Constraints: The maximum value is
- common_
name str - (Forces new resource, String) The Common Name (AKA CN) represents the server name protected by the SSL certificate.
- Constraints: The maximum length is
64
characters. The minimum length is4
characters. The value must match regular expression/^(\\*\\.)?(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])\\.?$/
.
- Constraints: The maximum length is
- created_
at str - (String) The date when a resource was created. The date format follows RFC 3339.
- created_
by str - (String) The unique identifier that is associated with the entity that created the secret.
- Constraints: The maximum length is
128
characters. The minimum length is4
characters.
- Constraints: The maximum length is
- crn str
- (String) A CRN that uniquely identifies an IBM Cloud resource.
- Constraints: The maximum length is
512
characters. The minimum length is9
characters. The value must match regular expression/^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/
.
- Constraints: The maximum length is
- csr str
- (String) The certificate signing request generated based on the parameters in the
managed_csr
data. The value may differ from thecsr
attribute withinmanaged_csr
if themanaged_csr
attributes have been modified. - downloaded bool
- (Boolean) Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.
- expiration_
date str - The date a secret is expired. The date format follows RFC 3339.
- id str
- The provider-assigned unique ID for this managed resource.
- intermediate_
included bool - (Boolean) Indicates whether the certificate was imported with an associated intermediate certificate.
- issuer str
- (Forces new resource, String) The distinguished name that identifies the entity that signed and issued the certificate.
- Constraints: The maximum length is
128
characters. The minimum length is2
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- key_
algorithm str - (String) The identifier for the cryptographic algorithm used to generate the public key that is associated with the certificate.
- Constraints: The maximum length is
10
characters. The minimum length is2
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- locks_
total float - (Integer) The number of locks of the secret.
- Constraints: The maximum value is
1000
. The minimum value is0
.
- Constraints: The maximum value is
- private_
key_ boolincluded - (Boolean) Indicates whether the certificate was imported with an associated private key.
- secret_
id str - The unique identifier of the ImportedCertificate.
- secret_
type str - (String) The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.
- Constraints: Allowable values are:
arbitrary
,imported_cert
,public_cert
,iam_credentials
,kv
,username_password
,private_cert
.
- Constraints: Allowable values are:
- serial_
number str - (String) The unique serial number that was assigned to a certificate by the issuing certificate authority.
- Constraints: The maximum length is
64
characters. The minimum length is2
characters. The value must match regular expression/[^a-fA-F0-9]/
.
- Constraints: The maximum length is
- signing_
algorithm str - (String) The identifier for the cryptographic algorithm that was used by the issuing certificate authority to sign a certificate.
- Constraints: The maximum length is
64
characters. The minimum length is4
characters.
- Constraints: The maximum length is
- state float
- (Integer) The secret state that is based on NIST SP 800-57. States are integers and correspond to the
Pre-activation = 0
,Active = 1
,Suspended = 2
,Deactivated = 3
, andDestroyed = 5
values.- Constraints: Allowable values are:
0
,1
,2
,3
,5
.
- Constraints: Allowable values are:
- state_
description str - (String) A text representation of the secret state.
- Constraints: Allowable values are:
pre_activation
,active
,suspended
,deactivated
,destroyed
.
- Constraints: Allowable values are:
- updated_
at str - (String) The date when a resource was recently modified. The date format follows RFC 3339.
- validities
Sequence[Sm
Imported Certificate Validity] - (List) The date and time that the certificate validity period begins and ends. Nested scheme for validity:
- versions_
total float - (Integer) The number of versions of the secret.
- Constraints: The maximum value is
50
. The minimum value is0
.
- Constraints: The maximum value is
- common
Name String - (Forces new resource, String) The Common Name (AKA CN) represents the server name protected by the SSL certificate.
- Constraints: The maximum length is
64
characters. The minimum length is4
characters. The value must match regular expression/^(\\*\\.)?(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])\\.?$/
.
- Constraints: The maximum length is
- created
At String - (String) The date when a resource was created. The date format follows RFC 3339.
- created
By String - (String) The unique identifier that is associated with the entity that created the secret.
- Constraints: The maximum length is
128
characters. The minimum length is4
characters.
- Constraints: The maximum length is
- crn String
- (String) A CRN that uniquely identifies an IBM Cloud resource.
- Constraints: The maximum length is
512
characters. The minimum length is9
characters. The value must match regular expression/^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/
.
- Constraints: The maximum length is
- csr String
- (String) The certificate signing request generated based on the parameters in the
managed_csr
data. The value may differ from thecsr
attribute withinmanaged_csr
if themanaged_csr
attributes have been modified. - downloaded Boolean
- (Boolean) Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.
- expiration
Date String - The date a secret is expired. The date format follows RFC 3339.
- id String
- The provider-assigned unique ID for this managed resource.
- intermediate
Included Boolean - (Boolean) Indicates whether the certificate was imported with an associated intermediate certificate.
- issuer String
- (Forces new resource, String) The distinguished name that identifies the entity that signed and issued the certificate.
- Constraints: The maximum length is
128
characters. The minimum length is2
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- key
Algorithm String - (String) The identifier for the cryptographic algorithm used to generate the public key that is associated with the certificate.
- Constraints: The maximum length is
10
characters. The minimum length is2
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- locks
Total Number - (Integer) The number of locks of the secret.
- Constraints: The maximum value is
1000
. The minimum value is0
.
- Constraints: The maximum value is
- private
Key BooleanIncluded - (Boolean) Indicates whether the certificate was imported with an associated private key.
- secret
Id String - The unique identifier of the ImportedCertificate.
- secret
Type String - (String) The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.
- Constraints: Allowable values are:
arbitrary
,imported_cert
,public_cert
,iam_credentials
,kv
,username_password
,private_cert
.
- Constraints: Allowable values are:
- serial
Number String - (String) The unique serial number that was assigned to a certificate by the issuing certificate authority.
- Constraints: The maximum length is
64
characters. The minimum length is2
characters. The value must match regular expression/[^a-fA-F0-9]/
.
- Constraints: The maximum length is
- signing
Algorithm String - (String) The identifier for the cryptographic algorithm that was used by the issuing certificate authority to sign a certificate.
- Constraints: The maximum length is
64
characters. The minimum length is4
characters.
- Constraints: The maximum length is
- state Number
- (Integer) The secret state that is based on NIST SP 800-57. States are integers and correspond to the
Pre-activation = 0
,Active = 1
,Suspended = 2
,Deactivated = 3
, andDestroyed = 5
values.- Constraints: Allowable values are:
0
,1
,2
,3
,5
.
- Constraints: Allowable values are:
- state
Description String - (String) A text representation of the secret state.
- Constraints: Allowable values are:
pre_activation
,active
,suspended
,deactivated
,destroyed
.
- Constraints: Allowable values are:
- updated
At String - (String) The date when a resource was recently modified. The date format follows RFC 3339.
- validities List<Property Map>
- (List) The date and time that the certificate validity period begins and ends. Nested scheme for validity:
- versions
Total Number - (Integer) The number of versions of the secret.
- Constraints: The maximum value is
50
. The minimum value is0
.
- Constraints: The maximum value is
Look up Existing SmImportedCertificate Resource
Get an existing SmImportedCertificate resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: SmImportedCertificateState, opts?: CustomResourceOptions): SmImportedCertificate
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
certificate: Optional[str] = None,
common_name: Optional[str] = None,
created_at: Optional[str] = None,
created_by: Optional[str] = None,
crn: Optional[str] = None,
csr: Optional[str] = None,
custom_metadata: Optional[Mapping[str, str]] = None,
description: Optional[str] = None,
downloaded: Optional[bool] = None,
endpoint_type: Optional[str] = None,
expiration_date: Optional[str] = None,
instance_id: Optional[str] = None,
intermediate: Optional[str] = None,
intermediate_included: Optional[bool] = None,
issuer: Optional[str] = None,
key_algorithm: Optional[str] = None,
labels: Optional[Sequence[str]] = None,
locks_total: Optional[float] = None,
managed_csr: Optional[SmImportedCertificateManagedCsrArgs] = None,
name: Optional[str] = None,
private_key: Optional[str] = None,
private_key_included: Optional[bool] = None,
region: Optional[str] = None,
secret_group_id: Optional[str] = None,
secret_id: Optional[str] = None,
secret_type: Optional[str] = None,
serial_number: Optional[str] = None,
signing_algorithm: Optional[str] = None,
sm_imported_certificate_id: Optional[str] = None,
state: Optional[float] = None,
state_description: Optional[str] = None,
updated_at: Optional[str] = None,
validities: Optional[Sequence[SmImportedCertificateValidityArgs]] = None,
version_custom_metadata: Optional[Mapping[str, str]] = None,
versions_total: Optional[float] = None) -> SmImportedCertificate
func GetSmImportedCertificate(ctx *Context, name string, id IDInput, state *SmImportedCertificateState, opts ...ResourceOption) (*SmImportedCertificate, error)
public static SmImportedCertificate Get(string name, Input<string> id, SmImportedCertificateState? state, CustomResourceOptions? opts = null)
public static SmImportedCertificate get(String name, Output<String> id, SmImportedCertificateState state, CustomResourceOptions options)
resources: _: type: ibm:SmImportedCertificate get: id: ${id}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Certificate string
- The PEM-encoded contents of your certificate. You can manually rotate the secret by modifying this argument, together with the optional arguments
intermediate
andprivate_key
. Modifying the certificate creates a new version of the secret. If the secret is used to generate a Certificate Signing Reques (CSR) no certificate should be provided initially. Add the certificate value only after the CSR is signed.- Constraints: The maximum length is
100000
characters. The minimum length is50
characters. The value must match regular expression/^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/
.
- Constraints: The maximum length is
- Common
Name string - (Forces new resource, String) The Common Name (AKA CN) represents the server name protected by the SSL certificate.
- Constraints: The maximum length is
64
characters. The minimum length is4
characters. The value must match regular expression/^(\\*\\.)?(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])\\.?$/
.
- Constraints: The maximum length is
- Created
At string - (String) The date when a resource was created. The date format follows RFC 3339.
- Created
By string - (String) The unique identifier that is associated with the entity that created the secret.
- Constraints: The maximum length is
128
characters. The minimum length is4
characters.
- Constraints: The maximum length is
- Crn string
- (String) A CRN that uniquely identifies an IBM Cloud resource.
- Constraints: The maximum length is
512
characters. The minimum length is9
characters. The value must match regular expression/^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/
.
- Constraints: The maximum length is
- Csr string
- (String) The certificate signing request generated based on the parameters in the
managed_csr
data. The value may differ from thecsr
attribute withinmanaged_csr
if themanaged_csr
attributes have been modified. - Custom
Metadata Dictionary<string, string> - The secret metadata that a user can customize.
- Description string
- An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.
- Constraints: The maximum length is
1024
characters. The minimum length is0
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- Downloaded bool
- (Boolean) Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.
- Endpoint
Type string - The endpoint type. If not provided the endpoint type is determined by the
visibility
argument provided in the provider configuration.- Constraints: Allowable values are:
private
,public
.
- Constraints: Allowable values are:
- Expiration
Date string - The date a secret is expired. The date format follows RFC 3339.
- Instance
Id string - The GUID of the Secrets Manager instance.
- Intermediate string
- (Optional) The PEM-encoded intermediate certificate to associate with the root certificate.
- Constraints: The maximum length is
100000
characters. The minimum length is50
characters. The value must match regular expression/^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/
.
- Constraints: The maximum length is
- Intermediate
Included bool - (Boolean) Indicates whether the certificate was imported with an associated intermediate certificate.
- Issuer string
- (Forces new resource, String) The distinguished name that identifies the entity that signed and issued the certificate.
- Constraints: The maximum length is
128
characters. The minimum length is2
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- Key
Algorithm string - (String) The identifier for the cryptographic algorithm used to generate the public key that is associated with the certificate.
- Constraints: The maximum length is
10
characters. The minimum length is2
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- Labels List<string>
- Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.
- Constraints: The list items must match regular expression
/(.*?)/
. The maximum length is30
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- Locks
Total double - (Integer) The number of locks of the secret.
- Constraints: The maximum value is
1000
. The minimum value is0
.
- Constraints: The maximum value is
- Managed
Csr SmImported Certificate Managed Csr - The data specified to create the CSR and the private key. Nested scheme for managed_csr:
- Name string
- The human-readable name of your secret.
- Constraints: The maximum length is
256
characters. The minimum length is2
characters. The value must match regular expression^[A-Za-z0-9_][A-Za-z0-9_]*(?:_*-*\.*[A-Za-z0-9]*)*[A-Za-z0-9]+$
.
- Constraints: The maximum length is
- Private
Key string - (Optional) The PEM-encoded private key to associate with the certificate.
- Constraints: The maximum length is
100000
characters. The minimum length is50
characters. The value must match regular expression/^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/
.
- Constraints: The maximum length is
- Private
Key boolIncluded - (Boolean) Indicates whether the certificate was imported with an associated private key.
- Region string
- The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
- Secret
Group stringId - A UUID identifier, or
default
secret group.- Constraints: The maximum length is
36
characters. The minimum length is7
characters. The value must match regular expression/^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|default)$/
.
- Constraints: The maximum length is
- Secret
Id string - The unique identifier of the ImportedCertificate.
- Secret
Type string - (String) The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.
- Constraints: Allowable values are:
arbitrary
,imported_cert
,public_cert
,iam_credentials
,kv
,username_password
,private_cert
.
- Constraints: Allowable values are:
- Serial
Number string - (String) The unique serial number that was assigned to a certificate by the issuing certificate authority.
- Constraints: The maximum length is
64
characters. The minimum length is2
characters. The value must match regular expression/[^a-fA-F0-9]/
.
- Constraints: The maximum length is
- Signing
Algorithm string - (String) The identifier for the cryptographic algorithm that was used by the issuing certificate authority to sign a certificate.
- Constraints: The maximum length is
64
characters. The minimum length is4
characters.
- Constraints: The maximum length is
- Sm
Imported stringCertificate Id - State double
- (Integer) The secret state that is based on NIST SP 800-57. States are integers and correspond to the
Pre-activation = 0
,Active = 1
,Suspended = 2
,Deactivated = 3
, andDestroyed = 5
values.- Constraints: Allowable values are:
0
,1
,2
,3
,5
.
- Constraints: Allowable values are:
- State
Description string - (String) A text representation of the secret state.
- Constraints: Allowable values are:
pre_activation
,active
,suspended
,deactivated
,destroyed
.
- Constraints: Allowable values are:
- Updated
At string - (String) The date when a resource was recently modified. The date format follows RFC 3339.
- Validities
List<Sm
Imported Certificate Validity> - (List) The date and time that the certificate validity period begins and ends. Nested scheme for validity:
- Version
Custom Dictionary<string, string>Metadata - The secret version metadata that a user can customize.
- Versions
Total double - (Integer) The number of versions of the secret.
- Constraints: The maximum value is
50
. The minimum value is0
.
- Constraints: The maximum value is
- Certificate string
- The PEM-encoded contents of your certificate. You can manually rotate the secret by modifying this argument, together with the optional arguments
intermediate
andprivate_key
. Modifying the certificate creates a new version of the secret. If the secret is used to generate a Certificate Signing Reques (CSR) no certificate should be provided initially. Add the certificate value only after the CSR is signed.- Constraints: The maximum length is
100000
characters. The minimum length is50
characters. The value must match regular expression/^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/
.
- Constraints: The maximum length is
- Common
Name string - (Forces new resource, String) The Common Name (AKA CN) represents the server name protected by the SSL certificate.
- Constraints: The maximum length is
64
characters. The minimum length is4
characters. The value must match regular expression/^(\\*\\.)?(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])\\.?$/
.
- Constraints: The maximum length is
- Created
At string - (String) The date when a resource was created. The date format follows RFC 3339.
- Created
By string - (String) The unique identifier that is associated with the entity that created the secret.
- Constraints: The maximum length is
128
characters. The minimum length is4
characters.
- Constraints: The maximum length is
- Crn string
- (String) A CRN that uniquely identifies an IBM Cloud resource.
- Constraints: The maximum length is
512
characters. The minimum length is9
characters. The value must match regular expression/^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/
.
- Constraints: The maximum length is
- Csr string
- (String) The certificate signing request generated based on the parameters in the
managed_csr
data. The value may differ from thecsr
attribute withinmanaged_csr
if themanaged_csr
attributes have been modified. - Custom
Metadata map[string]string - The secret metadata that a user can customize.
- Description string
- An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.
- Constraints: The maximum length is
1024
characters. The minimum length is0
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- Downloaded bool
- (Boolean) Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.
- Endpoint
Type string - The endpoint type. If not provided the endpoint type is determined by the
visibility
argument provided in the provider configuration.- Constraints: Allowable values are:
private
,public
.
- Constraints: Allowable values are:
- Expiration
Date string - The date a secret is expired. The date format follows RFC 3339.
- Instance
Id string - The GUID of the Secrets Manager instance.
- Intermediate string
- (Optional) The PEM-encoded intermediate certificate to associate with the root certificate.
- Constraints: The maximum length is
100000
characters. The minimum length is50
characters. The value must match regular expression/^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/
.
- Constraints: The maximum length is
- Intermediate
Included bool - (Boolean) Indicates whether the certificate was imported with an associated intermediate certificate.
- Issuer string
- (Forces new resource, String) The distinguished name that identifies the entity that signed and issued the certificate.
- Constraints: The maximum length is
128
characters. The minimum length is2
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- Key
Algorithm string - (String) The identifier for the cryptographic algorithm used to generate the public key that is associated with the certificate.
- Constraints: The maximum length is
10
characters. The minimum length is2
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- Labels []string
- Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.
- Constraints: The list items must match regular expression
/(.*?)/
. The maximum length is30
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- Locks
Total float64 - (Integer) The number of locks of the secret.
- Constraints: The maximum value is
1000
. The minimum value is0
.
- Constraints: The maximum value is
- Managed
Csr SmImported Certificate Managed Csr Args - The data specified to create the CSR and the private key. Nested scheme for managed_csr:
- Name string
- The human-readable name of your secret.
- Constraints: The maximum length is
256
characters. The minimum length is2
characters. The value must match regular expression^[A-Za-z0-9_][A-Za-z0-9_]*(?:_*-*\.*[A-Za-z0-9]*)*[A-Za-z0-9]+$
.
- Constraints: The maximum length is
- Private
Key string - (Optional) The PEM-encoded private key to associate with the certificate.
- Constraints: The maximum length is
100000
characters. The minimum length is50
characters. The value must match regular expression/^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/
.
- Constraints: The maximum length is
- Private
Key boolIncluded - (Boolean) Indicates whether the certificate was imported with an associated private key.
- Region string
- The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
- Secret
Group stringId - A UUID identifier, or
default
secret group.- Constraints: The maximum length is
36
characters. The minimum length is7
characters. The value must match regular expression/^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|default)$/
.
- Constraints: The maximum length is
- Secret
Id string - The unique identifier of the ImportedCertificate.
- Secret
Type string - (String) The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.
- Constraints: Allowable values are:
arbitrary
,imported_cert
,public_cert
,iam_credentials
,kv
,username_password
,private_cert
.
- Constraints: Allowable values are:
- Serial
Number string - (String) The unique serial number that was assigned to a certificate by the issuing certificate authority.
- Constraints: The maximum length is
64
characters. The minimum length is2
characters. The value must match regular expression/[^a-fA-F0-9]/
.
- Constraints: The maximum length is
- Signing
Algorithm string - (String) The identifier for the cryptographic algorithm that was used by the issuing certificate authority to sign a certificate.
- Constraints: The maximum length is
64
characters. The minimum length is4
characters.
- Constraints: The maximum length is
- Sm
Imported stringCertificate Id - State float64
- (Integer) The secret state that is based on NIST SP 800-57. States are integers and correspond to the
Pre-activation = 0
,Active = 1
,Suspended = 2
,Deactivated = 3
, andDestroyed = 5
values.- Constraints: Allowable values are:
0
,1
,2
,3
,5
.
- Constraints: Allowable values are:
- State
Description string - (String) A text representation of the secret state.
- Constraints: Allowable values are:
pre_activation
,active
,suspended
,deactivated
,destroyed
.
- Constraints: Allowable values are:
- Updated
At string - (String) The date when a resource was recently modified. The date format follows RFC 3339.
- Validities
[]Sm
Imported Certificate Validity Args - (List) The date and time that the certificate validity period begins and ends. Nested scheme for validity:
- Version
Custom map[string]stringMetadata - The secret version metadata that a user can customize.
- Versions
Total float64 - (Integer) The number of versions of the secret.
- Constraints: The maximum value is
50
. The minimum value is0
.
- Constraints: The maximum value is
- certificate String
- The PEM-encoded contents of your certificate. You can manually rotate the secret by modifying this argument, together with the optional arguments
intermediate
andprivate_key
. Modifying the certificate creates a new version of the secret. If the secret is used to generate a Certificate Signing Reques (CSR) no certificate should be provided initially. Add the certificate value only after the CSR is signed.- Constraints: The maximum length is
100000
characters. The minimum length is50
characters. The value must match regular expression/^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/
.
- Constraints: The maximum length is
- common
Name String - (Forces new resource, String) The Common Name (AKA CN) represents the server name protected by the SSL certificate.
- Constraints: The maximum length is
64
characters. The minimum length is4
characters. The value must match regular expression/^(\\*\\.)?(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])\\.?$/
.
- Constraints: The maximum length is
- created
At String - (String) The date when a resource was created. The date format follows RFC 3339.
- created
By String - (String) The unique identifier that is associated with the entity that created the secret.
- Constraints: The maximum length is
128
characters. The minimum length is4
characters.
- Constraints: The maximum length is
- crn String
- (String) A CRN that uniquely identifies an IBM Cloud resource.
- Constraints: The maximum length is
512
characters. The minimum length is9
characters. The value must match regular expression/^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/
.
- Constraints: The maximum length is
- csr String
- (String) The certificate signing request generated based on the parameters in the
managed_csr
data. The value may differ from thecsr
attribute withinmanaged_csr
if themanaged_csr
attributes have been modified. - custom
Metadata Map<String,String> - The secret metadata that a user can customize.
- description String
- An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.
- Constraints: The maximum length is
1024
characters. The minimum length is0
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- downloaded Boolean
- (Boolean) Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.
- endpoint
Type String - The endpoint type. If not provided the endpoint type is determined by the
visibility
argument provided in the provider configuration.- Constraints: Allowable values are:
private
,public
.
- Constraints: Allowable values are:
- expiration
Date String - The date a secret is expired. The date format follows RFC 3339.
- instance
Id String - The GUID of the Secrets Manager instance.
- intermediate String
- (Optional) The PEM-encoded intermediate certificate to associate with the root certificate.
- Constraints: The maximum length is
100000
characters. The minimum length is50
characters. The value must match regular expression/^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/
.
- Constraints: The maximum length is
- intermediate
Included Boolean - (Boolean) Indicates whether the certificate was imported with an associated intermediate certificate.
- issuer String
- (Forces new resource, String) The distinguished name that identifies the entity that signed and issued the certificate.
- Constraints: The maximum length is
128
characters. The minimum length is2
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- key
Algorithm String - (String) The identifier for the cryptographic algorithm used to generate the public key that is associated with the certificate.
- Constraints: The maximum length is
10
characters. The minimum length is2
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- labels List<String>
- Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.
- Constraints: The list items must match regular expression
/(.*?)/
. The maximum length is30
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- locks
Total Double - (Integer) The number of locks of the secret.
- Constraints: The maximum value is
1000
. The minimum value is0
.
- Constraints: The maximum value is
- managed
Csr SmImported Certificate Managed Csr - The data specified to create the CSR and the private key. Nested scheme for managed_csr:
- name String
- The human-readable name of your secret.
- Constraints: The maximum length is
256
characters. The minimum length is2
characters. The value must match regular expression^[A-Za-z0-9_][A-Za-z0-9_]*(?:_*-*\.*[A-Za-z0-9]*)*[A-Za-z0-9]+$
.
- Constraints: The maximum length is
- private
Key String - (Optional) The PEM-encoded private key to associate with the certificate.
- Constraints: The maximum length is
100000
characters. The minimum length is50
characters. The value must match regular expression/^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/
.
- Constraints: The maximum length is
- private
Key BooleanIncluded - (Boolean) Indicates whether the certificate was imported with an associated private key.
- region String
- The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
- secret
Group StringId - A UUID identifier, or
default
secret group.- Constraints: The maximum length is
36
characters. The minimum length is7
characters. The value must match regular expression/^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|default)$/
.
- Constraints: The maximum length is
- secret
Id String - The unique identifier of the ImportedCertificate.
- secret
Type String - (String) The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.
- Constraints: Allowable values are:
arbitrary
,imported_cert
,public_cert
,iam_credentials
,kv
,username_password
,private_cert
.
- Constraints: Allowable values are:
- serial
Number String - (String) The unique serial number that was assigned to a certificate by the issuing certificate authority.
- Constraints: The maximum length is
64
characters. The minimum length is2
characters. The value must match regular expression/[^a-fA-F0-9]/
.
- Constraints: The maximum length is
- signing
Algorithm String - (String) The identifier for the cryptographic algorithm that was used by the issuing certificate authority to sign a certificate.
- Constraints: The maximum length is
64
characters. The minimum length is4
characters.
- Constraints: The maximum length is
- sm
Imported StringCertificate Id - state Double
- (Integer) The secret state that is based on NIST SP 800-57. States are integers and correspond to the
Pre-activation = 0
,Active = 1
,Suspended = 2
,Deactivated = 3
, andDestroyed = 5
values.- Constraints: Allowable values are:
0
,1
,2
,3
,5
.
- Constraints: Allowable values are:
- state
Description String - (String) A text representation of the secret state.
- Constraints: Allowable values are:
pre_activation
,active
,suspended
,deactivated
,destroyed
.
- Constraints: Allowable values are:
- updated
At String - (String) The date when a resource was recently modified. The date format follows RFC 3339.
- validities
List<Sm
Imported Certificate Validity> - (List) The date and time that the certificate validity period begins and ends. Nested scheme for validity:
- version
Custom Map<String,String>Metadata - The secret version metadata that a user can customize.
- versions
Total Double - (Integer) The number of versions of the secret.
- Constraints: The maximum value is
50
. The minimum value is0
.
- Constraints: The maximum value is
- certificate string
- The PEM-encoded contents of your certificate. You can manually rotate the secret by modifying this argument, together with the optional arguments
intermediate
andprivate_key
. Modifying the certificate creates a new version of the secret. If the secret is used to generate a Certificate Signing Reques (CSR) no certificate should be provided initially. Add the certificate value only after the CSR is signed.- Constraints: The maximum length is
100000
characters. The minimum length is50
characters. The value must match regular expression/^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/
.
- Constraints: The maximum length is
- common
Name string - (Forces new resource, String) The Common Name (AKA CN) represents the server name protected by the SSL certificate.
- Constraints: The maximum length is
64
characters. The minimum length is4
characters. The value must match regular expression/^(\\*\\.)?(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])\\.?$/
.
- Constraints: The maximum length is
- created
At string - (String) The date when a resource was created. The date format follows RFC 3339.
- created
By string - (String) The unique identifier that is associated with the entity that created the secret.
- Constraints: The maximum length is
128
characters. The minimum length is4
characters.
- Constraints: The maximum length is
- crn string
- (String) A CRN that uniquely identifies an IBM Cloud resource.
- Constraints: The maximum length is
512
characters. The minimum length is9
characters. The value must match regular expression/^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/
.
- Constraints: The maximum length is
- csr string
- (String) The certificate signing request generated based on the parameters in the
managed_csr
data. The value may differ from thecsr
attribute withinmanaged_csr
if themanaged_csr
attributes have been modified. - custom
Metadata {[key: string]: string} - The secret metadata that a user can customize.
- description string
- An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.
- Constraints: The maximum length is
1024
characters. The minimum length is0
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- downloaded boolean
- (Boolean) Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.
- endpoint
Type string - The endpoint type. If not provided the endpoint type is determined by the
visibility
argument provided in the provider configuration.- Constraints: Allowable values are:
private
,public
.
- Constraints: Allowable values are:
- expiration
Date string - The date a secret is expired. The date format follows RFC 3339.
- instance
Id string - The GUID of the Secrets Manager instance.
- intermediate string
- (Optional) The PEM-encoded intermediate certificate to associate with the root certificate.
- Constraints: The maximum length is
100000
characters. The minimum length is50
characters. The value must match regular expression/^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/
.
- Constraints: The maximum length is
- intermediate
Included boolean - (Boolean) Indicates whether the certificate was imported with an associated intermediate certificate.
- issuer string
- (Forces new resource, String) The distinguished name that identifies the entity that signed and issued the certificate.
- Constraints: The maximum length is
128
characters. The minimum length is2
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- key
Algorithm string - (String) The identifier for the cryptographic algorithm used to generate the public key that is associated with the certificate.
- Constraints: The maximum length is
10
characters. The minimum length is2
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- labels string[]
- Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.
- Constraints: The list items must match regular expression
/(.*?)/
. The maximum length is30
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- locks
Total number - (Integer) The number of locks of the secret.
- Constraints: The maximum value is
1000
. The minimum value is0
.
- Constraints: The maximum value is
- managed
Csr SmImported Certificate Managed Csr - The data specified to create the CSR and the private key. Nested scheme for managed_csr:
- name string
- The human-readable name of your secret.
- Constraints: The maximum length is
256
characters. The minimum length is2
characters. The value must match regular expression^[A-Za-z0-9_][A-Za-z0-9_]*(?:_*-*\.*[A-Za-z0-9]*)*[A-Za-z0-9]+$
.
- Constraints: The maximum length is
- private
Key string - (Optional) The PEM-encoded private key to associate with the certificate.
- Constraints: The maximum length is
100000
characters. The minimum length is50
characters. The value must match regular expression/^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/
.
- Constraints: The maximum length is
- private
Key booleanIncluded - (Boolean) Indicates whether the certificate was imported with an associated private key.
- region string
- The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
- secret
Group stringId - A UUID identifier, or
default
secret group.- Constraints: The maximum length is
36
characters. The minimum length is7
characters. The value must match regular expression/^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|default)$/
.
- Constraints: The maximum length is
- secret
Id string - The unique identifier of the ImportedCertificate.
- secret
Type string - (String) The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.
- Constraints: Allowable values are:
arbitrary
,imported_cert
,public_cert
,iam_credentials
,kv
,username_password
,private_cert
.
- Constraints: Allowable values are:
- serial
Number string - (String) The unique serial number that was assigned to a certificate by the issuing certificate authority.
- Constraints: The maximum length is
64
characters. The minimum length is2
characters. The value must match regular expression/[^a-fA-F0-9]/
.
- Constraints: The maximum length is
- signing
Algorithm string - (String) The identifier for the cryptographic algorithm that was used by the issuing certificate authority to sign a certificate.
- Constraints: The maximum length is
64
characters. The minimum length is4
characters.
- Constraints: The maximum length is
- sm
Imported stringCertificate Id - state number
- (Integer) The secret state that is based on NIST SP 800-57. States are integers and correspond to the
Pre-activation = 0
,Active = 1
,Suspended = 2
,Deactivated = 3
, andDestroyed = 5
values.- Constraints: Allowable values are:
0
,1
,2
,3
,5
.
- Constraints: Allowable values are:
- state
Description string - (String) A text representation of the secret state.
- Constraints: Allowable values are:
pre_activation
,active
,suspended
,deactivated
,destroyed
.
- Constraints: Allowable values are:
- updated
At string - (String) The date when a resource was recently modified. The date format follows RFC 3339.
- validities
Sm
Imported Certificate Validity[] - (List) The date and time that the certificate validity period begins and ends. Nested scheme for validity:
- version
Custom {[key: string]: string}Metadata - The secret version metadata that a user can customize.
- versions
Total number - (Integer) The number of versions of the secret.
- Constraints: The maximum value is
50
. The minimum value is0
.
- Constraints: The maximum value is
- certificate str
- The PEM-encoded contents of your certificate. You can manually rotate the secret by modifying this argument, together with the optional arguments
intermediate
andprivate_key
. Modifying the certificate creates a new version of the secret. If the secret is used to generate a Certificate Signing Reques (CSR) no certificate should be provided initially. Add the certificate value only after the CSR is signed.- Constraints: The maximum length is
100000
characters. The minimum length is50
characters. The value must match regular expression/^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/
.
- Constraints: The maximum length is
- common_
name str - (Forces new resource, String) The Common Name (AKA CN) represents the server name protected by the SSL certificate.
- Constraints: The maximum length is
64
characters. The minimum length is4
characters. The value must match regular expression/^(\\*\\.)?(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])\\.?$/
.
- Constraints: The maximum length is
- created_
at str - (String) The date when a resource was created. The date format follows RFC 3339.
- created_
by str - (String) The unique identifier that is associated with the entity that created the secret.
- Constraints: The maximum length is
128
characters. The minimum length is4
characters.
- Constraints: The maximum length is
- crn str
- (String) A CRN that uniquely identifies an IBM Cloud resource.
- Constraints: The maximum length is
512
characters. The minimum length is9
characters. The value must match regular expression/^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/
.
- Constraints: The maximum length is
- csr str
- (String) The certificate signing request generated based on the parameters in the
managed_csr
data. The value may differ from thecsr
attribute withinmanaged_csr
if themanaged_csr
attributes have been modified. - custom_
metadata Mapping[str, str] - The secret metadata that a user can customize.
- description str
- An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.
- Constraints: The maximum length is
1024
characters. The minimum length is0
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- downloaded bool
- (Boolean) Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.
- endpoint_
type str - The endpoint type. If not provided the endpoint type is determined by the
visibility
argument provided in the provider configuration.- Constraints: Allowable values are:
private
,public
.
- Constraints: Allowable values are:
- expiration_
date str - The date a secret is expired. The date format follows RFC 3339.
- instance_
id str - The GUID of the Secrets Manager instance.
- intermediate str
- (Optional) The PEM-encoded intermediate certificate to associate with the root certificate.
- Constraints: The maximum length is
100000
characters. The minimum length is50
characters. The value must match regular expression/^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/
.
- Constraints: The maximum length is
- intermediate_
included bool - (Boolean) Indicates whether the certificate was imported with an associated intermediate certificate.
- issuer str
- (Forces new resource, String) The distinguished name that identifies the entity that signed and issued the certificate.
- Constraints: The maximum length is
128
characters. The minimum length is2
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- key_
algorithm str - (String) The identifier for the cryptographic algorithm used to generate the public key that is associated with the certificate.
- Constraints: The maximum length is
10
characters. The minimum length is2
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- labels Sequence[str]
- Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.
- Constraints: The list items must match regular expression
/(.*?)/
. The maximum length is30
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- locks_
total float - (Integer) The number of locks of the secret.
- Constraints: The maximum value is
1000
. The minimum value is0
.
- Constraints: The maximum value is
- managed_
csr SmImported Certificate Managed Csr Args - The data specified to create the CSR and the private key. Nested scheme for managed_csr:
- name str
- The human-readable name of your secret.
- Constraints: The maximum length is
256
characters. The minimum length is2
characters. The value must match regular expression^[A-Za-z0-9_][A-Za-z0-9_]*(?:_*-*\.*[A-Za-z0-9]*)*[A-Za-z0-9]+$
.
- Constraints: The maximum length is
- private_
key str - (Optional) The PEM-encoded private key to associate with the certificate.
- Constraints: The maximum length is
100000
characters. The minimum length is50
characters. The value must match regular expression/^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/
.
- Constraints: The maximum length is
- private_
key_ boolincluded - (Boolean) Indicates whether the certificate was imported with an associated private key.
- region str
- The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
- secret_
group_ strid - A UUID identifier, or
default
secret group.- Constraints: The maximum length is
36
characters. The minimum length is7
characters. The value must match regular expression/^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|default)$/
.
- Constraints: The maximum length is
- secret_
id str - The unique identifier of the ImportedCertificate.
- secret_
type str - (String) The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.
- Constraints: Allowable values are:
arbitrary
,imported_cert
,public_cert
,iam_credentials
,kv
,username_password
,private_cert
.
- Constraints: Allowable values are:
- serial_
number str - (String) The unique serial number that was assigned to a certificate by the issuing certificate authority.
- Constraints: The maximum length is
64
characters. The minimum length is2
characters. The value must match regular expression/[^a-fA-F0-9]/
.
- Constraints: The maximum length is
- signing_
algorithm str - (String) The identifier for the cryptographic algorithm that was used by the issuing certificate authority to sign a certificate.
- Constraints: The maximum length is
64
characters. The minimum length is4
characters.
- Constraints: The maximum length is
- sm_
imported_ strcertificate_ id - state float
- (Integer) The secret state that is based on NIST SP 800-57. States are integers and correspond to the
Pre-activation = 0
,Active = 1
,Suspended = 2
,Deactivated = 3
, andDestroyed = 5
values.- Constraints: Allowable values are:
0
,1
,2
,3
,5
.
- Constraints: Allowable values are:
- state_
description str - (String) A text representation of the secret state.
- Constraints: Allowable values are:
pre_activation
,active
,suspended
,deactivated
,destroyed
.
- Constraints: Allowable values are:
- updated_
at str - (String) The date when a resource was recently modified. The date format follows RFC 3339.
- validities
Sequence[Sm
Imported Certificate Validity Args] - (List) The date and time that the certificate validity period begins and ends. Nested scheme for validity:
- version_
custom_ Mapping[str, str]metadata - The secret version metadata that a user can customize.
- versions_
total float - (Integer) The number of versions of the secret.
- Constraints: The maximum value is
50
. The minimum value is0
.
- Constraints: The maximum value is
- certificate String
- The PEM-encoded contents of your certificate. You can manually rotate the secret by modifying this argument, together with the optional arguments
intermediate
andprivate_key
. Modifying the certificate creates a new version of the secret. If the secret is used to generate a Certificate Signing Reques (CSR) no certificate should be provided initially. Add the certificate value only after the CSR is signed.- Constraints: The maximum length is
100000
characters. The minimum length is50
characters. The value must match regular expression/^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/
.
- Constraints: The maximum length is
- common
Name String - (Forces new resource, String) The Common Name (AKA CN) represents the server name protected by the SSL certificate.
- Constraints: The maximum length is
64
characters. The minimum length is4
characters. The value must match regular expression/^(\\*\\.)?(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])\\.?$/
.
- Constraints: The maximum length is
- created
At String - (String) The date when a resource was created. The date format follows RFC 3339.
- created
By String - (String) The unique identifier that is associated with the entity that created the secret.
- Constraints: The maximum length is
128
characters. The minimum length is4
characters.
- Constraints: The maximum length is
- crn String
- (String) A CRN that uniquely identifies an IBM Cloud resource.
- Constraints: The maximum length is
512
characters. The minimum length is9
characters. The value must match regular expression/^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/
.
- Constraints: The maximum length is
- csr String
- (String) The certificate signing request generated based on the parameters in the
managed_csr
data. The value may differ from thecsr
attribute withinmanaged_csr
if themanaged_csr
attributes have been modified. - custom
Metadata Map<String> - The secret metadata that a user can customize.
- description String
- An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.
- Constraints: The maximum length is
1024
characters. The minimum length is0
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- downloaded Boolean
- (Boolean) Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.
- endpoint
Type String - The endpoint type. If not provided the endpoint type is determined by the
visibility
argument provided in the provider configuration.- Constraints: Allowable values are:
private
,public
.
- Constraints: Allowable values are:
- expiration
Date String - The date a secret is expired. The date format follows RFC 3339.
- instance
Id String - The GUID of the Secrets Manager instance.
- intermediate String
- (Optional) The PEM-encoded intermediate certificate to associate with the root certificate.
- Constraints: The maximum length is
100000
characters. The minimum length is50
characters. The value must match regular expression/^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/
.
- Constraints: The maximum length is
- intermediate
Included Boolean - (Boolean) Indicates whether the certificate was imported with an associated intermediate certificate.
- issuer String
- (Forces new resource, String) The distinguished name that identifies the entity that signed and issued the certificate.
- Constraints: The maximum length is
128
characters. The minimum length is2
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- key
Algorithm String - (String) The identifier for the cryptographic algorithm used to generate the public key that is associated with the certificate.
- Constraints: The maximum length is
10
characters. The minimum length is2
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- labels List<String>
- Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.
- Constraints: The list items must match regular expression
/(.*?)/
. The maximum length is30
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- locks
Total Number - (Integer) The number of locks of the secret.
- Constraints: The maximum value is
1000
. The minimum value is0
.
- Constraints: The maximum value is
- managed
Csr Property Map - The data specified to create the CSR and the private key. Nested scheme for managed_csr:
- name String
- The human-readable name of your secret.
- Constraints: The maximum length is
256
characters. The minimum length is2
characters. The value must match regular expression^[A-Za-z0-9_][A-Za-z0-9_]*(?:_*-*\.*[A-Za-z0-9]*)*[A-Za-z0-9]+$
.
- Constraints: The maximum length is
- private
Key String - (Optional) The PEM-encoded private key to associate with the certificate.
- Constraints: The maximum length is
100000
characters. The minimum length is50
characters. The value must match regular expression/^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/
.
- Constraints: The maximum length is
- private
Key BooleanIncluded - (Boolean) Indicates whether the certificate was imported with an associated private key.
- region String
- The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
- secret
Group StringId - A UUID identifier, or
default
secret group.- Constraints: The maximum length is
36
characters. The minimum length is7
characters. The value must match regular expression/^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|default)$/
.
- Constraints: The maximum length is
- secret
Id String - The unique identifier of the ImportedCertificate.
- secret
Type String - (String) The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.
- Constraints: Allowable values are:
arbitrary
,imported_cert
,public_cert
,iam_credentials
,kv
,username_password
,private_cert
.
- Constraints: Allowable values are:
- serial
Number String - (String) The unique serial number that was assigned to a certificate by the issuing certificate authority.
- Constraints: The maximum length is
64
characters. The minimum length is2
characters. The value must match regular expression/[^a-fA-F0-9]/
.
- Constraints: The maximum length is
- signing
Algorithm String - (String) The identifier for the cryptographic algorithm that was used by the issuing certificate authority to sign a certificate.
- Constraints: The maximum length is
64
characters. The minimum length is4
characters.
- Constraints: The maximum length is
- sm
Imported StringCertificate Id - state Number
- (Integer) The secret state that is based on NIST SP 800-57. States are integers and correspond to the
Pre-activation = 0
,Active = 1
,Suspended = 2
,Deactivated = 3
, andDestroyed = 5
values.- Constraints: Allowable values are:
0
,1
,2
,3
,5
.
- Constraints: Allowable values are:
- state
Description String - (String) A text representation of the secret state.
- Constraints: Allowable values are:
pre_activation
,active
,suspended
,deactivated
,destroyed
.
- Constraints: Allowable values are:
- updated
At String - (String) The date when a resource was recently modified. The date format follows RFC 3339.
- validities List<Property Map>
- (List) The date and time that the certificate validity period begins and ends. Nested scheme for validity:
- version
Custom Map<String>Metadata - The secret version metadata that a user can customize.
- versions
Total Number - (Integer) The number of versions of the secret.
- Constraints: The maximum value is
50
. The minimum value is0
.
- Constraints: The maximum value is
Supporting Types
SmImportedCertificateManagedCsr, SmImportedCertificateManagedCsrArgs
- Alt
Names string - With the Subject Alternative Name field, you can specify additional hostnames to be protected by a single SSL certificate.
- Client
Flag bool - This field indicates whether certificate is flagged for client use. The default is
true
. - Code
Signing boolFlag - This field indicates whether certificate is flagged for code signing use. The default is
true
. - Common
Name string - The Common Name (CN) represents the server name protected by the SSL certificate.
- Countries List<string>
- The Country (C) values to define in the subject field of the resulting certificate.
- Csr string
- The certificate signing request generated based on the parameters in the
managed_csr
data. - Email
Protection boolFlag - This field indicates whether certificate is flagged for email protection use. The default is
false
. - Exclude
Cn boolFrom Sans - This parameter controls whether the common name is excluded from Subject Alternative Names (SANs). The default is
false
. - Ext
Key stringUsage - The allowed extended key usage constraint on certificate, in a comma-delimited list.
- Ext
Key stringUsage Oids - A comma-delimited list of extended key usage Object Identifiers (OIDs).
- Ip
Sans string - The IP Subject Alternative Names to define for the certificate, in a comma-delimited list.
- Key
Bits double - The number of bits to use to generate the private key.
- Key
Type string - The type of private key to generate. The default is
rsa
. - Key
Usage string - The allowed key usage constraint to define for certificate, in a comma-delimited list.
- Localities List<string>
- The Locality (L) values to define in the subject field of the resulting certificate.
- Organizations List<string>
- The Organization (O) values to define in the subject field of the resulting certificate.
- Other
Sans string - The custom Object Identifier (OID) or UTF8-string Subject Alternative Names to define for the certificate, in a comma-delimited list.
- Ous List<string>
- The Organizational Unit (OU) values to define in the subject field of the resulting certificate.
- Policy
Identifiers string - A comma-delimited list of policy Object Identifiers (OIDs).
- Postal
Codes List<string> - The postal code values to define in the subject field of the resulting certificate.
- Provinces List<string>
- The Province (ST) values to define in the subject field of the resulting certificate.
- Require
Cn bool - If set to false, makes the common_name field optional while generating a certificate. The default is
true
. - Rotate
Keys bool - This field indicates whether the private key will be rotated. The default is
false
. - Server
Flag bool - This field indicates whether certificate is flagged for server use. The default is
true
. - Street
Addresses List<string> - The street address values to define in the subject field of the resulting certificate.
- Uri
Sans string - The URI Subject Alternative Names to define for the certificate, in a comma-delimited list.
- User
Ids string - Specifies the list of requested User ID (OID 0.9.2342.19200300.100.1.1) Subject values to be placed on the signed certificate.
- Alt
Names string - With the Subject Alternative Name field, you can specify additional hostnames to be protected by a single SSL certificate.
- Client
Flag bool - This field indicates whether certificate is flagged for client use. The default is
true
. - Code
Signing boolFlag - This field indicates whether certificate is flagged for code signing use. The default is
true
. - Common
Name string - The Common Name (CN) represents the server name protected by the SSL certificate.
- Countries []string
- The Country (C) values to define in the subject field of the resulting certificate.
- Csr string
- The certificate signing request generated based on the parameters in the
managed_csr
data. - Email
Protection boolFlag - This field indicates whether certificate is flagged for email protection use. The default is
false
. - Exclude
Cn boolFrom Sans - This parameter controls whether the common name is excluded from Subject Alternative Names (SANs). The default is
false
. - Ext
Key stringUsage - The allowed extended key usage constraint on certificate, in a comma-delimited list.
- Ext
Key stringUsage Oids - A comma-delimited list of extended key usage Object Identifiers (OIDs).
- Ip
Sans string - The IP Subject Alternative Names to define for the certificate, in a comma-delimited list.
- Key
Bits float64 - The number of bits to use to generate the private key.
- Key
Type string - The type of private key to generate. The default is
rsa
. - Key
Usage string - The allowed key usage constraint to define for certificate, in a comma-delimited list.
- Localities []string
- The Locality (L) values to define in the subject field of the resulting certificate.
- Organizations []string
- The Organization (O) values to define in the subject field of the resulting certificate.
- Other
Sans string - The custom Object Identifier (OID) or UTF8-string Subject Alternative Names to define for the certificate, in a comma-delimited list.
- Ous []string
- The Organizational Unit (OU) values to define in the subject field of the resulting certificate.
- Policy
Identifiers string - A comma-delimited list of policy Object Identifiers (OIDs).
- Postal
Codes []string - The postal code values to define in the subject field of the resulting certificate.
- Provinces []string
- The Province (ST) values to define in the subject field of the resulting certificate.
- Require
Cn bool - If set to false, makes the common_name field optional while generating a certificate. The default is
true
. - Rotate
Keys bool - This field indicates whether the private key will be rotated. The default is
false
. - Server
Flag bool - This field indicates whether certificate is flagged for server use. The default is
true
. - Street
Addresses []string - The street address values to define in the subject field of the resulting certificate.
- Uri
Sans string - The URI Subject Alternative Names to define for the certificate, in a comma-delimited list.
- User
Ids string - Specifies the list of requested User ID (OID 0.9.2342.19200300.100.1.1) Subject values to be placed on the signed certificate.
- alt
Names String - With the Subject Alternative Name field, you can specify additional hostnames to be protected by a single SSL certificate.
- client
Flag Boolean - This field indicates whether certificate is flagged for client use. The default is
true
. - code
Signing BooleanFlag - This field indicates whether certificate is flagged for code signing use. The default is
true
. - common
Name String - The Common Name (CN) represents the server name protected by the SSL certificate.
- countries List<String>
- The Country (C) values to define in the subject field of the resulting certificate.
- csr String
- The certificate signing request generated based on the parameters in the
managed_csr
data. - email
Protection BooleanFlag - This field indicates whether certificate is flagged for email protection use. The default is
false
. - exclude
Cn BooleanFrom Sans - This parameter controls whether the common name is excluded from Subject Alternative Names (SANs). The default is
false
. - ext
Key StringUsage - The allowed extended key usage constraint on certificate, in a comma-delimited list.
- ext
Key StringUsage Oids - A comma-delimited list of extended key usage Object Identifiers (OIDs).
- ip
Sans String - The IP Subject Alternative Names to define for the certificate, in a comma-delimited list.
- key
Bits Double - The number of bits to use to generate the private key.
- key
Type String - The type of private key to generate. The default is
rsa
. - key
Usage String - The allowed key usage constraint to define for certificate, in a comma-delimited list.
- localities List<String>
- The Locality (L) values to define in the subject field of the resulting certificate.
- organizations List<String>
- The Organization (O) values to define in the subject field of the resulting certificate.
- other
Sans String - The custom Object Identifier (OID) or UTF8-string Subject Alternative Names to define for the certificate, in a comma-delimited list.
- ous List<String>
- The Organizational Unit (OU) values to define in the subject field of the resulting certificate.
- policy
Identifiers String - A comma-delimited list of policy Object Identifiers (OIDs).
- postal
Codes List<String> - The postal code values to define in the subject field of the resulting certificate.
- provinces List<String>
- The Province (ST) values to define in the subject field of the resulting certificate.
- require
Cn Boolean - If set to false, makes the common_name field optional while generating a certificate. The default is
true
. - rotate
Keys Boolean - This field indicates whether the private key will be rotated. The default is
false
. - server
Flag Boolean - This field indicates whether certificate is flagged for server use. The default is
true
. - street
Addresses List<String> - The street address values to define in the subject field of the resulting certificate.
- uri
Sans String - The URI Subject Alternative Names to define for the certificate, in a comma-delimited list.
- user
Ids String - Specifies the list of requested User ID (OID 0.9.2342.19200300.100.1.1) Subject values to be placed on the signed certificate.
- alt
Names string - With the Subject Alternative Name field, you can specify additional hostnames to be protected by a single SSL certificate.
- client
Flag boolean - This field indicates whether certificate is flagged for client use. The default is
true
. - code
Signing booleanFlag - This field indicates whether certificate is flagged for code signing use. The default is
true
. - common
Name string - The Common Name (CN) represents the server name protected by the SSL certificate.
- countries string[]
- The Country (C) values to define in the subject field of the resulting certificate.
- csr string
- The certificate signing request generated based on the parameters in the
managed_csr
data. - email
Protection booleanFlag - This field indicates whether certificate is flagged for email protection use. The default is
false
. - exclude
Cn booleanFrom Sans - This parameter controls whether the common name is excluded from Subject Alternative Names (SANs). The default is
false
. - ext
Key stringUsage - The allowed extended key usage constraint on certificate, in a comma-delimited list.
- ext
Key stringUsage Oids - A comma-delimited list of extended key usage Object Identifiers (OIDs).
- ip
Sans string - The IP Subject Alternative Names to define for the certificate, in a comma-delimited list.
- key
Bits number - The number of bits to use to generate the private key.
- key
Type string - The type of private key to generate. The default is
rsa
. - key
Usage string - The allowed key usage constraint to define for certificate, in a comma-delimited list.
- localities string[]
- The Locality (L) values to define in the subject field of the resulting certificate.
- organizations string[]
- The Organization (O) values to define in the subject field of the resulting certificate.
- other
Sans string - The custom Object Identifier (OID) or UTF8-string Subject Alternative Names to define for the certificate, in a comma-delimited list.
- ous string[]
- The Organizational Unit (OU) values to define in the subject field of the resulting certificate.
- policy
Identifiers string - A comma-delimited list of policy Object Identifiers (OIDs).
- postal
Codes string[] - The postal code values to define in the subject field of the resulting certificate.
- provinces string[]
- The Province (ST) values to define in the subject field of the resulting certificate.
- require
Cn boolean - If set to false, makes the common_name field optional while generating a certificate. The default is
true
. - rotate
Keys boolean - This field indicates whether the private key will be rotated. The default is
false
. - server
Flag boolean - This field indicates whether certificate is flagged for server use. The default is
true
. - street
Addresses string[] - The street address values to define in the subject field of the resulting certificate.
- uri
Sans string - The URI Subject Alternative Names to define for the certificate, in a comma-delimited list.
- user
Ids string - Specifies the list of requested User ID (OID 0.9.2342.19200300.100.1.1) Subject values to be placed on the signed certificate.
- alt_
names str - With the Subject Alternative Name field, you can specify additional hostnames to be protected by a single SSL certificate.
- client_
flag bool - This field indicates whether certificate is flagged for client use. The default is
true
. - code_
signing_ boolflag - This field indicates whether certificate is flagged for code signing use. The default is
true
. - common_
name str - The Common Name (CN) represents the server name protected by the SSL certificate.
- countries Sequence[str]
- The Country (C) values to define in the subject field of the resulting certificate.
- csr str
- The certificate signing request generated based on the parameters in the
managed_csr
data. - email_
protection_ boolflag - This field indicates whether certificate is flagged for email protection use. The default is
false
. - exclude_
cn_ boolfrom_ sans - This parameter controls whether the common name is excluded from Subject Alternative Names (SANs). The default is
false
. - ext_
key_ strusage - The allowed extended key usage constraint on certificate, in a comma-delimited list.
- ext_
key_ strusage_ oids - A comma-delimited list of extended key usage Object Identifiers (OIDs).
- ip_
sans str - The IP Subject Alternative Names to define for the certificate, in a comma-delimited list.
- key_
bits float - The number of bits to use to generate the private key.
- key_
type str - The type of private key to generate. The default is
rsa
. - key_
usage str - The allowed key usage constraint to define for certificate, in a comma-delimited list.
- localities Sequence[str]
- The Locality (L) values to define in the subject field of the resulting certificate.
- organizations Sequence[str]
- The Organization (O) values to define in the subject field of the resulting certificate.
- other_
sans str - The custom Object Identifier (OID) or UTF8-string Subject Alternative Names to define for the certificate, in a comma-delimited list.
- ous Sequence[str]
- The Organizational Unit (OU) values to define in the subject field of the resulting certificate.
- policy_
identifiers str - A comma-delimited list of policy Object Identifiers (OIDs).
- postal_
codes Sequence[str] - The postal code values to define in the subject field of the resulting certificate.
- provinces Sequence[str]
- The Province (ST) values to define in the subject field of the resulting certificate.
- require_
cn bool - If set to false, makes the common_name field optional while generating a certificate. The default is
true
. - rotate_
keys bool - This field indicates whether the private key will be rotated. The default is
false
. - server_
flag bool - This field indicates whether certificate is flagged for server use. The default is
true
. - street_
addresses Sequence[str] - The street address values to define in the subject field of the resulting certificate.
- uri_
sans str - The URI Subject Alternative Names to define for the certificate, in a comma-delimited list.
- user_
ids str - Specifies the list of requested User ID (OID 0.9.2342.19200300.100.1.1) Subject values to be placed on the signed certificate.
- alt
Names String - With the Subject Alternative Name field, you can specify additional hostnames to be protected by a single SSL certificate.
- client
Flag Boolean - This field indicates whether certificate is flagged for client use. The default is
true
. - code
Signing BooleanFlag - This field indicates whether certificate is flagged for code signing use. The default is
true
. - common
Name String - The Common Name (CN) represents the server name protected by the SSL certificate.
- countries List<String>
- The Country (C) values to define in the subject field of the resulting certificate.
- csr String
- The certificate signing request generated based on the parameters in the
managed_csr
data. - email
Protection BooleanFlag - This field indicates whether certificate is flagged for email protection use. The default is
false
. - exclude
Cn BooleanFrom Sans - This parameter controls whether the common name is excluded from Subject Alternative Names (SANs). The default is
false
. - ext
Key StringUsage - The allowed extended key usage constraint on certificate, in a comma-delimited list.
- ext
Key StringUsage Oids - A comma-delimited list of extended key usage Object Identifiers (OIDs).
- ip
Sans String - The IP Subject Alternative Names to define for the certificate, in a comma-delimited list.
- key
Bits Number - The number of bits to use to generate the private key.
- key
Type String - The type of private key to generate. The default is
rsa
. - key
Usage String - The allowed key usage constraint to define for certificate, in a comma-delimited list.
- localities List<String>
- The Locality (L) values to define in the subject field of the resulting certificate.
- organizations List<String>
- The Organization (O) values to define in the subject field of the resulting certificate.
- other
Sans String - The custom Object Identifier (OID) or UTF8-string Subject Alternative Names to define for the certificate, in a comma-delimited list.
- ous List<String>
- The Organizational Unit (OU) values to define in the subject field of the resulting certificate.
- policy
Identifiers String - A comma-delimited list of policy Object Identifiers (OIDs).
- postal
Codes List<String> - The postal code values to define in the subject field of the resulting certificate.
- provinces List<String>
- The Province (ST) values to define in the subject field of the resulting certificate.
- require
Cn Boolean - If set to false, makes the common_name field optional while generating a certificate. The default is
true
. - rotate
Keys Boolean - This field indicates whether the private key will be rotated. The default is
false
. - server
Flag Boolean - This field indicates whether certificate is flagged for server use. The default is
true
. - street
Addresses List<String> - The street address values to define in the subject field of the resulting certificate.
- uri
Sans String - The URI Subject Alternative Names to define for the certificate, in a comma-delimited list.
- user
Ids String - Specifies the list of requested User ID (OID 0.9.2342.19200300.100.1.1) Subject values to be placed on the signed certificate.
SmImportedCertificateValidity, SmImportedCertificateValidityArgs
- not_
after str - (String) The date-time format follows RFC 3339.
- not_
before str - (String) The date-time format follows RFC 3339.
Import
You can import the ibm_sm_imported_certificate
resource by using region
, instance_id
, and secret_id
.
For more information, see the documentation
Syntax
bash
$ pulumi import ibm:index/smImportedCertificate:SmImportedCertificate sm_imported_certificate <region>/<instance_id>/<secret_id>
Example
bash
$ pulumi import ibm:index/smImportedCertificate:SmImportedCertificate sm_imported_certificate us-east/6ebc4224-e983-496a-8a54-f40a0bfa9175/b49ad24d-81d4-5ebc-b9b9-b0937d1c84d5
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- ibm ibm-cloud/terraform-provider-ibm
- License
- Notes
- This Pulumi package is based on the
ibm
Terraform Provider.