ibm.getSmPublicCertificate
Explore with Pulumi AI
Provides a read-only data source for a public certificate. You can then reference the fields of the data source in other resources within the same configuration using interpolation syntax. The data source can be defined by providing the secret ID or the secret and secret group names.
Example Usage
By secret id
import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";
const publicCertificate = ibm.getSmPublicCertificate({
instanceId: ibm_resource_instance.sm_instance.guid,
region: "us-south",
secretId: "0b5571f7-21e6-42b7-91c5-3f5ac9793a46",
});
import pulumi
import pulumi_ibm as ibm
public_certificate = ibm.get_sm_public_certificate(instance_id=ibm_resource_instance["sm_instance"]["guid"],
region="us-south",
secret_id="0b5571f7-21e6-42b7-91c5-3f5ac9793a46")
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.LookupSmPublicCertificate(ctx, &ibm.LookupSmPublicCertificateArgs{
InstanceId: ibm_resource_instance.Sm_instance.Guid,
Region: pulumi.StringRef("us-south"),
SecretId: pulumi.StringRef("0b5571f7-21e6-42b7-91c5-3f5ac9793a46"),
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;
return await Deployment.RunAsync(() =>
{
var publicCertificate = Ibm.GetSmPublicCertificate.Invoke(new()
{
InstanceId = ibm_resource_instance.Sm_instance.Guid,
Region = "us-south",
SecretId = "0b5571f7-21e6-42b7-91c5-3f5ac9793a46",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IbmFunctions;
import com.pulumi.ibm.inputs.GetSmPublicCertificateArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var publicCertificate = IbmFunctions.getSmPublicCertificate(GetSmPublicCertificateArgs.builder()
.instanceId(ibm_resource_instance.sm_instance().guid())
.region("us-south")
.secretId("0b5571f7-21e6-42b7-91c5-3f5ac9793a46")
.build());
}
}
variables:
publicCertificate:
fn::invoke:
function: ibm:getSmPublicCertificate
arguments:
instanceId: ${ibm_resource_instance.sm_instance.guid}
region: us-south
secretId: 0b5571f7-21e6-42b7-91c5-3f5ac9793a46
By secret name and group name
import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";
const publicCertificate = ibm.getSmPublicCertificate({
instanceId: ibm_resource_instance.sm_instance.guid,
region: "us-south",
name: "secret-name",
secretGroupName: "group-name",
});
import pulumi
import pulumi_ibm as ibm
public_certificate = ibm.get_sm_public_certificate(instance_id=ibm_resource_instance["sm_instance"]["guid"],
region="us-south",
name="secret-name",
secret_group_name="group-name")
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.LookupSmPublicCertificate(ctx, &ibm.LookupSmPublicCertificateArgs{
InstanceId: ibm_resource_instance.Sm_instance.Guid,
Region: pulumi.StringRef("us-south"),
Name: pulumi.StringRef("secret-name"),
SecretGroupName: pulumi.StringRef("group-name"),
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;
return await Deployment.RunAsync(() =>
{
var publicCertificate = Ibm.GetSmPublicCertificate.Invoke(new()
{
InstanceId = ibm_resource_instance.Sm_instance.Guid,
Region = "us-south",
Name = "secret-name",
SecretGroupName = "group-name",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IbmFunctions;
import com.pulumi.ibm.inputs.GetSmPublicCertificateArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var publicCertificate = IbmFunctions.getSmPublicCertificate(GetSmPublicCertificateArgs.builder()
.instanceId(ibm_resource_instance.sm_instance().guid())
.region("us-south")
.name("secret-name")
.secretGroupName("group-name")
.build());
}
}
variables:
publicCertificate:
fn::invoke:
function: ibm:getSmPublicCertificate
arguments:
instanceId: ${ibm_resource_instance.sm_instance.guid}
region: us-south
name: secret-name
secretGroupName: group-name
Using getSmPublicCertificate
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getSmPublicCertificate(args: GetSmPublicCertificateArgs, opts?: InvokeOptions): Promise<GetSmPublicCertificateResult>
function getSmPublicCertificateOutput(args: GetSmPublicCertificateOutputArgs, opts?: InvokeOptions): Output<GetSmPublicCertificateResult>
def get_sm_public_certificate(endpoint_type: Optional[str] = None,
id: Optional[str] = None,
instance_id: Optional[str] = None,
name: Optional[str] = None,
region: Optional[str] = None,
secret_group_name: Optional[str] = None,
secret_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetSmPublicCertificateResult
def get_sm_public_certificate_output(endpoint_type: Optional[pulumi.Input[str]] = None,
id: Optional[pulumi.Input[str]] = None,
instance_id: Optional[pulumi.Input[str]] = None,
name: Optional[pulumi.Input[str]] = None,
region: Optional[pulumi.Input[str]] = None,
secret_group_name: Optional[pulumi.Input[str]] = None,
secret_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetSmPublicCertificateResult]
func LookupSmPublicCertificate(ctx *Context, args *LookupSmPublicCertificateArgs, opts ...InvokeOption) (*LookupSmPublicCertificateResult, error)
func LookupSmPublicCertificateOutput(ctx *Context, args *LookupSmPublicCertificateOutputArgs, opts ...InvokeOption) LookupSmPublicCertificateResultOutput
> Note: This function is named LookupSmPublicCertificate
in the Go SDK.
public static class GetSmPublicCertificate
{
public static Task<GetSmPublicCertificateResult> InvokeAsync(GetSmPublicCertificateArgs args, InvokeOptions? opts = null)
public static Output<GetSmPublicCertificateResult> Invoke(GetSmPublicCertificateInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetSmPublicCertificateResult> getSmPublicCertificate(GetSmPublicCertificateArgs args, InvokeOptions options)
public static Output<GetSmPublicCertificateResult> getSmPublicCertificate(GetSmPublicCertificateArgs args, InvokeOptions options)
fn::invoke:
function: ibm:index/getSmPublicCertificate:getSmPublicCertificate
arguments:
# arguments dictionary
The following arguments are supported:
- Instance
Id string - The GUID of the Secrets Manager instance.
- 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:
- Id string
- The unique identifier of the data source.
- Name string
- The human-readable name of your secret. To be used in combination with
secret_group_name
.- 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]+)*$
.
- Constraints: The maximum length is
- Region string
- The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
- Secret
Group stringName - The name of your existing secret group. To be used in combination with
name
.- Constraints: The maximum length is
64
characters. The minimum length is2
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- Secret
Id string - The ID of the secret.
- Constraints: The maximum length is
36
characters. The minimum length is36
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}/
.
- Constraints: The maximum length is
- Instance
Id string - The GUID of the Secrets Manager instance.
- 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:
- Id string
- The unique identifier of the data source.
- Name string
- The human-readable name of your secret. To be used in combination with
secret_group_name
.- 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]+)*$
.
- Constraints: The maximum length is
- Region string
- The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
- Secret
Group stringName - The name of your existing secret group. To be used in combination with
name
.- Constraints: The maximum length is
64
characters. The minimum length is2
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- Secret
Id string - The ID of the secret.
- Constraints: The maximum length is
36
characters. The minimum length is36
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}/
.
- Constraints: The maximum length is
- instance
Id String - The GUID of the Secrets Manager instance.
- 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:
- id String
- The unique identifier of the data source.
- name String
- The human-readable name of your secret. To be used in combination with
secret_group_name
.- 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]+)*$
.
- Constraints: The maximum length is
- region String
- The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
- secret
Group StringName - The name of your existing secret group. To be used in combination with
name
.- Constraints: The maximum length is
64
characters. The minimum length is2
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- secret
Id String - The ID of the secret.
- Constraints: The maximum length is
36
characters. The minimum length is36
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}/
.
- Constraints: The maximum length is
- instance
Id string - The GUID of the Secrets Manager instance.
- 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:
- id string
- The unique identifier of the data source.
- name string
- The human-readable name of your secret. To be used in combination with
secret_group_name
.- 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]+)*$
.
- Constraints: The maximum length is
- region string
- The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
- secret
Group stringName - The name of your existing secret group. To be used in combination with
name
.- Constraints: The maximum length is
64
characters. The minimum length is2
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- secret
Id string - The ID of the secret.
- Constraints: The maximum length is
36
characters. The minimum length is36
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}/
.
- Constraints: The maximum length is
- instance_
id str - The GUID of the Secrets Manager instance.
- 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:
- id str
- The unique identifier of the data source.
- name str
- The human-readable name of your secret. To be used in combination with
secret_group_name
.- 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]+)*$
.
- Constraints: The maximum length is
- region str
- The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
- secret_
group_ strname - The name of your existing secret group. To be used in combination with
name
.- Constraints: The maximum length is
64
characters. The minimum length is2
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- secret_
id str - The ID of the secret.
- Constraints: The maximum length is
36
characters. The minimum length is36
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}/
.
- Constraints: The maximum length is
- instance
Id String - The GUID of the Secrets Manager instance.
- 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:
- id String
- The unique identifier of the data source.
- name String
- The human-readable name of your secret. To be used in combination with
secret_group_name
.- 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]+)*$
.
- Constraints: The maximum length is
- region String
- The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
- secret
Group StringName - The name of your existing secret group. To be used in combination with
name
.- Constraints: The maximum length is
64
characters. The minimum length is2
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- secret
Id String - The ID of the secret.
- Constraints: The maximum length is
36
characters. The minimum length is36
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}/
.
- Constraints: The maximum length is
getSmPublicCertificate Result
The following output properties are available:
- Alt
Names List<string> - (List) 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 - (Boolean) Indicates whether the issued certificate is bundled with intermediate certificates.
- Ca string
- (String) The name of the certificate authority configuration..
- Certificate string
- (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 - (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> - (Map) The secret metadata that a user can customize.
- Description string
- (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
- (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.
- Expiration
Date string - (String) The date a secret is expired. The date format follows RFC 3339.
- Id string
- The unique identifier of the data source.
- Instance
Id string - Intermediate string
- (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<GetSm Public Certificate Issuance Info> - (List) Issuance information that is associated with your certificate. Nested scheme for issuance_info:
- Issuer string
- (String) The distinguished name that identifies the entity that signed and issued the certificate.
- Constraints: The maximum length is
128
characters. The minimum length is2
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- Key
Algorithm string - (String) The identifier for the cryptographic algorithm 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>
- (List) 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
- (String) The human-readable name of your secret.
- Constraints: The maximum length is
256
characters. The minimum length is2
characters.
- Constraints: The maximum length is
- Private
Key string - (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
- Rotations
List<Get
Sm Public Certificate Rotation> - (List) Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:
- Secret
Group stringId - (String) 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 - 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<Get
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
- Endpoint
Type string - Secret
Group stringName
- Alt
Names []string - (List) 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 - (Boolean) Indicates whether the issued certificate is bundled with intermediate certificates.
- Ca string
- (String) The name of the certificate authority configuration..
- Certificate string
- (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 - (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 - (Map) The secret metadata that a user can customize.
- Description string
- (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
- (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.
- Expiration
Date string - (String) The date a secret is expired. The date format follows RFC 3339.
- Id string
- The unique identifier of the data source.
- Instance
Id string - Intermediate string
- (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 []GetSm Public Certificate Issuance Info - (List) Issuance information that is associated with your certificate. Nested scheme for issuance_info:
- Issuer string
- (String) The distinguished name that identifies the entity that signed and issued the certificate.
- Constraints: The maximum length is
128
characters. The minimum length is2
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- Key
Algorithm string - (String) The identifier for the cryptographic algorithm 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
- (List) 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
- (String) The human-readable name of your secret.
- Constraints: The maximum length is
256
characters. The minimum length is2
characters.
- Constraints: The maximum length is
- Private
Key string - (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
- Rotations
[]Get
Sm Public Certificate Rotation - (List) Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:
- Secret
Group stringId - (String) 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 - 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
[]Get
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
- Endpoint
Type string - Secret
Group stringName
- alt
Names List<String> - (List) 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 - (Boolean) Indicates whether the issued certificate is bundled with intermediate certificates.
- ca String
- (String) The name of the certificate authority configuration..
- certificate String
- (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 - (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> - (Map) The secret metadata that a user can customize.
- description String
- (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
- (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.
- expiration
Date String - (String) The date a secret is expired. The date format follows RFC 3339.
- id String
- The unique identifier of the data source.
- instance
Id String - intermediate String
- (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<GetSm Public Certificate Issuance Info> - (List) Issuance information that is associated with your certificate. Nested scheme for issuance_info:
- issuer String
- (String) The distinguished name that identifies the entity that signed and issued the certificate.
- Constraints: The maximum length is
128
characters. The minimum length is2
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- key
Algorithm String - (String) The identifier for the cryptographic algorithm 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>
- (List) 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
- (String) The human-readable name of your secret.
- Constraints: The maximum length is
256
characters. The minimum length is2
characters.
- Constraints: The maximum length is
- private
Key String - (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
- rotations
List<Get
Sm Public Certificate Rotation> - (List) Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:
- secret
Group StringId - (String) 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 - 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<Get
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
- endpoint
Type String - secret
Group StringName
- alt
Names string[] - (List) 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 - (Boolean) Indicates whether the issued certificate is bundled with intermediate certificates.
- ca string
- (String) The name of the certificate authority configuration..
- certificate string
- (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 - (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} - (Map) The secret metadata that a user can customize.
- description string
- (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
- (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.
- expiration
Date string - (String) The date a secret is expired. The date format follows RFC 3339.
- id string
- The unique identifier of the data source.
- instance
Id string - intermediate string
- (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 GetSm Public Certificate Issuance Info[] - (List) Issuance information that is associated with your certificate. Nested scheme for issuance_info:
- issuer string
- (String) The distinguished name that identifies the entity that signed and issued the certificate.
- Constraints: The maximum length is
128
characters. The minimum length is2
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- key
Algorithm string - (String) The identifier for the cryptographic algorithm 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[]
- (List) 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
- (String) The human-readable name of your secret.
- Constraints: The maximum length is
256
characters. The minimum length is2
characters.
- Constraints: The maximum length is
- private
Key string - (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
- rotations
Get
Sm Public Certificate Rotation[] - (List) Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:
- secret
Group stringId - (String) 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 - 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
Get
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
- endpoint
Type string - secret
Group stringName
- alt_
names Sequence[str] - (List) 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 - (Boolean) Indicates whether the issued certificate is bundled with intermediate certificates.
- ca str
- (String) The name of the certificate authority configuration..
- certificate str
- (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 - (String) The Common Name (AKA CN) represents the server name protected by the SSL certificate.
- Constraints: The maximum length is
64
characters. The minimum length is4
characters. The value must match regular expression/^(\\*\\.)?(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])\\.?$/
.
- Constraints: The maximum length is
- created_
at str - (String) The date when a resource was created. The date format follows RFC 3339.
- created_
by str - (String) The unique identifier that is associated with the entity that created the secret.
- Constraints: The maximum length is
128
characters. The minimum length is4
characters.
- Constraints: The maximum length is
- crn str
- (String) A CRN that uniquely identifies an IBM Cloud resource.
- Constraints: The maximum length is
512
characters. The minimum length is9
characters. The value must match regular expression/^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/
.
- Constraints: The maximum length is
- custom_
metadata Mapping[str, str] - (Map) The secret metadata that a user can customize.
- description str
- (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 str
- (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.
- expiration_
date str - (String) The date a secret is expired. The date format follows RFC 3339.
- id str
- The unique identifier of the data source.
- instance_
id str - intermediate str
- (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[GetSm Public Certificate Issuance Info] - (List) Issuance information that is associated with your certificate. Nested scheme for issuance_info:
- issuer str
- (String) The distinguished name that identifies the entity that signed and issued the certificate.
- Constraints: The maximum length is
128
characters. The minimum length is2
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- key_
algorithm str - (String) The identifier for the cryptographic algorithm 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]
- (List) 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
- (String) The human-readable name of your secret.
- Constraints: The maximum length is
256
characters. The minimum length is2
characters.
- Constraints: The maximum length is
- private_
key str - (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
- rotations
Sequence[Get
Sm Public Certificate Rotation] - (List) Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:
- secret_
group_ strid - (String) 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 - 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[Get
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
- endpoint_
type str - secret_
group_ strname
- alt
Names List<String> - (List) 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 - (Boolean) Indicates whether the issued certificate is bundled with intermediate certificates.
- ca String
- (String) The name of the certificate authority configuration..
- certificate String
- (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 - (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> - (Map) The secret metadata that a user can customize.
- description String
- (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
- (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.
- expiration
Date String - (String) The date a secret is expired. The date format follows RFC 3339.
- id String
- The unique identifier of the data source.
- instance
Id String - intermediate String
- (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
- (String) The distinguished name that identifies the entity that signed and issued the certificate.
- Constraints: The maximum length is
128
characters. The minimum length is2
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- key
Algorithm String - (String) The identifier for the cryptographic algorithm 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>
- (List) 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
- (String) The human-readable name of your secret.
- Constraints: The maximum length is
256
characters. The minimum length is2
characters.
- Constraints: The maximum length is
- private
Key String - (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
- rotations List<Property Map>
- (List) Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:
- secret
Group StringId - (String) 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 - 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
- endpoint
Type String - secret
Group StringName
Supporting Types
GetSmPublicCertificateIssuanceInfo
- Auto
Rotated bool - (Boolean) Indicates whether the issued certificate is configured with an automatic rotation policy.
- Challenges
List<Get
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
[]Get
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<Get
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
Get
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[Get
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:
GetSmPublicCertificateIssuanceInfoChallenge
- 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.
GetSmPublicCertificateRotation
- Auto
Rotate bool - (Boolean) Determines whether Secrets Manager rotates your secret automatically.Default is
false
. - Rotate
Keys bool - (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 - (Boolean) Determines whether Secrets Manager rotates your secret automatically.Default is
false
. - Rotate
Keys bool - (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 - (Boolean) Determines whether Secrets Manager rotates your secret automatically.Default is
false
. - rotate
Keys Boolean - (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 - (Boolean) Determines whether Secrets Manager rotates your secret automatically.Default is
false
. - rotate
Keys boolean - (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 - (Boolean) Determines whether Secrets Manager rotates your secret automatically.Default is
false
. - rotate_
keys bool - (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 - (Boolean) Determines whether Secrets Manager rotates your secret automatically.Default is
false
. - rotate
Keys Boolean - (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.
GetSmPublicCertificateValidity
- not_
after str - (String) The date-time format follows RFC 3339.
- not_
before str - (String) The date-time format follows RFC 3339.
Package Details
- Repository
- ibm ibm-cloud/terraform-provider-ibm
- License
- Notes
- This Pulumi package is based on the
ibm
Terraform Provider.