ibm.SmPublicCertificate
Explore with Pulumi AI
Provides a resource for Secrets Manager public certificate secret. This allows a public certificate secret to be created, updated and deleted.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";
const smPublicCertificate = new ibm.SmPublicCertificate("smPublicCertificate", {
instanceId: ibm_resource_instance.sm_instance.guid,
region: "us-south",
customMetadata: {
key: "value",
},
description: "Extended description for this secret.",
labels: ["my-label"],
ca: "ca",
dns: "dns",
commonName: "example.com",
rotation: {
autoRotate: true,
rotateKeys: false,
},
secretGroupId: ibm_sm_secret_group.sm_secret_group.secret_group_id,
});
import pulumi
import pulumi_ibm as ibm
sm_public_certificate = ibm.SmPublicCertificate("smPublicCertificate",
instance_id=ibm_resource_instance["sm_instance"]["guid"],
region="us-south",
custom_metadata={
"key": "value",
},
description="Extended description for this secret.",
labels=["my-label"],
ca="ca",
dns="dns",
common_name="example.com",
rotation={
"auto_rotate": True,
"rotate_keys": False,
},
secret_group_id=ibm_sm_secret_group["sm_secret_group"]["secret_group_id"])
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := ibm.NewSmPublicCertificate(ctx, "smPublicCertificate", &ibm.SmPublicCertificateArgs{
InstanceId: pulumi.Any(ibm_resource_instance.Sm_instance.Guid),
Region: pulumi.String("us-south"),
CustomMetadata: pulumi.StringMap{
"key": pulumi.String("value"),
},
Description: pulumi.String("Extended description for this secret."),
Labels: pulumi.StringArray{
pulumi.String("my-label"),
},
Ca: pulumi.String("ca"),
Dns: pulumi.String("dns"),
CommonName: pulumi.String("example.com"),
Rotation: &ibm.SmPublicCertificateRotationArgs{
AutoRotate: pulumi.Bool(true),
RotateKeys: pulumi.Bool(false),
},
SecretGroupId: pulumi.Any(ibm_sm_secret_group.Sm_secret_group.Secret_group_id),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;
return await Deployment.RunAsync(() =>
{
var smPublicCertificate = new Ibm.SmPublicCertificate("smPublicCertificate", new()
{
InstanceId = ibm_resource_instance.Sm_instance.Guid,
Region = "us-south",
CustomMetadata =
{
{ "key", "value" },
},
Description = "Extended description for this secret.",
Labels = new[]
{
"my-label",
},
Ca = "ca",
Dns = "dns",
CommonName = "example.com",
Rotation = new Ibm.Inputs.SmPublicCertificateRotationArgs
{
AutoRotate = true,
RotateKeys = false,
},
SecretGroupId = ibm_sm_secret_group.Sm_secret_group.Secret_group_id,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.SmPublicCertificate;
import com.pulumi.ibm.SmPublicCertificateArgs;
import com.pulumi.ibm.inputs.SmPublicCertificateRotationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var smPublicCertificate = new SmPublicCertificate("smPublicCertificate", SmPublicCertificateArgs.builder()
.instanceId(ibm_resource_instance.sm_instance().guid())
.region("us-south")
.customMetadata(Map.of("key", "value"))
.description("Extended description for this secret.")
.labels("my-label")
.ca("ca")
.dns("dns")
.commonName("example.com")
.rotation(SmPublicCertificateRotationArgs.builder()
.autoRotate(true)
.rotateKeys(false)
.build())
.secretGroupId(ibm_sm_secret_group.sm_secret_group().secret_group_id())
.build());
}
}
resources:
smPublicCertificate:
type: ibm:SmPublicCertificate
properties:
instanceId: ${ibm_resource_instance.sm_instance.guid}
region: us-south
customMetadata:
key: value
description: Extended description for this secret.
labels:
- my-label
ca: ca
dns: dns
commonName: example.com
rotation:
autoRotate: true
rotateKeys: false
secretGroupId: ${ibm_sm_secret_group.sm_secret_group.secret_group_id}
Provider Configuration
The IBM Cloud provider offers a flexible means of providing credentials for authentication. The following methods are supported, in this order, and explained below:
- Static credentials
- Environment variables
To find which credentials are required for this resource, see the service table here.
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 SmPublicCertificate Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new SmPublicCertificate(name: string, args: SmPublicCertificateArgs, opts?: CustomResourceOptions);
@overload
def SmPublicCertificate(resource_name: str,
args: SmPublicCertificateArgs,
opts: Optional[ResourceOptions] = None)
@overload
def SmPublicCertificate(resource_name: str,
opts: Optional[ResourceOptions] = None,
ca: Optional[str] = None,
instance_id: Optional[str] = None,
dns: Optional[str] = None,
endpoint_type: Optional[str] = None,
key_algorithm: Optional[str] = None,
custom_metadata: Optional[Mapping[str, str]] = None,
description: Optional[str] = None,
bundle_certs: Optional[bool] = None,
akamai: Optional[SmPublicCertificateAkamaiArgs] = None,
alt_names: Optional[Sequence[str]] = None,
common_name: Optional[str] = None,
labels: Optional[Sequence[str]] = None,
name: Optional[str] = None,
region: Optional[str] = None,
rotation: Optional[SmPublicCertificateRotationArgs] = None,
secret_group_id: Optional[str] = None,
sm_public_certificate_id: Optional[str] = None,
timeouts: Optional[SmPublicCertificateTimeoutsArgs] = None,
version_custom_metadata: Optional[Mapping[str, str]] = None)
func NewSmPublicCertificate(ctx *Context, name string, args SmPublicCertificateArgs, opts ...ResourceOption) (*SmPublicCertificate, error)
public SmPublicCertificate(string name, SmPublicCertificateArgs args, CustomResourceOptions? opts = null)
public SmPublicCertificate(String name, SmPublicCertificateArgs args)
public SmPublicCertificate(String name, SmPublicCertificateArgs args, CustomResourceOptions options)
type: ibm:SmPublicCertificate
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 SmPublicCertificateArgs
- 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 SmPublicCertificateArgs
- 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 SmPublicCertificateArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args SmPublicCertificateArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args SmPublicCertificateArgs
- 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 smPublicCertificateResource = new Ibm.SmPublicCertificate("smPublicCertificateResource", new()
{
Ca = "string",
InstanceId = "string",
Dns = "string",
EndpointType = "string",
KeyAlgorithm = "string",
CustomMetadata =
{
{ "string", "string" },
},
Description = "string",
BundleCerts = false,
Akamai = new Ibm.Inputs.SmPublicCertificateAkamaiArgs
{
Config = new Ibm.Inputs.SmPublicCertificateAkamaiConfigArgs
{
AccessToken = "string",
ClientSecret = "string",
ClientToken = "string",
Host = "string",
},
Edgerc = new Ibm.Inputs.SmPublicCertificateAkamaiEdgercArgs
{
ConfigSection = "string",
PathToEdgerc = "string",
},
},
AltNames = new[]
{
"string",
},
CommonName = "string",
Labels = new[]
{
"string",
},
Name = "string",
Region = "string",
Rotation = new Ibm.Inputs.SmPublicCertificateRotationArgs
{
AutoRotate = false,
RotateKeys = false,
},
SecretGroupId = "string",
SmPublicCertificateId = "string",
Timeouts = new Ibm.Inputs.SmPublicCertificateTimeoutsArgs
{
Create = "string",
},
VersionCustomMetadata =
{
{ "string", "string" },
},
});
example, err := ibm.NewSmPublicCertificate(ctx, "smPublicCertificateResource", &ibm.SmPublicCertificateArgs{
Ca: pulumi.String("string"),
InstanceId: pulumi.String("string"),
Dns: pulumi.String("string"),
EndpointType: pulumi.String("string"),
KeyAlgorithm: pulumi.String("string"),
CustomMetadata: pulumi.StringMap{
"string": pulumi.String("string"),
},
Description: pulumi.String("string"),
BundleCerts: pulumi.Bool(false),
Akamai: &ibm.SmPublicCertificateAkamaiArgs{
Config: &ibm.SmPublicCertificateAkamaiConfigArgs{
AccessToken: pulumi.String("string"),
ClientSecret: pulumi.String("string"),
ClientToken: pulumi.String("string"),
Host: pulumi.String("string"),
},
Edgerc: &ibm.SmPublicCertificateAkamaiEdgercArgs{
ConfigSection: pulumi.String("string"),
PathToEdgerc: pulumi.String("string"),
},
},
AltNames: pulumi.StringArray{
pulumi.String("string"),
},
CommonName: pulumi.String("string"),
Labels: pulumi.StringArray{
pulumi.String("string"),
},
Name: pulumi.String("string"),
Region: pulumi.String("string"),
Rotation: &ibm.SmPublicCertificateRotationArgs{
AutoRotate: pulumi.Bool(false),
RotateKeys: pulumi.Bool(false),
},
SecretGroupId: pulumi.String("string"),
SmPublicCertificateId: pulumi.String("string"),
Timeouts: &ibm.SmPublicCertificateTimeoutsArgs{
Create: pulumi.String("string"),
},
VersionCustomMetadata: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var smPublicCertificateResource = new SmPublicCertificate("smPublicCertificateResource", SmPublicCertificateArgs.builder()
.ca("string")
.instanceId("string")
.dns("string")
.endpointType("string")
.keyAlgorithm("string")
.customMetadata(Map.of("string", "string"))
.description("string")
.bundleCerts(false)
.akamai(SmPublicCertificateAkamaiArgs.builder()
.config(SmPublicCertificateAkamaiConfigArgs.builder()
.accessToken("string")
.clientSecret("string")
.clientToken("string")
.host("string")
.build())
.edgerc(SmPublicCertificateAkamaiEdgercArgs.builder()
.configSection("string")
.pathToEdgerc("string")
.build())
.build())
.altNames("string")
.commonName("string")
.labels("string")
.name("string")
.region("string")
.rotation(SmPublicCertificateRotationArgs.builder()
.autoRotate(false)
.rotateKeys(false)
.build())
.secretGroupId("string")
.smPublicCertificateId("string")
.timeouts(SmPublicCertificateTimeoutsArgs.builder()
.create("string")
.build())
.versionCustomMetadata(Map.of("string", "string"))
.build());
sm_public_certificate_resource = ibm.SmPublicCertificate("smPublicCertificateResource",
ca="string",
instance_id="string",
dns="string",
endpoint_type="string",
key_algorithm="string",
custom_metadata={
"string": "string",
},
description="string",
bundle_certs=False,
akamai={
"config": {
"access_token": "string",
"client_secret": "string",
"client_token": "string",
"host": "string",
},
"edgerc": {
"config_section": "string",
"path_to_edgerc": "string",
},
},
alt_names=["string"],
common_name="string",
labels=["string"],
name="string",
region="string",
rotation={
"auto_rotate": False,
"rotate_keys": False,
},
secret_group_id="string",
sm_public_certificate_id="string",
timeouts={
"create": "string",
},
version_custom_metadata={
"string": "string",
})
const smPublicCertificateResource = new ibm.SmPublicCertificate("smPublicCertificateResource", {
ca: "string",
instanceId: "string",
dns: "string",
endpointType: "string",
keyAlgorithm: "string",
customMetadata: {
string: "string",
},
description: "string",
bundleCerts: false,
akamai: {
config: {
accessToken: "string",
clientSecret: "string",
clientToken: "string",
host: "string",
},
edgerc: {
configSection: "string",
pathToEdgerc: "string",
},
},
altNames: ["string"],
commonName: "string",
labels: ["string"],
name: "string",
region: "string",
rotation: {
autoRotate: false,
rotateKeys: false,
},
secretGroupId: "string",
smPublicCertificateId: "string",
timeouts: {
create: "string",
},
versionCustomMetadata: {
string: "string",
},
});
type: ibm:SmPublicCertificate
properties:
akamai:
config:
accessToken: string
clientSecret: string
clientToken: string
host: string
edgerc:
configSection: string
pathToEdgerc: string
altNames:
- string
bundleCerts: false
ca: string
commonName: string
customMetadata:
string: string
description: string
dns: string
endpointType: string
instanceId: string
keyAlgorithm: string
labels:
- string
name: string
region: string
rotation:
autoRotate: false
rotateKeys: false
secretGroupId: string
smPublicCertificateId: string
timeouts:
create: string
versionCustomMetadata:
string: string
SmPublicCertificate 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 SmPublicCertificate resource accepts the following input properties:
- Ca string
- The name of the certificate authority configuration.
- Dns string
- The name of the DNS provider configuration.
- Instance
Id string - The GUID of the Secrets Manager instance.
- Akamai
Sm
Public Certificate Akamai - The data required in order to use Akamai as the manual DNS provider. You can choose between two authentication methods: using .edgerc file or directly providing your Akamai's credentials. For more information see here Nested scheme for akamai:
- Alt
Names List<string> - With the Subject Alternative Name field, you can specify additional host names to be protected by a single SSL certificate.
- Constraints: The list items must match regular expression
/^(.*?)$/
. The maximum length is99
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- Bundle
Certs bool - Indicates whether the issued certificate is bundled with intermediate certificates.
- Common
Name 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
- 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:
- Key
Algorithm string - (Forces new resource, String) The identifier for the cryptographic algorithm to be used to generate the public key that is associated with the certificate.The algorithm that you select determines the encryption algorithm (
RSA
orECDSA
) and key size to be used to generate keys and sign certificates. For longer living certificates, it is recommended to use longer keys to provide more encryption protection. Allowed values: RSA2048, RSA4096, EC256, EC384.- Constraints: The default value is
RSA2048
. The maximum length is7
characters. The minimum length is5
characters. The value must match regular expression/^(RSA2048|RSA4096|EC256|EC384)$/
.
- Constraints: The default value 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
- 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
- Region string
- The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
- Rotation
Sm
Public Certificate Rotation - Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:
- 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
Public stringCertificate Id - Timeouts
Sm
Public Certificate Timeouts - Version
Custom Dictionary<string, string>Metadata - The secret version metadata that a user can customize.
- Ca string
- The name of the certificate authority configuration.
- Dns string
- The name of the DNS provider configuration.
- Instance
Id string - The GUID of the Secrets Manager instance.
- Akamai
Sm
Public Certificate Akamai Args - The data required in order to use Akamai as the manual DNS provider. You can choose between two authentication methods: using .edgerc file or directly providing your Akamai's credentials. For more information see here Nested scheme for akamai:
- Alt
Names []string - With the Subject Alternative Name field, you can specify additional host names to be protected by a single SSL certificate.
- Constraints: The list items must match regular expression
/^(.*?)$/
. The maximum length is99
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- Bundle
Certs bool - Indicates whether the issued certificate is bundled with intermediate certificates.
- Common
Name 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
- 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:
- Key
Algorithm string - (Forces new resource, String) The identifier for the cryptographic algorithm to be used to generate the public key that is associated with the certificate.The algorithm that you select determines the encryption algorithm (
RSA
orECDSA
) and key size to be used to generate keys and sign certificates. For longer living certificates, it is recommended to use longer keys to provide more encryption protection. Allowed values: RSA2048, RSA4096, EC256, EC384.- Constraints: The default value is
RSA2048
. The maximum length is7
characters. The minimum length is5
characters. The value must match regular expression/^(RSA2048|RSA4096|EC256|EC384)$/
.
- Constraints: The default value 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
- 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
- Region string
- The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
- Rotation
Sm
Public Certificate Rotation Args - Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:
- 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
Public stringCertificate Id - Timeouts
Sm
Public Certificate Timeouts Args - Version
Custom map[string]stringMetadata - The secret version metadata that a user can customize.
- ca String
- The name of the certificate authority configuration.
- dns String
- The name of the DNS provider configuration.
- instance
Id String - The GUID of the Secrets Manager instance.
- akamai
Sm
Public Certificate Akamai - The data required in order to use Akamai as the manual DNS provider. You can choose between two authentication methods: using .edgerc file or directly providing your Akamai's credentials. For more information see here Nested scheme for akamai:
- alt
Names List<String> - With the Subject Alternative Name field, you can specify additional host names to be protected by a single SSL certificate.
- Constraints: The list items must match regular expression
/^(.*?)$/
. The maximum length is99
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- bundle
Certs Boolean - Indicates whether the issued certificate is bundled with intermediate certificates.
- common
Name 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
- 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:
- key
Algorithm String - (Forces new resource, String) The identifier for the cryptographic algorithm to be used to generate the public key that is associated with the certificate.The algorithm that you select determines the encryption algorithm (
RSA
orECDSA
) and key size to be used to generate keys and sign certificates. For longer living certificates, it is recommended to use longer keys to provide more encryption protection. Allowed values: RSA2048, RSA4096, EC256, EC384.- Constraints: The default value is
RSA2048
. The maximum length is7
characters. The minimum length is5
characters. The value must match regular expression/^(RSA2048|RSA4096|EC256|EC384)$/
.
- Constraints: The default value 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
- 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
- region String
- The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
- rotation
Sm
Public Certificate Rotation - Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:
- 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
Public StringCertificate Id - timeouts
Sm
Public Certificate Timeouts - version
Custom Map<String,String>Metadata - The secret version metadata that a user can customize.
- ca string
- The name of the certificate authority configuration.
- dns string
- The name of the DNS provider configuration.
- instance
Id string - The GUID of the Secrets Manager instance.
- akamai
Sm
Public Certificate Akamai - The data required in order to use Akamai as the manual DNS provider. You can choose between two authentication methods: using .edgerc file or directly providing your Akamai's credentials. For more information see here Nested scheme for akamai:
- alt
Names string[] - With the Subject Alternative Name field, you can specify additional host names to be protected by a single SSL certificate.
- Constraints: The list items must match regular expression
/^(.*?)$/
. The maximum length is99
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- bundle
Certs boolean - Indicates whether the issued certificate is bundled with intermediate certificates.
- common
Name 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
- 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:
- key
Algorithm string - (Forces new resource, String) The identifier for the cryptographic algorithm to be used to generate the public key that is associated with the certificate.The algorithm that you select determines the encryption algorithm (
RSA
orECDSA
) and key size to be used to generate keys and sign certificates. For longer living certificates, it is recommended to use longer keys to provide more encryption protection. Allowed values: RSA2048, RSA4096, EC256, EC384.- Constraints: The default value is
RSA2048
. The maximum length is7
characters. The minimum length is5
characters. The value must match regular expression/^(RSA2048|RSA4096|EC256|EC384)$/
.
- Constraints: The default value 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
- 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
- region string
- The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
- rotation
Sm
Public Certificate Rotation - Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:
- 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
Public stringCertificate Id - timeouts
Sm
Public Certificate Timeouts - version
Custom {[key: string]: string}Metadata - The secret version metadata that a user can customize.
- ca str
- The name of the certificate authority configuration.
- dns str
- The name of the DNS provider configuration.
- instance_
id str - The GUID of the Secrets Manager instance.
- akamai
Sm
Public Certificate Akamai Args - The data required in order to use Akamai as the manual DNS provider. You can choose between two authentication methods: using .edgerc file or directly providing your Akamai's credentials. For more information see here Nested scheme for akamai:
- alt_
names Sequence[str] - With the Subject Alternative Name field, you can specify additional host names to be protected by a single SSL certificate.
- Constraints: The list items must match regular expression
/^(.*?)$/
. The maximum length is99
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- bundle_
certs bool - Indicates whether the issued certificate is bundled with intermediate certificates.
- common_
name str - 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
- 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:
- key_
algorithm str - (Forces new resource, String) The identifier for the cryptographic algorithm to be used to generate the public key that is associated with the certificate.The algorithm that you select determines the encryption algorithm (
RSA
orECDSA
) and key size to be used to generate keys and sign certificates. For longer living certificates, it is recommended to use longer keys to provide more encryption protection. Allowed values: RSA2048, RSA4096, EC256, EC384.- Constraints: The default value is
RSA2048
. The maximum length is7
characters. The minimum length is5
characters. The value must match regular expression/^(RSA2048|RSA4096|EC256|EC384)$/
.
- Constraints: The default value 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
- 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
- region str
- The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
- rotation
Sm
Public Certificate Rotation Args - Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:
- 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_
public_ strcertificate_ id - timeouts
Sm
Public Certificate Timeouts Args - version_
custom_ Mapping[str, str]metadata - The secret version metadata that a user can customize.
- ca String
- The name of the certificate authority configuration.
- dns String
- The name of the DNS provider configuration.
- instance
Id String - The GUID of the Secrets Manager instance.
- akamai Property Map
- The data required in order to use Akamai as the manual DNS provider. You can choose between two authentication methods: using .edgerc file or directly providing your Akamai's credentials. For more information see here Nested scheme for akamai:
- alt
Names List<String> - With the Subject Alternative Name field, you can specify additional host names to be protected by a single SSL certificate.
- Constraints: The list items must match regular expression
/^(.*?)$/
. The maximum length is99
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- bundle
Certs Boolean - Indicates whether the issued certificate is bundled with intermediate certificates.
- common
Name 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
- 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:
- key
Algorithm String - (Forces new resource, String) The identifier for the cryptographic algorithm to be used to generate the public key that is associated with the certificate.The algorithm that you select determines the encryption algorithm (
RSA
orECDSA
) and key size to be used to generate keys and sign certificates. For longer living certificates, it is recommended to use longer keys to provide more encryption protection. Allowed values: RSA2048, RSA4096, EC256, EC384.- Constraints: The default value is
RSA2048
. The maximum length is7
characters. The minimum length is5
characters. The value must match regular expression/^(RSA2048|RSA4096|EC256|EC384)$/
.
- Constraints: The default value 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
- 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
- region String
- The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
- rotation Property Map
- Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:
- 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
Public StringCertificate Id - timeouts Property Map
- 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 SmPublicCertificate resource produces the following output properties:
- Certificate string
- (Forces new resource, String) The PEM-encoded contents of your 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
- 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
- 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 string
- (Forces new resource, 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
- Issuance
Infos List<SmPublic Certificate Issuance Info> - (List) Issuance information that is associated with your certificate. Nested scheme for issuance_info:
- 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
- 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 string - (Forces new resource, 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
- Secret
Id string - The unique identifier of the PublicCertificate.
- 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
Public 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
- Certificate string
- (Forces new resource, String) The PEM-encoded contents of your 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
- 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
- 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 string
- (Forces new resource, 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
- Issuance
Infos []SmPublic Certificate Issuance Info - (List) Issuance information that is associated with your certificate. Nested scheme for issuance_info:
- 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
- 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 string - (Forces new resource, 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
- Secret
Id string - The unique identifier of the PublicCertificate.
- 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
Public 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
- certificate String
- (Forces new resource, String) The PEM-encoded contents of your 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
- 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
- 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 String
- (Forces new resource, 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
- issuance
Infos List<SmPublic Certificate Issuance Info> - (List) Issuance information that is associated with your certificate. Nested scheme for issuance_info:
- 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
- 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 String - (Forces new resource, 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
- secret
Id String - The unique identifier of the PublicCertificate.
- 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
Public 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
- certificate string
- (Forces new resource, String) The PEM-encoded contents of your 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
- 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
- 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 string
- (Forces new resource, 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
- issuance
Infos SmPublic Certificate Issuance Info[] - (List) Issuance information that is associated with your certificate. Nested scheme for issuance_info:
- 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
- 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 string - (Forces new resource, 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
- secret
Id string - The unique identifier of the PublicCertificate.
- 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
Public 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
- certificate str
- (Forces new resource, String) The PEM-encoded contents of your 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
- 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
- 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 str
- (Forces new resource, 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
- issuance_
infos Sequence[SmPublic Certificate Issuance Info] - (List) Issuance information that is associated with your certificate. Nested scheme for issuance_info:
- 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
- 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 str - (Forces new resource, 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
- secret_
id str - The unique identifier of the PublicCertificate.
- 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
Public 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
- certificate String
- (Forces new resource, String) The PEM-encoded contents of your 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
- 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
- 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 String
- (Forces new resource, 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
- issuance
Infos List<Property Map> - (List) Issuance information that is associated with your certificate. Nested scheme for issuance_info:
- 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
- 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 String - (Forces new resource, 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
- secret
Id String - The unique identifier of the PublicCertificate.
- 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 SmPublicCertificate Resource
Get an existing SmPublicCertificate 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?: SmPublicCertificateState, opts?: CustomResourceOptions): SmPublicCertificate
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
akamai: Optional[SmPublicCertificateAkamaiArgs] = None,
alt_names: Optional[Sequence[str]] = None,
bundle_certs: Optional[bool] = None,
ca: Optional[str] = None,
certificate: Optional[str] = None,
common_name: Optional[str] = None,
created_at: Optional[str] = None,
created_by: Optional[str] = None,
crn: Optional[str] = None,
custom_metadata: Optional[Mapping[str, str]] = None,
description: Optional[str] = None,
dns: 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,
issuance_infos: Optional[Sequence[SmPublicCertificateIssuanceInfoArgs]] = None,
issuer: Optional[str] = None,
key_algorithm: Optional[str] = None,
labels: Optional[Sequence[str]] = None,
locks_total: Optional[float] = None,
name: Optional[str] = None,
private_key: Optional[str] = None,
region: Optional[str] = None,
rotation: Optional[SmPublicCertificateRotationArgs] = 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_public_certificate_id: Optional[str] = None,
state: Optional[float] = None,
state_description: Optional[str] = None,
timeouts: Optional[SmPublicCertificateTimeoutsArgs] = None,
updated_at: Optional[str] = None,
validities: Optional[Sequence[SmPublicCertificateValidityArgs]] = None,
version_custom_metadata: Optional[Mapping[str, str]] = None,
versions_total: Optional[float] = None) -> SmPublicCertificate
func GetSmPublicCertificate(ctx *Context, name string, id IDInput, state *SmPublicCertificateState, opts ...ResourceOption) (*SmPublicCertificate, error)
public static SmPublicCertificate Get(string name, Input<string> id, SmPublicCertificateState? state, CustomResourceOptions? opts = null)
public static SmPublicCertificate get(String name, Output<String> id, SmPublicCertificateState state, CustomResourceOptions options)
resources: _: type: ibm:SmPublicCertificate 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.
- Akamai
Sm
Public Certificate Akamai - The data required in order to use Akamai as the manual DNS provider. You can choose between two authentication methods: using .edgerc file or directly providing your Akamai's credentials. For more information see here Nested scheme for akamai:
- Alt
Names List<string> - With the Subject Alternative Name field, you can specify additional host names to be protected by a single SSL certificate.
- Constraints: The list items must match regular expression
/^(.*?)$/
. The maximum length is99
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- Bundle
Certs bool - Indicates whether the issued certificate is bundled with intermediate certificates.
- Ca string
- The name of the certificate authority configuration.
- Certificate string
- (Forces new resource, String) The PEM-encoded contents of your 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
- Common
Name 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
- 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
- Dns string
- The name of the DNS provider configuration.
- 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
- (Forces new resource, 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
- Issuance
Infos List<SmPublic Certificate Issuance Info> - (List) Issuance information that is associated with your certificate. Nested scheme for issuance_info:
- 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 - (Forces new resource, String) The identifier for the cryptographic algorithm to be used to generate the public key that is associated with the certificate.The algorithm that you select determines the encryption algorithm (
RSA
orECDSA
) and key size to be used to generate keys and sign certificates. For longer living certificates, it is recommended to use longer keys to provide more encryption protection. Allowed values: RSA2048, RSA4096, EC256, EC384.- Constraints: The default value is
RSA2048
. The maximum length is7
characters. The minimum length is5
characters. The value must match regular expression/^(RSA2048|RSA4096|EC256|EC384)$/
.
- Constraints: The default value 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
- 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 - (Forces new resource, 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.
- Rotation
Sm
Public Certificate Rotation - Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:
- 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 PublicCertificate.
- 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
Public 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:
- Timeouts
Sm
Public Certificate Timeouts - Updated
At string - (String) The date when a resource was recently modified. The date format follows RFC 3339.
- Validities
List<Sm
Public 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
- Akamai
Sm
Public Certificate Akamai Args - The data required in order to use Akamai as the manual DNS provider. You can choose between two authentication methods: using .edgerc file or directly providing your Akamai's credentials. For more information see here Nested scheme for akamai:
- Alt
Names []string - With the Subject Alternative Name field, you can specify additional host names to be protected by a single SSL certificate.
- Constraints: The list items must match regular expression
/^(.*?)$/
. The maximum length is99
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- Bundle
Certs bool - Indicates whether the issued certificate is bundled with intermediate certificates.
- Ca string
- The name of the certificate authority configuration.
- Certificate string
- (Forces new resource, String) The PEM-encoded contents of your 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
- Common
Name 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
- 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
- Dns string
- The name of the DNS provider configuration.
- 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
- (Forces new resource, 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
- Issuance
Infos []SmPublic Certificate Issuance Info Args - (List) Issuance information that is associated with your certificate. Nested scheme for issuance_info:
- 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 - (Forces new resource, String) The identifier for the cryptographic algorithm to be used to generate the public key that is associated with the certificate.The algorithm that you select determines the encryption algorithm (
RSA
orECDSA
) and key size to be used to generate keys and sign certificates. For longer living certificates, it is recommended to use longer keys to provide more encryption protection. Allowed values: RSA2048, RSA4096, EC256, EC384.- Constraints: The default value is
RSA2048
. The maximum length is7
characters. The minimum length is5
characters. The value must match regular expression/^(RSA2048|RSA4096|EC256|EC384)$/
.
- Constraints: The default value 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
- 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 - (Forces new resource, 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.
- Rotation
Sm
Public Certificate Rotation Args - Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:
- 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 PublicCertificate.
- 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
Public 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:
- Timeouts
Sm
Public Certificate Timeouts Args - Updated
At string - (String) The date when a resource was recently modified. The date format follows RFC 3339.
- Validities
[]Sm
Public 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
- akamai
Sm
Public Certificate Akamai - The data required in order to use Akamai as the manual DNS provider. You can choose between two authentication methods: using .edgerc file or directly providing your Akamai's credentials. For more information see here Nested scheme for akamai:
- alt
Names List<String> - With the Subject Alternative Name field, you can specify additional host names to be protected by a single SSL certificate.
- Constraints: The list items must match regular expression
/^(.*?)$/
. The maximum length is99
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- bundle
Certs Boolean - Indicates whether the issued certificate is bundled with intermediate certificates.
- ca String
- The name of the certificate authority configuration.
- certificate String
- (Forces new resource, String) The PEM-encoded contents of your 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
- common
Name 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
- 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
- dns String
- The name of the DNS provider configuration.
- 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
- (Forces new resource, 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
- issuance
Infos List<SmPublic Certificate Issuance Info> - (List) Issuance information that is associated with your certificate. Nested scheme for issuance_info:
- 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 - (Forces new resource, String) The identifier for the cryptographic algorithm to be used to generate the public key that is associated with the certificate.The algorithm that you select determines the encryption algorithm (
RSA
orECDSA
) and key size to be used to generate keys and sign certificates. For longer living certificates, it is recommended to use longer keys to provide more encryption protection. Allowed values: RSA2048, RSA4096, EC256, EC384.- Constraints: The default value is
RSA2048
. The maximum length is7
characters. The minimum length is5
characters. The value must match regular expression/^(RSA2048|RSA4096|EC256|EC384)$/
.
- Constraints: The default value 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
- 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 - (Forces new resource, 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.
- rotation
Sm
Public Certificate Rotation - Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:
- 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 PublicCertificate.
- 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
Public 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:
- timeouts
Sm
Public Certificate Timeouts - updated
At String - (String) The date when a resource was recently modified. The date format follows RFC 3339.
- validities
List<Sm
Public 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
- akamai
Sm
Public Certificate Akamai - The data required in order to use Akamai as the manual DNS provider. You can choose between two authentication methods: using .edgerc file or directly providing your Akamai's credentials. For more information see here Nested scheme for akamai:
- alt
Names string[] - With the Subject Alternative Name field, you can specify additional host names to be protected by a single SSL certificate.
- Constraints: The list items must match regular expression
/^(.*?)$/
. The maximum length is99
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- bundle
Certs boolean - Indicates whether the issued certificate is bundled with intermediate certificates.
- ca string
- The name of the certificate authority configuration.
- certificate string
- (Forces new resource, String) The PEM-encoded contents of your 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
- common
Name 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
- 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
- dns string
- The name of the DNS provider configuration.
- 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
- (Forces new resource, 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
- issuance
Infos SmPublic Certificate Issuance Info[] - (List) Issuance information that is associated with your certificate. Nested scheme for issuance_info:
- 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 - (Forces new resource, String) The identifier for the cryptographic algorithm to be used to generate the public key that is associated with the certificate.The algorithm that you select determines the encryption algorithm (
RSA
orECDSA
) and key size to be used to generate keys and sign certificates. For longer living certificates, it is recommended to use longer keys to provide more encryption protection. Allowed values: RSA2048, RSA4096, EC256, EC384.- Constraints: The default value is
RSA2048
. The maximum length is7
characters. The minimum length is5
characters. The value must match regular expression/^(RSA2048|RSA4096|EC256|EC384)$/
.
- Constraints: The default value 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
- 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 - (Forces new resource, 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.
- rotation
Sm
Public Certificate Rotation - Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:
- 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 PublicCertificate.
- 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
Public 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:
- timeouts
Sm
Public Certificate Timeouts - updated
At string - (String) The date when a resource was recently modified. The date format follows RFC 3339.
- validities
Sm
Public 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
- akamai
Sm
Public Certificate Akamai Args - The data required in order to use Akamai as the manual DNS provider. You can choose between two authentication methods: using .edgerc file or directly providing your Akamai's credentials. For more information see here Nested scheme for akamai:
- alt_
names Sequence[str] - With the Subject Alternative Name field, you can specify additional host names to be protected by a single SSL certificate.
- Constraints: The list items must match regular expression
/^(.*?)$/
. The maximum length is99
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- bundle_
certs bool - Indicates whether the issued certificate is bundled with intermediate certificates.
- ca str
- The name of the certificate authority configuration.
- certificate str
- (Forces new resource, String) The PEM-encoded contents of your 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
- common_
name str - 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
- 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
- dns str
- The name of the DNS provider configuration.
- 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
- (Forces new resource, 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
- issuance_
infos Sequence[SmPublic Certificate Issuance Info Args] - (List) Issuance information that is associated with your certificate. Nested scheme for issuance_info:
- 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 - (Forces new resource, String) The identifier for the cryptographic algorithm to be used to generate the public key that is associated with the certificate.The algorithm that you select determines the encryption algorithm (
RSA
orECDSA
) and key size to be used to generate keys and sign certificates. For longer living certificates, it is recommended to use longer keys to provide more encryption protection. Allowed values: RSA2048, RSA4096, EC256, EC384.- Constraints: The default value is
RSA2048
. The maximum length is7
characters. The minimum length is5
characters. The value must match regular expression/^(RSA2048|RSA4096|EC256|EC384)$/
.
- Constraints: The default value 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
- 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 - (Forces new resource, 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 str
- The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
- rotation
Sm
Public Certificate Rotation Args - Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:
- 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 PublicCertificate.
- 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_
public_ 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:
- timeouts
Sm
Public Certificate Timeouts Args - updated_
at str - (String) The date when a resource was recently modified. The date format follows RFC 3339.
- validities
Sequence[Sm
Public 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
- akamai Property Map
- The data required in order to use Akamai as the manual DNS provider. You can choose between two authentication methods: using .edgerc file or directly providing your Akamai's credentials. For more information see here Nested scheme for akamai:
- alt
Names List<String> - With the Subject Alternative Name field, you can specify additional host names to be protected by a single SSL certificate.
- Constraints: The list items must match regular expression
/^(.*?)$/
. The maximum length is99
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- bundle
Certs Boolean - Indicates whether the issued certificate is bundled with intermediate certificates.
- ca String
- The name of the certificate authority configuration.
- certificate String
- (Forces new resource, String) The PEM-encoded contents of your 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
- common
Name 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
- 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
- dns String
- The name of the DNS provider configuration.
- 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
- (Forces new resource, 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
- issuance
Infos List<Property Map> - (List) Issuance information that is associated with your certificate. Nested scheme for issuance_info:
- 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 - (Forces new resource, String) The identifier for the cryptographic algorithm to be used to generate the public key that is associated with the certificate.The algorithm that you select determines the encryption algorithm (
RSA
orECDSA
) and key size to be used to generate keys and sign certificates. For longer living certificates, it is recommended to use longer keys to provide more encryption protection. Allowed values: RSA2048, RSA4096, EC256, EC384.- Constraints: The default value is
RSA2048
. The maximum length is7
characters. The minimum length is5
characters. The value must match regular expression/^(RSA2048|RSA4096|EC256|EC384)$/
.
- Constraints: The default value 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
- 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 - (Forces new resource, 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.
- rotation Property Map
- Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:
- 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 PublicCertificate.
- 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
Public 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:
- timeouts Property Map
- 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
SmPublicCertificateAkamai, SmPublicCertificateAkamaiArgs
- Config
Sm
Public Certificate Akamai Config - Directly using your Akamai's authentication credentials. Nested scheme for config:
- Edgerc
Sm
Public Certificate Akamai Edgerc - Using .edgerc file as the authentication method. Nested scheme for edgerc:
- Config
Sm
Public Certificate Akamai Config - Directly using your Akamai's authentication credentials. Nested scheme for config:
- Edgerc
Sm
Public Certificate Akamai Edgerc - Using .edgerc file as the authentication method. Nested scheme for edgerc:
- config
Sm
Public Certificate Akamai Config - Directly using your Akamai's authentication credentials. Nested scheme for config:
- edgerc
Sm
Public Certificate Akamai Edgerc - Using .edgerc file as the authentication method. Nested scheme for edgerc:
- config
Sm
Public Certificate Akamai Config - Directly using your Akamai's authentication credentials. Nested scheme for config:
- edgerc
Sm
Public Certificate Akamai Edgerc - Using .edgerc file as the authentication method. Nested scheme for edgerc:
- config
Sm
Public Certificate Akamai Config - Directly using your Akamai's authentication credentials. Nested scheme for config:
- edgerc
Sm
Public Certificate Akamai Edgerc - Using .edgerc file as the authentication method. Nested scheme for edgerc:
- config Property Map
- Directly using your Akamai's authentication credentials. Nested scheme for config:
- edgerc Property Map
- Using .edgerc file as the authentication method. Nested scheme for edgerc:
SmPublicCertificateAkamaiConfig, SmPublicCertificateAkamaiConfigArgs
- Access
Token string - Akamai's authentication credentials.
- Client
Secret string - Akamai's authentication credentials.
- Client
Token string - Akamai's authentication credentials.
- Host string
- Akamai's authentication credentials.
- Access
Token string - Akamai's authentication credentials.
- Client
Secret string - Akamai's authentication credentials.
- Client
Token string - Akamai's authentication credentials.
- Host string
- Akamai's authentication credentials.
- access
Token String - Akamai's authentication credentials.
- client
Secret String - Akamai's authentication credentials.
- client
Token String - Akamai's authentication credentials.
- host String
- Akamai's authentication credentials.
- access
Token string - Akamai's authentication credentials.
- client
Secret string - Akamai's authentication credentials.
- client
Token string - Akamai's authentication credentials.
- host string
- Akamai's authentication credentials.
- access_
token str - Akamai's authentication credentials.
- client_
secret str - Akamai's authentication credentials.
- client_
token str - Akamai's authentication credentials.
- host str
- Akamai's authentication credentials.
- access
Token String - Akamai's authentication credentials.
- client
Secret String - Akamai's authentication credentials.
- client
Token String - Akamai's authentication credentials.
- host String
- Akamai's authentication credentials.
SmPublicCertificateAkamaiEdgerc, SmPublicCertificateAkamaiEdgercArgs
- Config
Section string - The section of the edgerc file to use. Default is
default
. - Path
To stringEdgerc - Path to Akamai's configuration file.
- Config
Section string - The section of the edgerc file to use. Default is
default
. - Path
To stringEdgerc - Path to Akamai's configuration file.
- config
Section String - The section of the edgerc file to use. Default is
default
. - path
To StringEdgerc - Path to Akamai's configuration file.
- config
Section string - The section of the edgerc file to use. Default is
default
. - path
To stringEdgerc - Path to Akamai's configuration file.
- config_
section str - The section of the edgerc file to use. Default is
default
. - path_
to_ stredgerc - Path to Akamai's configuration file.
- config
Section String - The section of the edgerc file to use. Default is
default
. - path
To StringEdgerc - Path to Akamai's configuration file.
SmPublicCertificateIssuanceInfo, SmPublicCertificateIssuanceInfoArgs
- Auto
Rotated bool - (Boolean) Indicates whether the issued certificate is configured with an automatic rotation policy.
- Challenges
List<Sm
Public Certificate Issuance Info Challenge> - (List) The set of challenges. It is returned only when ordering public certificates by using manual DNS configuration.
- Constraints: The maximum length is
100
items. The minimum length is1
item. Nested scheme for challenges:
- Constraints: The maximum length is
- Dns
Challenge stringValidation Time - (String) The date that a user requests to validate DNS challenges for certificates that are ordered with a manual DNS provider. The date format follows RFC 3339.
- Error
Code string - (String) A code that identifies an issuance error.This field, along with
error_message
, is returned when Secrets Manager successfully processes your request, but the certificate authority is unable to issue a certificate. - Error
Message string - (String) A human-readable message that provides details about the issuance error.
- Ordered
On string - (String) The date when the certificate is ordered. The date format follows RFC 3339.
- 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:
- Auto
Rotated bool - (Boolean) Indicates whether the issued certificate is configured with an automatic rotation policy.
- Challenges
[]Sm
Public Certificate Issuance Info Challenge - (List) The set of challenges. It is returned only when ordering public certificates by using manual DNS configuration.
- Constraints: The maximum length is
100
items. The minimum length is1
item. Nested scheme for challenges:
- Constraints: The maximum length is
- Dns
Challenge stringValidation Time - (String) The date that a user requests to validate DNS challenges for certificates that are ordered with a manual DNS provider. The date format follows RFC 3339.
- Error
Code string - (String) A code that identifies an issuance error.This field, along with
error_message
, is returned when Secrets Manager successfully processes your request, but the certificate authority is unable to issue a certificate. - Error
Message string - (String) A human-readable message that provides details about the issuance error.
- Ordered
On string - (String) The date when the certificate is ordered. The date format follows RFC 3339.
- 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:
- auto
Rotated Boolean - (Boolean) Indicates whether the issued certificate is configured with an automatic rotation policy.
- challenges
List<Sm
Public Certificate Issuance Info Challenge> - (List) The set of challenges. It is returned only when ordering public certificates by using manual DNS configuration.
- Constraints: The maximum length is
100
items. The minimum length is1
item. Nested scheme for challenges:
- Constraints: The maximum length is
- dns
Challenge StringValidation Time - (String) The date that a user requests to validate DNS challenges for certificates that are ordered with a manual DNS provider. The date format follows RFC 3339.
- error
Code String - (String) A code that identifies an issuance error.This field, along with
error_message
, is returned when Secrets Manager successfully processes your request, but the certificate authority is unable to issue a certificate. - error
Message String - (String) A human-readable message that provides details about the issuance error.
- ordered
On String - (String) The date when the certificate is ordered. The date format follows RFC 3339.
- 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:
- auto
Rotated boolean - (Boolean) Indicates whether the issued certificate is configured with an automatic rotation policy.
- challenges
Sm
Public Certificate Issuance Info Challenge[] - (List) The set of challenges. It is returned only when ordering public certificates by using manual DNS configuration.
- Constraints: The maximum length is
100
items. The minimum length is1
item. Nested scheme for challenges:
- Constraints: The maximum length is
- dns
Challenge stringValidation Time - (String) The date that a user requests to validate DNS challenges for certificates that are ordered with a manual DNS provider. The date format follows RFC 3339.
- error
Code string - (String) A code that identifies an issuance error.This field, along with
error_message
, is returned when Secrets Manager successfully processes your request, but the certificate authority is unable to issue a certificate. - error
Message string - (String) A human-readable message that provides details about the issuance error.
- ordered
On string - (String) The date when the certificate is ordered. The date format follows RFC 3339.
- 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:
- auto_
rotated bool - (Boolean) Indicates whether the issued certificate is configured with an automatic rotation policy.
- challenges
Sequence[Sm
Public Certificate Issuance Info Challenge] - (List) The set of challenges. It is returned only when ordering public certificates by using manual DNS configuration.
- Constraints: The maximum length is
100
items. The minimum length is1
item. Nested scheme for challenges:
- Constraints: The maximum length is
- dns_
challenge_ strvalidation_ time - (String) The date that a user requests to validate DNS challenges for certificates that are ordered with a manual DNS provider. The date format follows RFC 3339.
- error_
code str - (String) A code that identifies an issuance error.This field, along with
error_message
, is returned when Secrets Manager successfully processes your request, but the certificate authority is unable to issue a certificate. - error_
message str - (String) A human-readable message that provides details about the issuance error.
- ordered_
on str - (String) The date when the certificate is ordered. The date format follows RFC 3339.
- 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:
- auto
Rotated Boolean - (Boolean) Indicates whether the issued certificate is configured with an automatic rotation policy.
- challenges List<Property Map>
- (List) The set of challenges. It is returned only when ordering public certificates by using manual DNS configuration.
- Constraints: The maximum length is
100
items. The minimum length is1
item. Nested scheme for challenges:
- Constraints: The maximum length is
- dns
Challenge StringValidation Time - (String) The date that a user requests to validate DNS challenges for certificates that are ordered with a manual DNS provider. The date format follows RFC 3339.
- error
Code String - (String) A code that identifies an issuance error.This field, along with
error_message
, is returned when Secrets Manager successfully processes your request, but the certificate authority is unable to issue a certificate. - error
Message String - (String) A human-readable message that provides details about the issuance error.
- ordered
On String - (String) The date when the certificate is ordered. The date format follows RFC 3339.
- 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:
SmPublicCertificateIssuanceInfoChallenge, SmPublicCertificateIssuanceInfoChallengeArgs
- Domain string
- (String) The challenge domain.
- Expiration string
- (String) The challenge expiration date. The date format follows RFC 3339.
- Status string
- (String) The challenge status.
- Txt
Record stringName - (String) The TXT record name.
- Txt
Record stringValue - (String) The TXT record value.
- Domain string
- (String) The challenge domain.
- Expiration string
- (String) The challenge expiration date. The date format follows RFC 3339.
- Status string
- (String) The challenge status.
- Txt
Record stringName - (String) The TXT record name.
- Txt
Record stringValue - (String) The TXT record value.
- domain String
- (String) The challenge domain.
- expiration String
- (String) The challenge expiration date. The date format follows RFC 3339.
- status String
- (String) The challenge status.
- txt
Record StringName - (String) The TXT record name.
- txt
Record StringValue - (String) The TXT record value.
- domain string
- (String) The challenge domain.
- expiration string
- (String) The challenge expiration date. The date format follows RFC 3339.
- status string
- (String) The challenge status.
- txt
Record stringName - (String) The TXT record name.
- txt
Record stringValue - (String) The TXT record value.
- domain str
- (String) The challenge domain.
- expiration str
- (String) The challenge expiration date. The date format follows RFC 3339.
- status str
- (String) The challenge status.
- txt_
record_ strname - (String) The TXT record name.
- txt_
record_ strvalue - (String) The TXT record value.
- domain String
- (String) The challenge domain.
- expiration String
- (String) The challenge expiration date. The date format follows RFC 3339.
- status String
- (String) The challenge status.
- txt
Record StringName - (String) The TXT record name.
- txt
Record StringValue - (String) The TXT record value.
SmPublicCertificateRotation, SmPublicCertificateRotationArgs
- Auto
Rotate bool - Determines whether Secrets Manager rotates your secret automatically.Default is
false
. - Rotate
Keys bool - Determines whether Secrets Manager rotates the private key for your public certificate automatically.Default is
false
. If it is set totrue
, the service generates and stores a new private key for your rotated certificate.
- Auto
Rotate bool - Determines whether Secrets Manager rotates your secret automatically.Default is
false
. - Rotate
Keys bool - Determines whether Secrets Manager rotates the private key for your public certificate automatically.Default is
false
. If it is set totrue
, the service generates and stores a new private key for your rotated certificate.
- auto
Rotate Boolean - Determines whether Secrets Manager rotates your secret automatically.Default is
false
. - rotate
Keys Boolean - Determines whether Secrets Manager rotates the private key for your public certificate automatically.Default is
false
. If it is set totrue
, the service generates and stores a new private key for your rotated certificate.
- auto
Rotate boolean - Determines whether Secrets Manager rotates your secret automatically.Default is
false
. - rotate
Keys boolean - Determines whether Secrets Manager rotates the private key for your public certificate automatically.Default is
false
. If it is set totrue
, the service generates and stores a new private key for your rotated certificate.
- auto_
rotate bool - Determines whether Secrets Manager rotates your secret automatically.Default is
false
. - rotate_
keys bool - Determines whether Secrets Manager rotates the private key for your public certificate automatically.Default is
false
. If it is set totrue
, the service generates and stores a new private key for your rotated certificate.
- auto
Rotate Boolean - Determines whether Secrets Manager rotates your secret automatically.Default is
false
. - rotate
Keys Boolean - Determines whether Secrets Manager rotates the private key for your public certificate automatically.Default is
false
. If it is set totrue
, the service generates and stores a new private key for your rotated certificate.
SmPublicCertificateTimeouts, SmPublicCertificateTimeoutsArgs
- Create string
- Create string
- create String
- create string
- create str
- create String
SmPublicCertificateValidity, SmPublicCertificateValidityArgs
- 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_public_certificate
resource by using region
, instance_id
, and secret_id
.
For more information, see the documentation
Syntax
bash
$ pulumi import ibm:index/smPublicCertificate:SmPublicCertificate sm_public_certificate <region>/<instance_id>/<secret_id>
Example
bash
$ pulumi import ibm:index/smPublicCertificate:SmPublicCertificate sm_public_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.