ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm.getSmSecrets
Explore with Pulumi AI
Provides a read-only data source for sm_secrets. You can then reference the fields of the data source in other resources within the same configuration using interpolation syntax.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";
const secrets = ibm.getSmSecrets({
instanceId: ibm_resource_instance.sm_instance.guid,
region: "us-south",
});
import pulumi
import pulumi_ibm as ibm
secrets = ibm.get_sm_secrets(instance_id=ibm_resource_instance["sm_instance"]["guid"],
region="us-south")
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.GetSmSecrets(ctx, &ibm.GetSmSecretsArgs{
InstanceId: ibm_resource_instance.Sm_instance.Guid,
Region: pulumi.StringRef("us-south"),
}, 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 secrets = Ibm.GetSmSecrets.Invoke(new()
{
InstanceId = ibm_resource_instance.Sm_instance.Guid,
Region = "us-south",
});
});
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.GetSmSecretsArgs;
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 secrets = IbmFunctions.getSmSecrets(GetSmSecretsArgs.builder()
.instanceId(ibm_resource_instance.sm_instance().guid())
.region("us-south")
.build());
}
}
variables:
secrets:
fn::invoke:
function: ibm:getSmSecrets
arguments:
instanceId: ${ibm_resource_instance.sm_instance.guid}
region: us-south
Using getSmSecrets
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 getSmSecrets(args: GetSmSecretsArgs, opts?: InvokeOptions): Promise<GetSmSecretsResult>
function getSmSecretsOutput(args: GetSmSecretsOutputArgs, opts?: InvokeOptions): Output<GetSmSecretsResult>
def get_sm_secrets(endpoint_type: Optional[str] = None,
groups: Optional[str] = None,
id: Optional[str] = None,
instance_id: Optional[str] = None,
match_all_labels: Optional[Sequence[str]] = None,
region: Optional[str] = None,
search: Optional[str] = None,
secret_types: Optional[Sequence[str]] = None,
sort: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetSmSecretsResult
def get_sm_secrets_output(endpoint_type: Optional[pulumi.Input[str]] = None,
groups: Optional[pulumi.Input[str]] = None,
id: Optional[pulumi.Input[str]] = None,
instance_id: Optional[pulumi.Input[str]] = None,
match_all_labels: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
region: Optional[pulumi.Input[str]] = None,
search: Optional[pulumi.Input[str]] = None,
secret_types: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
sort: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetSmSecretsResult]
func GetSmSecrets(ctx *Context, args *GetSmSecretsArgs, opts ...InvokeOption) (*GetSmSecretsResult, error)
func GetSmSecretsOutput(ctx *Context, args *GetSmSecretsOutputArgs, opts ...InvokeOption) GetSmSecretsResultOutput
> Note: This function is named GetSmSecrets
in the Go SDK.
public static class GetSmSecrets
{
public static Task<GetSmSecretsResult> InvokeAsync(GetSmSecretsArgs args, InvokeOptions? opts = null)
public static Output<GetSmSecretsResult> Invoke(GetSmSecretsInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetSmSecretsResult> getSmSecrets(GetSmSecretsArgs args, InvokeOptions options)
public static Output<GetSmSecretsResult> getSmSecrets(GetSmSecretsArgs args, InvokeOptions options)
fn::invoke:
function: ibm:index/getSmSecrets:getSmSecrets
arguments:
# arguments dictionary
The following arguments are supported:
- Instance
Id This property is required. 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:
- Groups string
- Filter secrets by groups. You can apply multiple filters by using a comma-separated list of secret group IDs. If you need to filter secrets that are in the default secret group, use the
default
keyword. - Id string
- (String) A UUID identifier.
- 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
- Match
All List<string>Labels - Filter secrets by a label or a combination of labels (comma-separated list).
- Region string
- The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
- Search string
- Obtain a collection of secrets that contain the specified string in one or more of the fields:
id
,name
,description
,labels
,secret_type
. - Secret
Types List<string> - Filter secrets by secret types. You can apply multiple filters by using a comma-separated list of secret types.
- Sort string
- Sort a collection of secrets by the specified field in ascending order. To sort in descending order use the
-
character.- Constraints: Allowable values are:
id
,created_at
,updated_at
,expiration_date
,secret_type
,name
.
- Constraints: Allowable values are:
- Instance
Id This property is required. 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:
- Groups string
- Filter secrets by groups. You can apply multiple filters by using a comma-separated list of secret group IDs. If you need to filter secrets that are in the default secret group, use the
default
keyword. - Id string
- (String) A UUID identifier.
- 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
- Match
All []stringLabels - Filter secrets by a label or a combination of labels (comma-separated list).
- Region string
- The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
- Search string
- Obtain a collection of secrets that contain the specified string in one or more of the fields:
id
,name
,description
,labels
,secret_type
. - Secret
Types []string - Filter secrets by secret types. You can apply multiple filters by using a comma-separated list of secret types.
- Sort string
- Sort a collection of secrets by the specified field in ascending order. To sort in descending order use the
-
character.- Constraints: Allowable values are:
id
,created_at
,updated_at
,expiration_date
,secret_type
,name
.
- Constraints: Allowable values are:
- instance
Id This property is required. 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:
- groups String
- Filter secrets by groups. You can apply multiple filters by using a comma-separated list of secret group IDs. If you need to filter secrets that are in the default secret group, use the
default
keyword. - id String
- (String) A UUID identifier.
- 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
- match
All List<String>Labels - Filter secrets by a label or a combination of labels (comma-separated list).
- region String
- The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
- search String
- Obtain a collection of secrets that contain the specified string in one or more of the fields:
id
,name
,description
,labels
,secret_type
. - secret
Types List<String> - Filter secrets by secret types. You can apply multiple filters by using a comma-separated list of secret types.
- sort String
- Sort a collection of secrets by the specified field in ascending order. To sort in descending order use the
-
character.- Constraints: Allowable values are:
id
,created_at
,updated_at
,expiration_date
,secret_type
,name
.
- Constraints: Allowable values are:
- instance
Id This property is required. 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:
- groups string
- Filter secrets by groups. You can apply multiple filters by using a comma-separated list of secret group IDs. If you need to filter secrets that are in the default secret group, use the
default
keyword. - id string
- (String) A UUID identifier.
- 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
- match
All string[]Labels - Filter secrets by a label or a combination of labels (comma-separated list).
- region string
- The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
- search string
- Obtain a collection of secrets that contain the specified string in one or more of the fields:
id
,name
,description
,labels
,secret_type
. - secret
Types string[] - Filter secrets by secret types. You can apply multiple filters by using a comma-separated list of secret types.
- sort string
- Sort a collection of secrets by the specified field in ascending order. To sort in descending order use the
-
character.- Constraints: Allowable values are:
id
,created_at
,updated_at
,expiration_date
,secret_type
,name
.
- Constraints: Allowable values are:
- instance_
id This property is required. 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:
- groups str
- Filter secrets by groups. You can apply multiple filters by using a comma-separated list of secret group IDs. If you need to filter secrets that are in the default secret group, use the
default
keyword. - id str
- (String) A UUID identifier.
- 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
- match_
all_ Sequence[str]labels - Filter secrets by a label or a combination of labels (comma-separated list).
- region str
- The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
- search str
- Obtain a collection of secrets that contain the specified string in one or more of the fields:
id
,name
,description
,labels
,secret_type
. - secret_
types Sequence[str] - Filter secrets by secret types. You can apply multiple filters by using a comma-separated list of secret types.
- sort str
- Sort a collection of secrets by the specified field in ascending order. To sort in descending order use the
-
character.- Constraints: Allowable values are:
id
,created_at
,updated_at
,expiration_date
,secret_type
,name
.
- Constraints: Allowable values are:
- instance
Id This property is required. 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:
- groups String
- Filter secrets by groups. You can apply multiple filters by using a comma-separated list of secret group IDs. If you need to filter secrets that are in the default secret group, use the
default
keyword. - id String
- (String) A UUID identifier.
- 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
- match
All List<String>Labels - Filter secrets by a label or a combination of labels (comma-separated list).
- region String
- The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
- search String
- Obtain a collection of secrets that contain the specified string in one or more of the fields:
id
,name
,description
,labels
,secret_type
. - secret
Types List<String> - Filter secrets by secret types. You can apply multiple filters by using a comma-separated list of secret types.
- sort String
- Sort a collection of secrets by the specified field in ascending order. To sort in descending order use the
-
character.- Constraints: Allowable values are:
id
,created_at
,updated_at
,expiration_date
,secret_type
,name
.
- Constraints: Allowable values are:
getSmSecrets Result
The following output properties are available:
- Id string
- (String) A UUID identifier.
- 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 - Region string
- Secrets
List<Get
Sm Secrets Secret> - (List) A collection of secret metadata. Note that the list of metadata attributes conatains attributes that are common to all types of secrets, as well as attributes that are specific to cetrain secret types. A type specific attribute is included in every secret but the value is empty for secrets of other types. The common attributes are:
name, id, description, secret_type, crn, created_by, created_at, updated_at, downloaded, secret_group_id, state, state_description, versions_total
.- Constraints: The maximum length is
1000
items. The minimum length is0
items. Nested scheme for secrets:
- Constraints: The maximum length is
- Total
Count double - Endpoint
Type string - Groups string
- Match
All List<string>Labels - Search string
- Secret
Types List<string> - Sort string
- Id string
- (String) A UUID identifier.
- 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 - Region string
- Secrets
[]Get
Sm Secrets Secret - (List) A collection of secret metadata. Note that the list of metadata attributes conatains attributes that are common to all types of secrets, as well as attributes that are specific to cetrain secret types. A type specific attribute is included in every secret but the value is empty for secrets of other types. The common attributes are:
name, id, description, secret_type, crn, created_by, created_at, updated_at, downloaded, secret_group_id, state, state_description, versions_total
.- Constraints: The maximum length is
1000
items. The minimum length is0
items. Nested scheme for secrets:
- Constraints: The maximum length is
- Total
Count float64 - Endpoint
Type string - Groups string
- Match
All []stringLabels - Search string
- Secret
Types []string - Sort string
- id String
- (String) A UUID identifier.
- 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 - region String
- secrets
List<Get
Sm Secrets Secret> - (List) A collection of secret metadata. Note that the list of metadata attributes conatains attributes that are common to all types of secrets, as well as attributes that are specific to cetrain secret types. A type specific attribute is included in every secret but the value is empty for secrets of other types. The common attributes are:
name, id, description, secret_type, crn, created_by, created_at, updated_at, downloaded, secret_group_id, state, state_description, versions_total
.- Constraints: The maximum length is
1000
items. The minimum length is0
items. Nested scheme for secrets:
- Constraints: The maximum length is
- total
Count Double - endpoint
Type String - groups String
- match
All List<String>Labels - search String
- secret
Types List<String> - sort String
- id string
- (String) A UUID identifier.
- 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 - region string
- secrets
Get
Sm Secrets Secret[] - (List) A collection of secret metadata. Note that the list of metadata attributes conatains attributes that are common to all types of secrets, as well as attributes that are specific to cetrain secret types. A type specific attribute is included in every secret but the value is empty for secrets of other types. The common attributes are:
name, id, description, secret_type, crn, created_by, created_at, updated_at, downloaded, secret_group_id, state, state_description, versions_total
.- Constraints: The maximum length is
1000
items. The minimum length is0
items. Nested scheme for secrets:
- Constraints: The maximum length is
- total
Count number - endpoint
Type string - groups string
- match
All string[]Labels - search string
- secret
Types string[] - sort string
- id str
- (String) A UUID identifier.
- 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 - region str
- secrets
Sequence[Get
Sm Secrets Secret] - (List) A collection of secret metadata. Note that the list of metadata attributes conatains attributes that are common to all types of secrets, as well as attributes that are specific to cetrain secret types. A type specific attribute is included in every secret but the value is empty for secrets of other types. The common attributes are:
name, id, description, secret_type, crn, created_by, created_at, updated_at, downloaded, secret_group_id, state, state_description, versions_total
.- Constraints: The maximum length is
1000
items. The minimum length is0
items. Nested scheme for secrets:
- Constraints: The maximum length is
- total_
count float - endpoint_
type str - groups str
- match_
all_ Sequence[str]labels - search str
- secret_
types Sequence[str] - sort str
- id String
- (String) A UUID identifier.
- 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 - region String
- secrets List<Property Map>
- (List) A collection of secret metadata. Note that the list of metadata attributes conatains attributes that are common to all types of secrets, as well as attributes that are specific to cetrain secret types. A type specific attribute is included in every secret but the value is empty for secrets of other types. The common attributes are:
name, id, description, secret_type, crn, created_by, created_at, updated_at, downloaded, secret_group_id, state, state_description, versions_total
.- Constraints: The maximum length is
1000
items. The minimum length is0
items. Nested scheme for secrets:
- Constraints: The maximum length is
- total
Count Number - endpoint
Type String - groups String
- match
All List<String>Labels - search String
- secret
Types List<String> - sort String
Supporting Types
GetSmSecretsSecret
- Access
Groups This property is required. List<string> - (List) Access Groups that you can use for an
iam_credentials
secret.Up to 10 Access Groups can be used for each secret.- Constraints: The list items must match regular expression
/^AccessGroupId-[a-z0-9-]+[a-z0-9]$/
. The maximum length is10
items. The minimum length is1
item.
- Constraints: The list items must match regular expression
- Alt
Names This property is required. 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
- Api
Key Id This property is required. string - (String) The ID of the API key that is generated for this secret.
- Bundle
Certs This property is required. bool - (Boolean) Indicates whether the issued certificate is bundled with intermediate certificates.
- Ca
This property is required. string - (String) The name that is assigned to the certificate authority configuration.
This property is required. string- (String) The intermediate certificate authority that signed this certificate.
- Certificate
Template This property is required. string - (String) The name of the certificate template.
- Constraints: The maximum length is
128
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
- Common
Name This property is required. 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 This property is required. string - (String) The date when a resource was created. The date format follows RFC 3339.
- Created
By This property is required. 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
This property is required. string - (String) The CRN role identifier for creating a service-id.
- Custom
Metadata This property is required. Dictionary<string, string> - (Map) The secret metadata that a user can customize.
- Description
This property is required. string - (String) The IAM API key description for the generated service credentials.
- Dns
This property is required. string - (String) The name that is assigned to the DNS provider configuration.
- Downloaded
This property is required. 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 This property is required. string - (String) The date a secret is expired. The date format follows RFC 3339.
- Id
This property is required. string - (String) A UUID identifier.
- 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
- Intermediate
Included This property is required. bool - (Boolean) Indicates whether the certificate was imported with an associated intermediate certificate.
- Issuance
Infos This property is required. List<GetSm Secrets Secret Issuance Info> - (List) Issuance information that is associated with your certificate. Nested scheme for issuance_info:
- Issuer
This property is required. 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 This property is required. string - (String) The identifier for the cryptographic algorithm used to generate the public key that is associated with the certificate.
- Constraints: The maximum length is
10
characters. The minimum length is2
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- Labels
This property is required. 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 This property is required. 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
This property is required. string - (String) The resource key name of the generated service credentials.
- Next
Rotation Date This property is required. string - (String) The date that the secret is scheduled for automatic rotation.The service automatically creates a new version of the secret on its next rotation date. This field exists only for secrets that have an existing rotation policy.
- Private
Key Included This property is required. bool - (Boolean) Indicates whether the certificate was imported with an associated private key.
- Reuse
Api Key This property is required. bool - Revocation
Time Rfc3339 This property is required. string - (String) The date and time that the certificate was revoked. The date format follows RFC 3339.
- Revocation
Time Seconds This property is required. double - (Integer) The timestamp of the certificate revocation.
- Rotations
This property is required. List<GetSm Secrets Secret Rotation> - (List) Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:
- Secret
Group Id This property is required. string - (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
Type This property is required. 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 This property is required. 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
- Service
Id This property is required. string - (String) The service ID under which the API key (see the
api_key
field) is created.If you omit this parameter, Secrets Manager generates a new service ID for your secret at its creation and adds it to the access groups that you assign.Optionally, you can use this field to provide your own service ID if you prefer to manage its access directly or retain the service ID after your secret expires, is rotated, or deleted. If you provide a service ID, do not include theaccess_groups
parameter.- Constraints: The maximum length is
50
characters. The minimum length is40
characters. The value must match regular expression/^[A-Za-z0-9][A-Za-z0-9]*(?:-?[A-Za-z0-9]+)*$/
.
- Constraints: The maximum length is
- Service
Id Is Static This property is required. bool - (Boolean) Indicates whether an
iam_credentials
secret was created with a static service ID.If it is set totrue
, the service ID for the secret was provided by the user at secret creation. If it is set tofalse
, the service ID was generated by Secrets Manager. - Signing
Algorithm This property is required. 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
- Source
Services This property is required. List<GetSm Secrets Secret Source Service> - (List) The properties required for creating the service credentials for the specified source service instance. Nested scheme for source_service:
- State
This property is required. 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 This property is required. string - (String) A text representation of the secret state.
- Constraints: Allowable values are:
pre_activation
,active
,suspended
,deactivated
,destroyed
.
- Constraints: Allowable values are:
- Ttl
This property is required. string - (String) The time-to-live (TTL) or lease duration to assign to generated credentials.For
iam_credentials
secrets, the TTL defines for how long each generated API key remains valid. The value can be either an integer that specifies the number of seconds, or the string representation of a duration, such as120m
or24h
.Minimum duration is 1 minute. Maximum is 90 days.- Constraints: The maximum length is
10
characters. The minimum length is2
characters. The value must match regular expression/^[0-9]+[s,m,h,d]{0,1}$/
.
- Constraints: The maximum length is
- Updated
At This property is required. string - (String) The date when a resource was recently modified. The date format follows RFC 3339.
- Validities
This property is required. List<GetSm Secrets Secret Validity> - (List) The date and time that the certificate validity period begins and ends. Nested scheme for validity:
- Versions
Total This property is required. double - (Integer) The number of versions of the secret.
- Constraints: The maximum value is
50
. The minimum value is0
.
- Constraints: The maximum value is
- Access
Groups This property is required. []string - (List) Access Groups that you can use for an
iam_credentials
secret.Up to 10 Access Groups can be used for each secret.- Constraints: The list items must match regular expression
/^AccessGroupId-[a-z0-9-]+[a-z0-9]$/
. The maximum length is10
items. The minimum length is1
item.
- Constraints: The list items must match regular expression
- Alt
Names This property is required. []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
- Api
Key Id This property is required. string - (String) The ID of the API key that is generated for this secret.
- Bundle
Certs This property is required. bool - (Boolean) Indicates whether the issued certificate is bundled with intermediate certificates.
- Ca
This property is required. string - (String) The name that is assigned to the certificate authority configuration.
This property is required. string- (String) The intermediate certificate authority that signed this certificate.
- Certificate
Template This property is required. string - (String) The name of the certificate template.
- Constraints: The maximum length is
128
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
- Common
Name This property is required. 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 This property is required. string - (String) The date when a resource was created. The date format follows RFC 3339.
- Created
By This property is required. 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
This property is required. string - (String) The CRN role identifier for creating a service-id.
- Custom
Metadata This property is required. map[string]string - (Map) The secret metadata that a user can customize.
- Description
This property is required. string - (String) The IAM API key description for the generated service credentials.
- Dns
This property is required. string - (String) The name that is assigned to the DNS provider configuration.
- Downloaded
This property is required. 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 This property is required. string - (String) The date a secret is expired. The date format follows RFC 3339.
- Id
This property is required. string - (String) A UUID identifier.
- 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
- Intermediate
Included This property is required. bool - (Boolean) Indicates whether the certificate was imported with an associated intermediate certificate.
- Issuance
Infos This property is required. []GetSm Secrets Secret Issuance Info - (List) Issuance information that is associated with your certificate. Nested scheme for issuance_info:
- Issuer
This property is required. 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 This property is required. string - (String) The identifier for the cryptographic algorithm used to generate the public key that is associated with the certificate.
- Constraints: The maximum length is
10
characters. The minimum length is2
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- Labels
This property is required. []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 This property is required. 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
This property is required. string - (String) The resource key name of the generated service credentials.
- Next
Rotation Date This property is required. string - (String) The date that the secret is scheduled for automatic rotation.The service automatically creates a new version of the secret on its next rotation date. This field exists only for secrets that have an existing rotation policy.
- Private
Key Included This property is required. bool - (Boolean) Indicates whether the certificate was imported with an associated private key.
- Reuse
Api Key This property is required. bool - Revocation
Time Rfc3339 This property is required. string - (String) The date and time that the certificate was revoked. The date format follows RFC 3339.
- Revocation
Time Seconds This property is required. float64 - (Integer) The timestamp of the certificate revocation.
- Rotations
This property is required. []GetSm Secrets Secret Rotation - (List) Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:
- Secret
Group Id This property is required. string - (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
Type This property is required. 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 This property is required. 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
- Service
Id This property is required. string - (String) The service ID under which the API key (see the
api_key
field) is created.If you omit this parameter, Secrets Manager generates a new service ID for your secret at its creation and adds it to the access groups that you assign.Optionally, you can use this field to provide your own service ID if you prefer to manage its access directly or retain the service ID after your secret expires, is rotated, or deleted. If you provide a service ID, do not include theaccess_groups
parameter.- Constraints: The maximum length is
50
characters. The minimum length is40
characters. The value must match regular expression/^[A-Za-z0-9][A-Za-z0-9]*(?:-?[A-Za-z0-9]+)*$/
.
- Constraints: The maximum length is
- Service
Id Is Static This property is required. bool - (Boolean) Indicates whether an
iam_credentials
secret was created with a static service ID.If it is set totrue
, the service ID for the secret was provided by the user at secret creation. If it is set tofalse
, the service ID was generated by Secrets Manager. - Signing
Algorithm This property is required. 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
- Source
Services This property is required. []GetSm Secrets Secret Source Service - (List) The properties required for creating the service credentials for the specified source service instance. Nested scheme for source_service:
- State
This property is required. 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 This property is required. string - (String) A text representation of the secret state.
- Constraints: Allowable values are:
pre_activation
,active
,suspended
,deactivated
,destroyed
.
- Constraints: Allowable values are:
- Ttl
This property is required. string - (String) The time-to-live (TTL) or lease duration to assign to generated credentials.For
iam_credentials
secrets, the TTL defines for how long each generated API key remains valid. The value can be either an integer that specifies the number of seconds, or the string representation of a duration, such as120m
or24h
.Minimum duration is 1 minute. Maximum is 90 days.- Constraints: The maximum length is
10
characters. The minimum length is2
characters. The value must match regular expression/^[0-9]+[s,m,h,d]{0,1}$/
.
- Constraints: The maximum length is
- Updated
At This property is required. string - (String) The date when a resource was recently modified. The date format follows RFC 3339.
- Validities
This property is required. []GetSm Secrets Secret Validity - (List) The date and time that the certificate validity period begins and ends. Nested scheme for validity:
- Versions
Total This property is required. float64 - (Integer) The number of versions of the secret.
- Constraints: The maximum value is
50
. The minimum value is0
.
- Constraints: The maximum value is
- access
Groups This property is required. List<String> - (List) Access Groups that you can use for an
iam_credentials
secret.Up to 10 Access Groups can be used for each secret.- Constraints: The list items must match regular expression
/^AccessGroupId-[a-z0-9-]+[a-z0-9]$/
. The maximum length is10
items. The minimum length is1
item.
- Constraints: The list items must match regular expression
- alt
Names This property is required. 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
- api
Key Id This property is required. String - (String) The ID of the API key that is generated for this secret.
- bundle
Certs This property is required. Boolean - (Boolean) Indicates whether the issued certificate is bundled with intermediate certificates.
- ca
This property is required. String - (String) The name that is assigned to the certificate authority configuration.
This property is required. String- (String) The intermediate certificate authority that signed this certificate.
- certificate
Template This property is required. String - (String) The name of the certificate template.
- Constraints: The maximum length is
128
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
- common
Name This property is required. 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 This property is required. String - (String) The date when a resource was created. The date format follows RFC 3339.
- created
By This property is required. 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
This property is required. String - (String) The CRN role identifier for creating a service-id.
- custom
Metadata This property is required. Map<String,String> - (Map) The secret metadata that a user can customize.
- description
This property is required. String - (String) The IAM API key description for the generated service credentials.
- dns
This property is required. String - (String) The name that is assigned to the DNS provider configuration.
- downloaded
This property is required. 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 This property is required. String - (String) The date a secret is expired. The date format follows RFC 3339.
- id
This property is required. String - (String) A UUID identifier.
- 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
- intermediate
Included This property is required. Boolean - (Boolean) Indicates whether the certificate was imported with an associated intermediate certificate.
- issuance
Infos This property is required. List<GetSm Secrets Secret Issuance Info> - (List) Issuance information that is associated with your certificate. Nested scheme for issuance_info:
- issuer
This property is required. 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 This property is required. String - (String) The identifier for the cryptographic algorithm used to generate the public key that is associated with the certificate.
- Constraints: The maximum length is
10
characters. The minimum length is2
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- labels
This property is required. 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 This property is required. 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
This property is required. String - (String) The resource key name of the generated service credentials.
- next
Rotation Date This property is required. String - (String) The date that the secret is scheduled for automatic rotation.The service automatically creates a new version of the secret on its next rotation date. This field exists only for secrets that have an existing rotation policy.
- private
Key Included This property is required. Boolean - (Boolean) Indicates whether the certificate was imported with an associated private key.
- reuse
Api Key This property is required. Boolean - revocation
Time Rfc3339 This property is required. String - (String) The date and time that the certificate was revoked. The date format follows RFC 3339.
- revocation
Time Seconds This property is required. Double - (Integer) The timestamp of the certificate revocation.
- rotations
This property is required. List<GetSm Secrets Secret Rotation> - (List) Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:
- secret
Group Id This property is required. String - (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
Type This property is required. 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 This property is required. 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
- service
Id This property is required. String - (String) The service ID under which the API key (see the
api_key
field) is created.If you omit this parameter, Secrets Manager generates a new service ID for your secret at its creation and adds it to the access groups that you assign.Optionally, you can use this field to provide your own service ID if you prefer to manage its access directly or retain the service ID after your secret expires, is rotated, or deleted. If you provide a service ID, do not include theaccess_groups
parameter.- Constraints: The maximum length is
50
characters. The minimum length is40
characters. The value must match regular expression/^[A-Za-z0-9][A-Za-z0-9]*(?:-?[A-Za-z0-9]+)*$/
.
- Constraints: The maximum length is
- service
Id Is Static This property is required. Boolean - (Boolean) Indicates whether an
iam_credentials
secret was created with a static service ID.If it is set totrue
, the service ID for the secret was provided by the user at secret creation. If it is set tofalse
, the service ID was generated by Secrets Manager. - signing
Algorithm This property is required. 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
- source
Services This property is required. List<GetSm Secrets Secret Source Service> - (List) The properties required for creating the service credentials for the specified source service instance. Nested scheme for source_service:
- state
This property is required. 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 This property is required. String - (String) A text representation of the secret state.
- Constraints: Allowable values are:
pre_activation
,active
,suspended
,deactivated
,destroyed
.
- Constraints: Allowable values are:
- ttl
This property is required. String - (String) The time-to-live (TTL) or lease duration to assign to generated credentials.For
iam_credentials
secrets, the TTL defines for how long each generated API key remains valid. The value can be either an integer that specifies the number of seconds, or the string representation of a duration, such as120m
or24h
.Minimum duration is 1 minute. Maximum is 90 days.- Constraints: The maximum length is
10
characters. The minimum length is2
characters. The value must match regular expression/^[0-9]+[s,m,h,d]{0,1}$/
.
- Constraints: The maximum length is
- updated
At This property is required. String - (String) The date when a resource was recently modified. The date format follows RFC 3339.
- validities
This property is required. List<GetSm Secrets Secret Validity> - (List) The date and time that the certificate validity period begins and ends. Nested scheme for validity:
- versions
Total This property is required. Double - (Integer) The number of versions of the secret.
- Constraints: The maximum value is
50
. The minimum value is0
.
- Constraints: The maximum value is
- access
Groups This property is required. string[] - (List) Access Groups that you can use for an
iam_credentials
secret.Up to 10 Access Groups can be used for each secret.- Constraints: The list items must match regular expression
/^AccessGroupId-[a-z0-9-]+[a-z0-9]$/
. The maximum length is10
items. The minimum length is1
item.
- Constraints: The list items must match regular expression
- alt
Names This property is required. 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
- api
Key Id This property is required. string - (String) The ID of the API key that is generated for this secret.
- bundle
Certs This property is required. boolean - (Boolean) Indicates whether the issued certificate is bundled with intermediate certificates.
- ca
This property is required. string - (String) The name that is assigned to the certificate authority configuration.
This property is required. string- (String) The intermediate certificate authority that signed this certificate.
- certificate
Template This property is required. string - (String) The name of the certificate template.
- Constraints: The maximum length is
128
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
- common
Name This property is required. 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 This property is required. string - (String) The date when a resource was created. The date format follows RFC 3339.
- created
By This property is required. 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
This property is required. string - (String) The CRN role identifier for creating a service-id.
- custom
Metadata This property is required. {[key: string]: string} - (Map) The secret metadata that a user can customize.
- description
This property is required. string - (String) The IAM API key description for the generated service credentials.
- dns
This property is required. string - (String) The name that is assigned to the DNS provider configuration.
- downloaded
This property is required. 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 This property is required. string - (String) The date a secret is expired. The date format follows RFC 3339.
- id
This property is required. string - (String) A UUID identifier.
- 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
- intermediate
Included This property is required. boolean - (Boolean) Indicates whether the certificate was imported with an associated intermediate certificate.
- issuance
Infos This property is required. GetSm Secrets Secret Issuance Info[] - (List) Issuance information that is associated with your certificate. Nested scheme for issuance_info:
- issuer
This property is required. 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 This property is required. string - (String) The identifier for the cryptographic algorithm used to generate the public key that is associated with the certificate.
- Constraints: The maximum length is
10
characters. The minimum length is2
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- labels
This property is required. 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 This property is required. 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
This property is required. string - (String) The resource key name of the generated service credentials.
- next
Rotation Date This property is required. string - (String) The date that the secret is scheduled for automatic rotation.The service automatically creates a new version of the secret on its next rotation date. This field exists only for secrets that have an existing rotation policy.
- private
Key Included This property is required. boolean - (Boolean) Indicates whether the certificate was imported with an associated private key.
- reuse
Api Key This property is required. boolean - revocation
Time Rfc3339 This property is required. string - (String) The date and time that the certificate was revoked. The date format follows RFC 3339.
- revocation
Time Seconds This property is required. number - (Integer) The timestamp of the certificate revocation.
- rotations
This property is required. GetSm Secrets Secret Rotation[] - (List) Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:
- secret
Group Id This property is required. string - (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
Type This property is required. 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 This property is required. 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
- service
Id This property is required. string - (String) The service ID under which the API key (see the
api_key
field) is created.If you omit this parameter, Secrets Manager generates a new service ID for your secret at its creation and adds it to the access groups that you assign.Optionally, you can use this field to provide your own service ID if you prefer to manage its access directly or retain the service ID after your secret expires, is rotated, or deleted. If you provide a service ID, do not include theaccess_groups
parameter.- Constraints: The maximum length is
50
characters. The minimum length is40
characters. The value must match regular expression/^[A-Za-z0-9][A-Za-z0-9]*(?:-?[A-Za-z0-9]+)*$/
.
- Constraints: The maximum length is
- service
Id Is Static This property is required. boolean - (Boolean) Indicates whether an
iam_credentials
secret was created with a static service ID.If it is set totrue
, the service ID for the secret was provided by the user at secret creation. If it is set tofalse
, the service ID was generated by Secrets Manager. - signing
Algorithm This property is required. 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
- source
Services This property is required. GetSm Secrets Secret Source Service[] - (List) The properties required for creating the service credentials for the specified source service instance. Nested scheme for source_service:
- state
This property is required. 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 This property is required. string - (String) A text representation of the secret state.
- Constraints: Allowable values are:
pre_activation
,active
,suspended
,deactivated
,destroyed
.
- Constraints: Allowable values are:
- ttl
This property is required. string - (String) The time-to-live (TTL) or lease duration to assign to generated credentials.For
iam_credentials
secrets, the TTL defines for how long each generated API key remains valid. The value can be either an integer that specifies the number of seconds, or the string representation of a duration, such as120m
or24h
.Minimum duration is 1 minute. Maximum is 90 days.- Constraints: The maximum length is
10
characters. The minimum length is2
characters. The value must match regular expression/^[0-9]+[s,m,h,d]{0,1}$/
.
- Constraints: The maximum length is
- updated
At This property is required. string - (String) The date when a resource was recently modified. The date format follows RFC 3339.
- validities
This property is required. GetSm Secrets Secret Validity[] - (List) The date and time that the certificate validity period begins and ends. Nested scheme for validity:
- versions
Total This property is required. number - (Integer) The number of versions of the secret.
- Constraints: The maximum value is
50
. The minimum value is0
.
- Constraints: The maximum value is
- access_
groups This property is required. Sequence[str] - (List) Access Groups that you can use for an
iam_credentials
secret.Up to 10 Access Groups can be used for each secret.- Constraints: The list items must match regular expression
/^AccessGroupId-[a-z0-9-]+[a-z0-9]$/
. The maximum length is10
items. The minimum length is1
item.
- Constraints: The list items must match regular expression
- alt_
names This property is required. 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
- api_
key_ id This property is required. str - (String) The ID of the API key that is generated for this secret.
- bundle_
certs This property is required. bool - (Boolean) Indicates whether the issued certificate is bundled with intermediate certificates.
- ca
This property is required. str - (String) The name that is assigned to the certificate authority configuration.
This property is required. str- (String) The intermediate certificate authority that signed this certificate.
- certificate_
template This property is required. str - (String) The name of the certificate template.
- Constraints: The maximum length is
128
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
- common_
name This property is required. 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 This property is required. str - (String) The date when a resource was created. The date format follows RFC 3339.
- created_
by This property is required. 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
This property is required. str - (String) The CRN role identifier for creating a service-id.
- custom_
metadata This property is required. Mapping[str, str] - (Map) The secret metadata that a user can customize.
- description
This property is required. str - (String) The IAM API key description for the generated service credentials.
- dns
This property is required. str - (String) The name that is assigned to the DNS provider configuration.
- downloaded
This property is required. 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 This property is required. str - (String) The date a secret is expired. The date format follows RFC 3339.
- id
This property is required. str - (String) A UUID identifier.
- 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
- intermediate_
included This property is required. bool - (Boolean) Indicates whether the certificate was imported with an associated intermediate certificate.
- issuance_
infos This property is required. Sequence[GetSm Secrets Secret Issuance Info] - (List) Issuance information that is associated with your certificate. Nested scheme for issuance_info:
- issuer
This property is required. 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 This property is required. str - (String) The identifier for the cryptographic algorithm used to generate the public key that is associated with the certificate.
- Constraints: The maximum length is
10
characters. The minimum length is2
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- labels
This property is required. 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 This property is required. 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
This property is required. str - (String) The resource key name of the generated service credentials.
- next_
rotation_ date This property is required. str - (String) The date that the secret is scheduled for automatic rotation.The service automatically creates a new version of the secret on its next rotation date. This field exists only for secrets that have an existing rotation policy.
- private_
key_ included This property is required. bool - (Boolean) Indicates whether the certificate was imported with an associated private key.
- reuse_
api_ key This property is required. bool - revocation_
time_ rfc3339 This property is required. str - (String) The date and time that the certificate was revoked. The date format follows RFC 3339.
- revocation_
time_ seconds This property is required. float - (Integer) The timestamp of the certificate revocation.
- rotations
This property is required. Sequence[GetSm Secrets Secret Rotation] - (List) Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:
- secret_
group_ id This property is required. str - (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_
type This property is required. 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 This property is required. 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
- service_
id This property is required. str - (String) The service ID under which the API key (see the
api_key
field) is created.If you omit this parameter, Secrets Manager generates a new service ID for your secret at its creation and adds it to the access groups that you assign.Optionally, you can use this field to provide your own service ID if you prefer to manage its access directly or retain the service ID after your secret expires, is rotated, or deleted. If you provide a service ID, do not include theaccess_groups
parameter.- Constraints: The maximum length is
50
characters. The minimum length is40
characters. The value must match regular expression/^[A-Za-z0-9][A-Za-z0-9]*(?:-?[A-Za-z0-9]+)*$/
.
- Constraints: The maximum length is
- service_
id_ is_ static This property is required. bool - (Boolean) Indicates whether an
iam_credentials
secret was created with a static service ID.If it is set totrue
, the service ID for the secret was provided by the user at secret creation. If it is set tofalse
, the service ID was generated by Secrets Manager. - signing_
algorithm This property is required. 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
- source_
services This property is required. Sequence[GetSm Secrets Secret Source Service] - (List) The properties required for creating the service credentials for the specified source service instance. Nested scheme for source_service:
- state
This property is required. 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 This property is required. str - (String) A text representation of the secret state.
- Constraints: Allowable values are:
pre_activation
,active
,suspended
,deactivated
,destroyed
.
- Constraints: Allowable values are:
- ttl
This property is required. str - (String) The time-to-live (TTL) or lease duration to assign to generated credentials.For
iam_credentials
secrets, the TTL defines for how long each generated API key remains valid. The value can be either an integer that specifies the number of seconds, or the string representation of a duration, such as120m
or24h
.Minimum duration is 1 minute. Maximum is 90 days.- Constraints: The maximum length is
10
characters. The minimum length is2
characters. The value must match regular expression/^[0-9]+[s,m,h,d]{0,1}$/
.
- Constraints: The maximum length is
- updated_
at This property is required. str - (String) The date when a resource was recently modified. The date format follows RFC 3339.
- validities
This property is required. Sequence[GetSm Secrets Secret Validity] - (List) The date and time that the certificate validity period begins and ends. Nested scheme for validity:
- versions_
total This property is required. float - (Integer) The number of versions of the secret.
- Constraints: The maximum value is
50
. The minimum value is0
.
- Constraints: The maximum value is
- access
Groups This property is required. List<String> - (List) Access Groups that you can use for an
iam_credentials
secret.Up to 10 Access Groups can be used for each secret.- Constraints: The list items must match regular expression
/^AccessGroupId-[a-z0-9-]+[a-z0-9]$/
. The maximum length is10
items. The minimum length is1
item.
- Constraints: The list items must match regular expression
- alt
Names This property is required. 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
- api
Key Id This property is required. String - (String) The ID of the API key that is generated for this secret.
- bundle
Certs This property is required. Boolean - (Boolean) Indicates whether the issued certificate is bundled with intermediate certificates.
- ca
This property is required. String - (String) The name that is assigned to the certificate authority configuration.
This property is required. String- (String) The intermediate certificate authority that signed this certificate.
- certificate
Template This property is required. String - (String) The name of the certificate template.
- Constraints: The maximum length is
128
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
- common
Name This property is required. 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 This property is required. String - (String) The date when a resource was created. The date format follows RFC 3339.
- created
By This property is required. 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
This property is required. String - (String) The CRN role identifier for creating a service-id.
- custom
Metadata This property is required. Map<String> - (Map) The secret metadata that a user can customize.
- description
This property is required. String - (String) The IAM API key description for the generated service credentials.
- dns
This property is required. String - (String) The name that is assigned to the DNS provider configuration.
- downloaded
This property is required. 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 This property is required. String - (String) The date a secret is expired. The date format follows RFC 3339.
- id
This property is required. String - (String) A UUID identifier.
- 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
- intermediate
Included This property is required. Boolean - (Boolean) Indicates whether the certificate was imported with an associated intermediate certificate.
- issuance
Infos This property is required. List<Property Map> - (List) Issuance information that is associated with your certificate. Nested scheme for issuance_info:
- issuer
This property is required. 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 This property is required. String - (String) The identifier for the cryptographic algorithm used to generate the public key that is associated with the certificate.
- Constraints: The maximum length is
10
characters. The minimum length is2
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- labels
This property is required. 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 This property is required. 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
This property is required. String - (String) The resource key name of the generated service credentials.
- next
Rotation Date This property is required. String - (String) The date that the secret is scheduled for automatic rotation.The service automatically creates a new version of the secret on its next rotation date. This field exists only for secrets that have an existing rotation policy.
- private
Key Included This property is required. Boolean - (Boolean) Indicates whether the certificate was imported with an associated private key.
- reuse
Api Key This property is required. Boolean - revocation
Time Rfc3339 This property is required. String - (String) The date and time that the certificate was revoked. The date format follows RFC 3339.
- revocation
Time Seconds This property is required. Number - (Integer) The timestamp of the certificate revocation.
- rotations
This property is required. List<Property Map> - (List) Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:
- secret
Group Id This property is required. String - (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
Type This property is required. 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 This property is required. 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
- service
Id This property is required. String - (String) The service ID under which the API key (see the
api_key
field) is created.If you omit this parameter, Secrets Manager generates a new service ID for your secret at its creation and adds it to the access groups that you assign.Optionally, you can use this field to provide your own service ID if you prefer to manage its access directly or retain the service ID after your secret expires, is rotated, or deleted. If you provide a service ID, do not include theaccess_groups
parameter.- Constraints: The maximum length is
50
characters. The minimum length is40
characters. The value must match regular expression/^[A-Za-z0-9][A-Za-z0-9]*(?:-?[A-Za-z0-9]+)*$/
.
- Constraints: The maximum length is
- service
Id Is Static This property is required. Boolean - (Boolean) Indicates whether an
iam_credentials
secret was created with a static service ID.If it is set totrue
, the service ID for the secret was provided by the user at secret creation. If it is set tofalse
, the service ID was generated by Secrets Manager. - signing
Algorithm This property is required. 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
- source
Services This property is required. List<Property Map> - (List) The properties required for creating the service credentials for the specified source service instance. Nested scheme for source_service:
- state
This property is required. 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 This property is required. String - (String) A text representation of the secret state.
- Constraints: Allowable values are:
pre_activation
,active
,suspended
,deactivated
,destroyed
.
- Constraints: Allowable values are:
- ttl
This property is required. String - (String) The time-to-live (TTL) or lease duration to assign to generated credentials.For
iam_credentials
secrets, the TTL defines for how long each generated API key remains valid. The value can be either an integer that specifies the number of seconds, or the string representation of a duration, such as120m
or24h
.Minimum duration is 1 minute. Maximum is 90 days.- Constraints: The maximum length is
10
characters. The minimum length is2
characters. The value must match regular expression/^[0-9]+[s,m,h,d]{0,1}$/
.
- Constraints: The maximum length is
- updated
At This property is required. String - (String) The date when a resource was recently modified. The date format follows RFC 3339.
- validities
This property is required. List<Property Map> - (List) The date and time that the certificate validity period begins and ends. Nested scheme for validity:
- versions
Total This property is required. Number - (Integer) The number of versions of the secret.
- Constraints: The maximum value is
50
. The minimum value is0
.
- Constraints: The maximum value is
GetSmSecretsSecretIssuanceInfo
- Auto
Rotated This property is required. bool - (Boolean) Indicates whether the issued certificate is configured with an automatic rotation policy.
- Challenges
This property is required. List<GetSm Secrets Secret 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 Validation Time This property is required. string - (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 This property is required. 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 This property is required. string - (String) A human-readable message that provides details about the issuance error.
- Ordered
On This property is required. string - (String) The date when the certificate is ordered. The date format follows RFC 3339.
- State
This property is required. 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 This property is required. 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 This property is required. bool - (Boolean) Indicates whether the issued certificate is configured with an automatic rotation policy.
- Challenges
This property is required. []GetSm Secrets Secret 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 Validation Time This property is required. string - (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 This property is required. 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 This property is required. string - (String) A human-readable message that provides details about the issuance error.
- Ordered
On This property is required. string - (String) The date when the certificate is ordered. The date format follows RFC 3339.
- State
This property is required. 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 This property is required. 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 This property is required. Boolean - (Boolean) Indicates whether the issued certificate is configured with an automatic rotation policy.
- challenges
This property is required. List<GetSm Secrets Secret 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 Validation Time This property is required. String - (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 This property is required. 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 This property is required. String - (String) A human-readable message that provides details about the issuance error.
- ordered
On This property is required. String - (String) The date when the certificate is ordered. The date format follows RFC 3339.
- state
This property is required. 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 This property is required. 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 This property is required. boolean - (Boolean) Indicates whether the issued certificate is configured with an automatic rotation policy.
- challenges
This property is required. GetSm Secrets Secret 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 Validation Time This property is required. string - (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 This property is required. 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 This property is required. string - (String) A human-readable message that provides details about the issuance error.
- ordered
On This property is required. string - (String) The date when the certificate is ordered. The date format follows RFC 3339.
- state
This property is required. 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 This property is required. 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 This property is required. bool - (Boolean) Indicates whether the issued certificate is configured with an automatic rotation policy.
- challenges
This property is required. Sequence[GetSm Secrets Secret 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_ validation_ time This property is required. str - (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 This property is required. 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 This property is required. str - (String) A human-readable message that provides details about the issuance error.
- ordered_
on This property is required. str - (String) The date when the certificate is ordered. The date format follows RFC 3339.
- state
This property is required. 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 This property is required. 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 This property is required. Boolean - (Boolean) Indicates whether the issued certificate is configured with an automatic rotation policy.
- challenges
This property is required. 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 Validation Time This property is required. String - (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 This property is required. 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 This property is required. String - (String) A human-readable message that provides details about the issuance error.
- ordered
On This property is required. String - (String) The date when the certificate is ordered. The date format follows RFC 3339.
- state
This property is required. 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 This property is required. String - (String) A text representation of the secret state.
- Constraints: Allowable values are:
pre_activation
,active
,suspended
,deactivated
,destroyed
.
- Constraints: Allowable values are:
GetSmSecretsSecretIssuanceInfoChallenge
- Domain
This property is required. string - (String) The challenge domain.
- Expiration
This property is required. string - (String) The challenge expiration date. The date format follows RFC 3339.
- Status
This property is required. string - (String) The challenge status.
- Txt
Record Name This property is required. string - (String) The TXT record name.
- Txt
Record Value This property is required. string - (String) The TXT record value.
- Domain
This property is required. string - (String) The challenge domain.
- Expiration
This property is required. string - (String) The challenge expiration date. The date format follows RFC 3339.
- Status
This property is required. string - (String) The challenge status.
- Txt
Record Name This property is required. string - (String) The TXT record name.
- Txt
Record Value This property is required. string - (String) The TXT record value.
- domain
This property is required. String - (String) The challenge domain.
- expiration
This property is required. String - (String) The challenge expiration date. The date format follows RFC 3339.
- status
This property is required. String - (String) The challenge status.
- txt
Record Name This property is required. String - (String) The TXT record name.
- txt
Record Value This property is required. String - (String) The TXT record value.
- domain
This property is required. string - (String) The challenge domain.
- expiration
This property is required. string - (String) The challenge expiration date. The date format follows RFC 3339.
- status
This property is required. string - (String) The challenge status.
- txt
Record Name This property is required. string - (String) The TXT record name.
- txt
Record Value This property is required. string - (String) The TXT record value.
- domain
This property is required. str - (String) The challenge domain.
- expiration
This property is required. str - (String) The challenge expiration date. The date format follows RFC 3339.
- status
This property is required. str - (String) The challenge status.
- txt_
record_ name This property is required. str - (String) The TXT record name.
- txt_
record_ value This property is required. str - (String) The TXT record value.
- domain
This property is required. String - (String) The challenge domain.
- expiration
This property is required. String - (String) The challenge expiration date. The date format follows RFC 3339.
- status
This property is required. String - (String) The challenge status.
- txt
Record Name This property is required. String - (String) The TXT record name.
- txt
Record Value This property is required. String - (String) The TXT record value.
GetSmSecretsSecretRotation
- Auto
Rotate This property is required. bool - (Boolean) Determines whether Secrets Manager rotates your secret automatically.Default is
false
. Ifauto_rotate
is set totrue
the service rotates your secret based on the defined interval. - Interval
This property is required. double - (Integer) The length of the secret rotation time interval.
- Constraints: The minimum value is
1
.
- Constraints: The minimum value is
- Rotate
Keys This property is required. 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. - Unit
This property is required. string - (String) The units for the secret rotation time interval.
- Constraints: Allowable values are:
day
,month
.
- Constraints: Allowable values are:
- Auto
Rotate This property is required. bool - (Boolean) Determines whether Secrets Manager rotates your secret automatically.Default is
false
. Ifauto_rotate
is set totrue
the service rotates your secret based on the defined interval. - Interval
This property is required. float64 - (Integer) The length of the secret rotation time interval.
- Constraints: The minimum value is
1
.
- Constraints: The minimum value is
- Rotate
Keys This property is required. 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. - Unit
This property is required. string - (String) The units for the secret rotation time interval.
- Constraints: Allowable values are:
day
,month
.
- Constraints: Allowable values are:
- auto
Rotate This property is required. Boolean - (Boolean) Determines whether Secrets Manager rotates your secret automatically.Default is
false
. Ifauto_rotate
is set totrue
the service rotates your secret based on the defined interval. - interval
This property is required. Double - (Integer) The length of the secret rotation time interval.
- Constraints: The minimum value is
1
.
- Constraints: The minimum value is
- rotate
Keys This property is required. 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. - unit
This property is required. String - (String) The units for the secret rotation time interval.
- Constraints: Allowable values are:
day
,month
.
- Constraints: Allowable values are:
- auto
Rotate This property is required. boolean - (Boolean) Determines whether Secrets Manager rotates your secret automatically.Default is
false
. Ifauto_rotate
is set totrue
the service rotates your secret based on the defined interval. - interval
This property is required. number - (Integer) The length of the secret rotation time interval.
- Constraints: The minimum value is
1
.
- Constraints: The minimum value is
- rotate
Keys This property is required. 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. - unit
This property is required. string - (String) The units for the secret rotation time interval.
- Constraints: Allowable values are:
day
,month
.
- Constraints: Allowable values are:
- auto_
rotate This property is required. bool - (Boolean) Determines whether Secrets Manager rotates your secret automatically.Default is
false
. Ifauto_rotate
is set totrue
the service rotates your secret based on the defined interval. - interval
This property is required. float - (Integer) The length of the secret rotation time interval.
- Constraints: The minimum value is
1
.
- Constraints: The minimum value is
- rotate_
keys This property is required. 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. - unit
This property is required. str - (String) The units for the secret rotation time interval.
- Constraints: Allowable values are:
day
,month
.
- Constraints: Allowable values are:
- auto
Rotate This property is required. Boolean - (Boolean) Determines whether Secrets Manager rotates your secret automatically.Default is
false
. Ifauto_rotate
is set totrue
the service rotates your secret based on the defined interval. - interval
This property is required. Number - (Integer) The length of the secret rotation time interval.
- Constraints: The minimum value is
1
.
- Constraints: The minimum value is
- rotate
Keys This property is required. 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. - unit
This property is required. String - (String) The units for the secret rotation time interval.
- Constraints: Allowable values are:
day
,month
.
- Constraints: Allowable values are:
GetSmSecretsSecretSourceService
- Iams
This property is required. List<GetSm Secrets Secret Source Service Iam> - (List) The source service IAM data is returned in case IAM credentials where created for this secret. Nested scheme for iam:
- Instances
This property is required. List<GetSm Secrets Secret Source Service Instance> - (List) The source service instance identifier. Nested scheme for instance:
- Parameters
This property is required. Dictionary<string, string> - (Map) The collection of parameters for the service credentials target.
- Resource
Keys This property is required. List<GetSm Secrets Secret Source Service Resource Key> - (List) The source service resource key data of the generated service credentials. Nested scheme for resource_key:
- Roles
This property is required. List<GetSm Secrets Secret Source Service Role> - (List) The service-specific custom role object. Nested scheme for role:
- Iams
This property is required. []GetSm Secrets Secret Source Service Iam - (List) The source service IAM data is returned in case IAM credentials where created for this secret. Nested scheme for iam:
- Instances
This property is required. []GetSm Secrets Secret Source Service Instance - (List) The source service instance identifier. Nested scheme for instance:
- Parameters
This property is required. map[string]string - (Map) The collection of parameters for the service credentials target.
- Resource
Keys This property is required. []GetSm Secrets Secret Source Service Resource Key - (List) The source service resource key data of the generated service credentials. Nested scheme for resource_key:
- Roles
This property is required. []GetSm Secrets Secret Source Service Role - (List) The service-specific custom role object. Nested scheme for role:
- iams
This property is required. List<GetSm Secrets Secret Source Service Iam> - (List) The source service IAM data is returned in case IAM credentials where created for this secret. Nested scheme for iam:
- instances
This property is required. List<GetSm Secrets Secret Source Service Instance> - (List) The source service instance identifier. Nested scheme for instance:
- parameters
This property is required. Map<String,String> - (Map) The collection of parameters for the service credentials target.
- resource
Keys This property is required. List<GetSm Secrets Secret Source Service Resource Key> - (List) The source service resource key data of the generated service credentials. Nested scheme for resource_key:
- roles
This property is required. List<GetSm Secrets Secret Source Service Role> - (List) The service-specific custom role object. Nested scheme for role:
- iams
This property is required. GetSm Secrets Secret Source Service Iam[] - (List) The source service IAM data is returned in case IAM credentials where created for this secret. Nested scheme for iam:
- instances
This property is required. GetSm Secrets Secret Source Service Instance[] - (List) The source service instance identifier. Nested scheme for instance:
- parameters
This property is required. {[key: string]: string} - (Map) The collection of parameters for the service credentials target.
- resource
Keys This property is required. GetSm Secrets Secret Source Service Resource Key[] - (List) The source service resource key data of the generated service credentials. Nested scheme for resource_key:
- roles
This property is required. GetSm Secrets Secret Source Service Role[] - (List) The service-specific custom role object. Nested scheme for role:
- iams
This property is required. Sequence[GetSm Secrets Secret Source Service Iam] - (List) The source service IAM data is returned in case IAM credentials where created for this secret. Nested scheme for iam:
- instances
This property is required. Sequence[GetSm Secrets Secret Source Service Instance] - (List) The source service instance identifier. Nested scheme for instance:
- parameters
This property is required. Mapping[str, str] - (Map) The collection of parameters for the service credentials target.
- resource_
keys This property is required. Sequence[GetSm Secrets Secret Source Service Resource Key] - (List) The source service resource key data of the generated service credentials. Nested scheme for resource_key:
- roles
This property is required. Sequence[GetSm Secrets Secret Source Service Role] - (List) The service-specific custom role object. Nested scheme for role:
- iams
This property is required. List<Property Map> - (List) The source service IAM data is returned in case IAM credentials where created for this secret. Nested scheme for iam:
- instances
This property is required. List<Property Map> - (List) The source service instance identifier. Nested scheme for instance:
- parameters
This property is required. Map<String> - (Map) The collection of parameters for the service credentials target.
- resource
Keys This property is required. List<Property Map> - (List) The source service resource key data of the generated service credentials. Nested scheme for resource_key:
- roles
This property is required. List<Property Map> - (List) The service-specific custom role object. Nested scheme for role:
GetSmSecretsSecretSourceServiceIam
- Apikeys
This property is required. List<GetSm Secrets Secret Source Service Iam Apikey> - (String) The IAM apikey metadata for the IAM credentials that were generated. Nested scheme for apikey:
- Roles
This property is required. List<GetSm Secrets Secret Source Service Iam Role> - (List) The service-specific custom role object. Nested scheme for role:
- Serviceids
This property is required. List<GetSm Secrets Secret Source Service Iam Serviceid> - (String) The IAM serviceid for the generated service credentials. Nested scheme for serviceid:
- Apikeys
This property is required. []GetSm Secrets Secret Source Service Iam Apikey - (String) The IAM apikey metadata for the IAM credentials that were generated. Nested scheme for apikey:
- Roles
This property is required. []GetSm Secrets Secret Source Service Iam Role - (List) The service-specific custom role object. Nested scheme for role:
- Serviceids
This property is required. []GetSm Secrets Secret Source Service Iam Serviceid - (String) The IAM serviceid for the generated service credentials. Nested scheme for serviceid:
- apikeys
This property is required. List<GetSm Secrets Secret Source Service Iam Apikey> - (String) The IAM apikey metadata for the IAM credentials that were generated. Nested scheme for apikey:
- roles
This property is required. List<GetSm Secrets Secret Source Service Iam Role> - (List) The service-specific custom role object. Nested scheme for role:
- serviceids
This property is required. List<GetSm Secrets Secret Source Service Iam Serviceid> - (String) The IAM serviceid for the generated service credentials. Nested scheme for serviceid:
- apikeys
This property is required. GetSm Secrets Secret Source Service Iam Apikey[] - (String) The IAM apikey metadata for the IAM credentials that were generated. Nested scheme for apikey:
- roles
This property is required. GetSm Secrets Secret Source Service Iam Role[] - (List) The service-specific custom role object. Nested scheme for role:
- serviceids
This property is required. GetSm Secrets Secret Source Service Iam Serviceid[] - (String) The IAM serviceid for the generated service credentials. Nested scheme for serviceid:
- apikeys
This property is required. Sequence[GetSm Secrets Secret Source Service Iam Apikey] - (String) The IAM apikey metadata for the IAM credentials that were generated. Nested scheme for apikey:
- roles
This property is required. Sequence[GetSm Secrets Secret Source Service Iam Role] - (List) The service-specific custom role object. Nested scheme for role:
- serviceids
This property is required. Sequence[GetSm Secrets Secret Source Service Iam Serviceid] - (String) The IAM serviceid for the generated service credentials. Nested scheme for serviceid:
- apikeys
This property is required. List<Property Map> - (String) The IAM apikey metadata for the IAM credentials that were generated. Nested scheme for apikey:
- roles
This property is required. List<Property Map> - (List) The service-specific custom role object. Nested scheme for role:
- serviceids
This property is required. List<Property Map> - (String) The IAM serviceid for the generated service credentials. Nested scheme for serviceid:
GetSmSecretsSecretSourceServiceIamApikey
- Description
This property is required. string - (String) The IAM API key description for the generated service credentials.
- Name
This property is required. string - (String) The resource key name of the generated service credentials.
- Description
This property is required. string - (String) The IAM API key description for the generated service credentials.
- Name
This property is required. string - (String) The resource key name of the generated service credentials.
- description
This property is required. String - (String) The IAM API key description for the generated service credentials.
- name
This property is required. String - (String) The resource key name of the generated service credentials.
- description
This property is required. string - (String) The IAM API key description for the generated service credentials.
- name
This property is required. string - (String) The resource key name of the generated service credentials.
- description
This property is required. str - (String) The IAM API key description for the generated service credentials.
- name
This property is required. str - (String) The resource key name of the generated service credentials.
- description
This property is required. String - (String) The IAM API key description for the generated service credentials.
- name
This property is required. String - (String) The resource key name of the generated service credentials.
GetSmSecretsSecretSourceServiceIamRole
- Crn
This property is required. string - (String) The CRN role identifier for creating a service-id.
- Crn
This property is required. string - (String) The CRN role identifier for creating a service-id.
- crn
This property is required. String - (String) The CRN role identifier for creating a service-id.
- crn
This property is required. string - (String) The CRN role identifier for creating a service-id.
- crn
This property is required. str - (String) The CRN role identifier for creating a service-id.
- crn
This property is required. String - (String) The CRN role identifier for creating a service-id.
GetSmSecretsSecretSourceServiceIamServiceid
- Crn
This property is required. string - (String) The CRN role identifier for creating a service-id.
- Crn
This property is required. string - (String) The CRN role identifier for creating a service-id.
- crn
This property is required. String - (String) The CRN role identifier for creating a service-id.
- crn
This property is required. string - (String) The CRN role identifier for creating a service-id.
- crn
This property is required. str - (String) The CRN role identifier for creating a service-id.
- crn
This property is required. String - (String) The CRN role identifier for creating a service-id.
GetSmSecretsSecretSourceServiceInstance
- Crn
This property is required. string - (String) The CRN role identifier for creating a service-id.
- Crn
This property is required. string - (String) The CRN role identifier for creating a service-id.
- crn
This property is required. String - (String) The CRN role identifier for creating a service-id.
- crn
This property is required. string - (String) The CRN role identifier for creating a service-id.
- crn
This property is required. str - (String) The CRN role identifier for creating a service-id.
- crn
This property is required. String - (String) The CRN role identifier for creating a service-id.
GetSmSecretsSecretSourceServiceResourceKey
GetSmSecretsSecretSourceServiceRole
- Crn
This property is required. string - (String) The CRN role identifier for creating a service-id.
- Crn
This property is required. string - (String) The CRN role identifier for creating a service-id.
- crn
This property is required. String - (String) The CRN role identifier for creating a service-id.
- crn
This property is required. string - (String) The CRN role identifier for creating a service-id.
- crn
This property is required. str - (String) The CRN role identifier for creating a service-id.
- crn
This property is required. String - (String) The CRN role identifier for creating a service-id.
GetSmSecretsSecretValidity
- not_
after This property is required. str - (String) The date-time format follows RFC 3339.
- not_
before This property is required. 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.