ibm 1.78.0 published on Wednesday, Apr 30, 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 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 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 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 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 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 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 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 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 stringId - (String) The ID of the API key that is generated for this secret.
- Bundle
Certs bool - (Boolean) Indicates whether the issued certificate is bundled with intermediate certificates.
- Ca string
- (String) The name that is assigned to the certificate authority configuration.
- string
- (String) The intermediate certificate authority that signed this certificate.
- Certificate
Template 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 string - (String) The Common Name (AKA CN) represents the server name protected by the SSL certificate.
- Constraints: The maximum length is
64
characters. The minimum length is4
characters. The value must match regular expression/^(\\*\\.)?(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])\\.?$/
.
- Constraints: The maximum length is
- Created
At string - (String) The date when a resource was created. The date format follows RFC 3339.
- Created
By string - (String) The unique identifier that is associated with the entity that created the secret.
- Constraints: The maximum length is
128
characters. The minimum length is4
characters.
- Constraints: The maximum length is
- Crn string
- (String) The CRN role identifier for creating a service-id.
- Custom
Metadata Dictionary<string, string> - (Map) The secret metadata that a user can customize.
- Description string
- (String) The IAM API key description for the generated service credentials.
- Dns string
- (String) The name that is assigned to the DNS provider configuration.
- Downloaded bool
- (Boolean) Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.
- Expiration
Date string - (String) The date a secret is expired. The date format follows RFC 3339.
- Id string
- (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 bool - (Boolean) Indicates whether the certificate was imported with an associated intermediate certificate.
- Issuance
Infos List<GetSm Secrets Secret Issuance Info> - (List) Issuance information that is associated with your certificate. Nested scheme for issuance_info:
- Issuer string
- (String) The distinguished name that identifies the entity that signed and issued the certificate.
- Constraints: The maximum length is
128
characters. The minimum length is2
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- Key
Algorithm string - (String) The identifier for the cryptographic algorithm used to generate the public key that is associated with the certificate.
- Constraints: The maximum length is
10
characters. The minimum length is2
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- Labels List<string>
- (List) Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.
- Constraints: The list items must match regular expression
/(.*?)/
. The maximum length is30
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- Locks
Total double - (Integer) The number of locks of the secret.
- Constraints: The maximum value is
1000
. The minimum value is0
.
- Constraints: The maximum value is
- Name string
- (String) The resource key name of the generated service credentials.
- Next
Rotation stringDate - (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 boolIncluded - (Boolean) Indicates whether the certificate was imported with an associated private key.
- Reuse
Api boolKey - Revocation
Time stringRfc3339 - (String) The date and time that the certificate was revoked. The date format follows RFC 3339.
- Revocation
Time doubleSeconds - (Integer) The timestamp of the certificate revocation.
- Rotations
List<Get
Sm Secrets Secret Rotation> - (List) Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:
- Secret
Group stringId - (String) A UUID identifier, or
default
secret group.- Constraints: The maximum length is
36
characters. The minimum length is7
characters. The value must match regular expression/^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|default)$/
.
- Constraints: The maximum length is
- Secret
Type string - (String) The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.
- Constraints: Allowable values are:
arbitrary
,imported_cert
,public_cert
,iam_credentials
,kv
,username_password
,private_cert
.
- Constraints: Allowable values are:
- Serial
Number string - (String) The unique serial number that was assigned to a certificate by the issuing certificate authority.
- Constraints: The maximum length is
64
characters. The minimum length is2
characters. The value must match regular expression/[^a-fA-F0-9]/
.
- Constraints: The maximum length is
- Service
Id 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 boolIs Static - (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 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 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 double
- (Integer) The secret state that is based on NIST SP 800-57. States are integers and correspond to the
Pre-activation = 0
,Active = 1
,Suspended = 2
,Deactivated = 3
, andDestroyed = 5
values.- Constraints: Allowable values are:
0
,1
,2
,3
,5
.
- Constraints: Allowable values are:
- State
Description string - (String) A text representation of the secret state.
- Constraints: Allowable values are:
pre_activation
,active
,suspended
,deactivated
,destroyed
.
- Constraints: Allowable values are:
- Ttl 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 string - (String) The date when a resource was recently modified. The date format follows RFC 3339.
- Validities
List<Get
Sm Secrets Secret Validity> - (List) The date and time that the certificate validity period begins and ends. Nested scheme for validity:
- Versions
Total double - (Integer) The number of versions of the secret.
- Constraints: The maximum value is
50
. The minimum value is0
.
- Constraints: The maximum value is
- Access
Groups []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 []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 stringId - (String) The ID of the API key that is generated for this secret.
- Bundle
Certs bool - (Boolean) Indicates whether the issued certificate is bundled with intermediate certificates.
- Ca string
- (String) The name that is assigned to the certificate authority configuration.
- string
- (String) The intermediate certificate authority that signed this certificate.
- Certificate
Template 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 string - (String) The Common Name (AKA CN) represents the server name protected by the SSL certificate.
- Constraints: The maximum length is
64
characters. The minimum length is4
characters. The value must match regular expression/^(\\*\\.)?(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])\\.?$/
.
- Constraints: The maximum length is
- Created
At string - (String) The date when a resource was created. The date format follows RFC 3339.
- Created
By string - (String) The unique identifier that is associated with the entity that created the secret.
- Constraints: The maximum length is
128
characters. The minimum length is4
characters.
- Constraints: The maximum length is
- Crn string
- (String) The CRN role identifier for creating a service-id.
- Custom
Metadata map[string]string - (Map) The secret metadata that a user can customize.
- Description string
- (String) The IAM API key description for the generated service credentials.
- Dns string
- (String) The name that is assigned to the DNS provider configuration.
- Downloaded bool
- (Boolean) Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.
- Expiration
Date string - (String) The date a secret is expired. The date format follows RFC 3339.
- Id string
- (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 bool - (Boolean) Indicates whether the certificate was imported with an associated intermediate certificate.
- Issuance
Infos []GetSm Secrets Secret Issuance Info - (List) Issuance information that is associated with your certificate. Nested scheme for issuance_info:
- Issuer string
- (String) The distinguished name that identifies the entity that signed and issued the certificate.
- Constraints: The maximum length is
128
characters. The minimum length is2
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- Key
Algorithm string - (String) The identifier for the cryptographic algorithm used to generate the public key that is associated with the certificate.
- Constraints: The maximum length is
10
characters. The minimum length is2
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- Labels []string
- (List) Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.
- Constraints: The list items must match regular expression
/(.*?)/
. The maximum length is30
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- Locks
Total float64 - (Integer) The number of locks of the secret.
- Constraints: The maximum value is
1000
. The minimum value is0
.
- Constraints: The maximum value is
- Name string
- (String) The resource key name of the generated service credentials.
- Next
Rotation stringDate - (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 boolIncluded - (Boolean) Indicates whether the certificate was imported with an associated private key.
- Reuse
Api boolKey - Revocation
Time stringRfc3339 - (String) The date and time that the certificate was revoked. The date format follows RFC 3339.
- Revocation
Time float64Seconds - (Integer) The timestamp of the certificate revocation.
- Rotations
[]Get
Sm Secrets Secret Rotation - (List) Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:
- Secret
Group stringId - (String) A UUID identifier, or
default
secret group.- Constraints: The maximum length is
36
characters. The minimum length is7
characters. The value must match regular expression/^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|default)$/
.
- Constraints: The maximum length is
- Secret
Type string - (String) The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.
- Constraints: Allowable values are:
arbitrary
,imported_cert
,public_cert
,iam_credentials
,kv
,username_password
,private_cert
.
- Constraints: Allowable values are:
- Serial
Number string - (String) The unique serial number that was assigned to a certificate by the issuing certificate authority.
- Constraints: The maximum length is
64
characters. The minimum length is2
characters. The value must match regular expression/[^a-fA-F0-9]/
.
- Constraints: The maximum length is
- Service
Id 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 boolIs Static - (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 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 []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 float64
- (Integer) The secret state that is based on NIST SP 800-57. States are integers and correspond to the
Pre-activation = 0
,Active = 1
,Suspended = 2
,Deactivated = 3
, andDestroyed = 5
values.- Constraints: Allowable values are:
0
,1
,2
,3
,5
.
- Constraints: Allowable values are:
- State
Description string - (String) A text representation of the secret state.
- Constraints: Allowable values are:
pre_activation
,active
,suspended
,deactivated
,destroyed
.
- Constraints: Allowable values are:
- Ttl 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 string - (String) The date when a resource was recently modified. The date format follows RFC 3339.
- Validities
[]Get
Sm Secrets Secret Validity - (List) The date and time that the certificate validity period begins and ends. Nested scheme for validity:
- Versions
Total float64 - (Integer) The number of versions of the secret.
- Constraints: The maximum value is
50
. The minimum value is0
.
- Constraints: The maximum value is
- access
Groups 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 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 StringId - (String) The ID of the API key that is generated for this secret.
- bundle
Certs Boolean - (Boolean) Indicates whether the issued certificate is bundled with intermediate certificates.
- ca String
- (String) The name that is assigned to the certificate authority configuration.
- String
- (String) The intermediate certificate authority that signed this certificate.
- certificate
Template 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 String - (String) The Common Name (AKA CN) represents the server name protected by the SSL certificate.
- Constraints: The maximum length is
64
characters. The minimum length is4
characters. The value must match regular expression/^(\\*\\.)?(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])\\.?$/
.
- Constraints: The maximum length is
- created
At String - (String) The date when a resource was created. The date format follows RFC 3339.
- created
By String - (String) The unique identifier that is associated with the entity that created the secret.
- Constraints: The maximum length is
128
characters. The minimum length is4
characters.
- Constraints: The maximum length is
- crn String
- (String) The CRN role identifier for creating a service-id.
- custom
Metadata Map<String,String> - (Map) The secret metadata that a user can customize.
- description String
- (String) The IAM API key description for the generated service credentials.
- dns String
- (String) The name that is assigned to the DNS provider configuration.
- downloaded Boolean
- (Boolean) Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.
- expiration
Date String - (String) The date a secret is expired. The date format follows RFC 3339.
- id String
- (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 Boolean - (Boolean) Indicates whether the certificate was imported with an associated intermediate certificate.
- issuance
Infos List<GetSm Secrets Secret Issuance Info> - (List) Issuance information that is associated with your certificate. Nested scheme for issuance_info:
- issuer String
- (String) The distinguished name that identifies the entity that signed and issued the certificate.
- Constraints: The maximum length is
128
characters. The minimum length is2
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- key
Algorithm String - (String) The identifier for the cryptographic algorithm used to generate the public key that is associated with the certificate.
- Constraints: The maximum length is
10
characters. The minimum length is2
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- labels List<String>
- (List) Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.
- Constraints: The list items must match regular expression
/(.*?)/
. The maximum length is30
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- locks
Total Double - (Integer) The number of locks of the secret.
- Constraints: The maximum value is
1000
. The minimum value is0
.
- Constraints: The maximum value is
- name String
- (String) The resource key name of the generated service credentials.
- next
Rotation StringDate - (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 BooleanIncluded - (Boolean) Indicates whether the certificate was imported with an associated private key.
- reuse
Api BooleanKey - revocation
Time StringRfc3339 - (String) The date and time that the certificate was revoked. The date format follows RFC 3339.
- revocation
Time DoubleSeconds - (Integer) The timestamp of the certificate revocation.
- rotations
List<Get
Sm Secrets Secret Rotation> - (List) Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:
- secret
Group StringId - (String) A UUID identifier, or
default
secret group.- Constraints: The maximum length is
36
characters. The minimum length is7
characters. The value must match regular expression/^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|default)$/
.
- Constraints: The maximum length is
- secret
Type String - (String) The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.
- Constraints: Allowable values are:
arbitrary
,imported_cert
,public_cert
,iam_credentials
,kv
,username_password
,private_cert
.
- Constraints: Allowable values are:
- serial
Number String - (String) The unique serial number that was assigned to a certificate by the issuing certificate authority.
- Constraints: The maximum length is
64
characters. The minimum length is2
characters. The value must match regular expression/[^a-fA-F0-9]/
.
- Constraints: The maximum length is
- service
Id 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 BooleanIs Static - (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 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 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 Double
- (Integer) The secret state that is based on NIST SP 800-57. States are integers and correspond to the
Pre-activation = 0
,Active = 1
,Suspended = 2
,Deactivated = 3
, andDestroyed = 5
values.- Constraints: Allowable values are:
0
,1
,2
,3
,5
.
- Constraints: Allowable values are:
- state
Description String - (String) A text representation of the secret state.
- Constraints: Allowable values are:
pre_activation
,active
,suspended
,deactivated
,destroyed
.
- Constraints: Allowable values are:
- ttl 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 String - (String) The date when a resource was recently modified. The date format follows RFC 3339.
- validities
List<Get
Sm Secrets Secret Validity> - (List) The date and time that the certificate validity period begins and ends. Nested scheme for validity:
- versions
Total Double - (Integer) The number of versions of the secret.
- Constraints: The maximum value is
50
. The minimum value is0
.
- Constraints: The maximum value is
- access
Groups 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 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 stringId - (String) The ID of the API key that is generated for this secret.
- bundle
Certs boolean - (Boolean) Indicates whether the issued certificate is bundled with intermediate certificates.
- ca string
- (String) The name that is assigned to the certificate authority configuration.
- string
- (String) The intermediate certificate authority that signed this certificate.
- certificate
Template 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 string - (String) The Common Name (AKA CN) represents the server name protected by the SSL certificate.
- Constraints: The maximum length is
64
characters. The minimum length is4
characters. The value must match regular expression/^(\\*\\.)?(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])\\.?$/
.
- Constraints: The maximum length is
- created
At string - (String) The date when a resource was created. The date format follows RFC 3339.
- created
By string - (String) The unique identifier that is associated with the entity that created the secret.
- Constraints: The maximum length is
128
characters. The minimum length is4
characters.
- Constraints: The maximum length is
- crn string
- (String) The CRN role identifier for creating a service-id.
- custom
Metadata {[key: string]: string} - (Map) The secret metadata that a user can customize.
- description string
- (String) The IAM API key description for the generated service credentials.
- dns string
- (String) The name that is assigned to the DNS provider configuration.
- downloaded boolean
- (Boolean) Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.
- expiration
Date string - (String) The date a secret is expired. The date format follows RFC 3339.
- id string
- (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 boolean - (Boolean) Indicates whether the certificate was imported with an associated intermediate certificate.
- issuance
Infos GetSm Secrets Secret Issuance Info[] - (List) Issuance information that is associated with your certificate. Nested scheme for issuance_info:
- issuer string
- (String) The distinguished name that identifies the entity that signed and issued the certificate.
- Constraints: The maximum length is
128
characters. The minimum length is2
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- key
Algorithm string - (String) The identifier for the cryptographic algorithm used to generate the public key that is associated with the certificate.
- Constraints: The maximum length is
10
characters. The minimum length is2
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- labels string[]
- (List) Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.
- Constraints: The list items must match regular expression
/(.*?)/
. The maximum length is30
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- locks
Total number - (Integer) The number of locks of the secret.
- Constraints: The maximum value is
1000
. The minimum value is0
.
- Constraints: The maximum value is
- name string
- (String) The resource key name of the generated service credentials.
- next
Rotation stringDate - (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 booleanIncluded - (Boolean) Indicates whether the certificate was imported with an associated private key.
- reuse
Api booleanKey - revocation
Time stringRfc3339 - (String) The date and time that the certificate was revoked. The date format follows RFC 3339.
- revocation
Time numberSeconds - (Integer) The timestamp of the certificate revocation.
- rotations
Get
Sm Secrets Secret Rotation[] - (List) Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:
- secret
Group stringId - (String) A UUID identifier, or
default
secret group.- Constraints: The maximum length is
36
characters. The minimum length is7
characters. The value must match regular expression/^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|default)$/
.
- Constraints: The maximum length is
- secret
Type string - (String) The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.
- Constraints: Allowable values are:
arbitrary
,imported_cert
,public_cert
,iam_credentials
,kv
,username_password
,private_cert
.
- Constraints: Allowable values are:
- serial
Number string - (String) The unique serial number that was assigned to a certificate by the issuing certificate authority.
- Constraints: The maximum length is
64
characters. The minimum length is2
characters. The value must match regular expression/[^a-fA-F0-9]/
.
- Constraints: The maximum length is
- service
Id 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 booleanIs Static - (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 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 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 number
- (Integer) The secret state that is based on NIST SP 800-57. States are integers and correspond to the
Pre-activation = 0
,Active = 1
,Suspended = 2
,Deactivated = 3
, andDestroyed = 5
values.- Constraints: Allowable values are:
0
,1
,2
,3
,5
.
- Constraints: Allowable values are:
- state
Description string - (String) A text representation of the secret state.
- Constraints: Allowable values are:
pre_activation
,active
,suspended
,deactivated
,destroyed
.
- Constraints: Allowable values are:
- ttl 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 string - (String) The date when a resource was recently modified. The date format follows RFC 3339.
- validities
Get
Sm Secrets Secret Validity[] - (List) The date and time that the certificate validity period begins and ends. Nested scheme for validity:
- versions
Total number - (Integer) The number of versions of the secret.
- Constraints: The maximum value is
50
. The minimum value is0
.
- Constraints: The maximum value is
- access_
groups 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 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_ strid - (String) The ID of the API key that is generated for this secret.
- bundle_
certs bool - (Boolean) Indicates whether the issued certificate is bundled with intermediate certificates.
- ca str
- (String) The name that is assigned to the certificate authority configuration.
- str
- (String) The intermediate certificate authority that signed this certificate.
- certificate_
template 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 str - (String) The Common Name (AKA CN) represents the server name protected by the SSL certificate.
- Constraints: The maximum length is
64
characters. The minimum length is4
characters. The value must match regular expression/^(\\*\\.)?(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])\\.?$/
.
- Constraints: The maximum length is
- created_
at str - (String) The date when a resource was created. The date format follows RFC 3339.
- created_
by str - (String) The unique identifier that is associated with the entity that created the secret.
- Constraints: The maximum length is
128
characters. The minimum length is4
characters.
- Constraints: The maximum length is
- crn str
- (String) The CRN role identifier for creating a service-id.
- custom_
metadata Mapping[str, str] - (Map) The secret metadata that a user can customize.
- description str
- (String) The IAM API key description for the generated service credentials.
- dns str
- (String) The name that is assigned to the DNS provider configuration.
- downloaded bool
- (Boolean) Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.
- expiration_
date str - (String) The date a secret is expired. The date format follows RFC 3339.
- id str
- (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 bool - (Boolean) Indicates whether the certificate was imported with an associated intermediate certificate.
- issuance_
infos Sequence[GetSm Secrets Secret Issuance Info] - (List) Issuance information that is associated with your certificate. Nested scheme for issuance_info:
- issuer str
- (String) The distinguished name that identifies the entity that signed and issued the certificate.
- Constraints: The maximum length is
128
characters. The minimum length is2
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- key_
algorithm str - (String) The identifier for the cryptographic algorithm used to generate the public key that is associated with the certificate.
- Constraints: The maximum length is
10
characters. The minimum length is2
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- labels Sequence[str]
- (List) Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.
- Constraints: The list items must match regular expression
/(.*?)/
. The maximum length is30
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- locks_
total float - (Integer) The number of locks of the secret.
- Constraints: The maximum value is
1000
. The minimum value is0
.
- Constraints: The maximum value is
- name str
- (String) The resource key name of the generated service credentials.
- next_
rotation_ strdate - (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_ boolincluded - (Boolean) Indicates whether the certificate was imported with an associated private key.
- reuse_
api_ boolkey - revocation_
time_ strrfc3339 - (String) The date and time that the certificate was revoked. The date format follows RFC 3339.
- revocation_
time_ floatseconds - (Integer) The timestamp of the certificate revocation.
- rotations
Sequence[Get
Sm Secrets Secret Rotation] - (List) Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:
- secret_
group_ strid - (String) A UUID identifier, or
default
secret group.- Constraints: The maximum length is
36
characters. The minimum length is7
characters. The value must match regular expression/^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|default)$/
.
- Constraints: The maximum length is
- secret_
type str - (String) The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.
- Constraints: Allowable values are:
arbitrary
,imported_cert
,public_cert
,iam_credentials
,kv
,username_password
,private_cert
.
- Constraints: Allowable values are:
- serial_
number str - (String) The unique serial number that was assigned to a certificate by the issuing certificate authority.
- Constraints: The maximum length is
64
characters. The minimum length is2
characters. The value must match regular expression/[^a-fA-F0-9]/
.
- Constraints: The maximum length is
- service_
id 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_ boolis_ static - (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 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 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 float
- (Integer) The secret state that is based on NIST SP 800-57. States are integers and correspond to the
Pre-activation = 0
,Active = 1
,Suspended = 2
,Deactivated = 3
, andDestroyed = 5
values.- Constraints: Allowable values are:
0
,1
,2
,3
,5
.
- Constraints: Allowable values are:
- state_
description str - (String) A text representation of the secret state.
- Constraints: Allowable values are:
pre_activation
,active
,suspended
,deactivated
,destroyed
.
- Constraints: Allowable values are:
- ttl 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 str - (String) The date when a resource was recently modified. The date format follows RFC 3339.
- validities
Sequence[Get
Sm Secrets Secret Validity] - (List) The date and time that the certificate validity period begins and ends. Nested scheme for validity:
- versions_
total float - (Integer) The number of versions of the secret.
- Constraints: The maximum value is
50
. The minimum value is0
.
- Constraints: The maximum value is
- access
Groups 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 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 StringId - (String) The ID of the API key that is generated for this secret.
- bundle
Certs Boolean - (Boolean) Indicates whether the issued certificate is bundled with intermediate certificates.
- ca String
- (String) The name that is assigned to the certificate authority configuration.
- String
- (String) The intermediate certificate authority that signed this certificate.
- certificate
Template 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 String - (String) The Common Name (AKA CN) represents the server name protected by the SSL certificate.
- Constraints: The maximum length is
64
characters. The minimum length is4
characters. The value must match regular expression/^(\\*\\.)?(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])\\.?$/
.
- Constraints: The maximum length is
- created
At String - (String) The date when a resource was created. The date format follows RFC 3339.
- created
By String - (String) The unique identifier that is associated with the entity that created the secret.
- Constraints: The maximum length is
128
characters. The minimum length is4
characters.
- Constraints: The maximum length is
- crn String
- (String) The CRN role identifier for creating a service-id.
- custom
Metadata Map<String> - (Map) The secret metadata that a user can customize.
- description String
- (String) The IAM API key description for the generated service credentials.
- dns String
- (String) The name that is assigned to the DNS provider configuration.
- downloaded Boolean
- (Boolean) Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.
- expiration
Date String - (String) The date a secret is expired. The date format follows RFC 3339.
- id String
- (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 Boolean - (Boolean) Indicates whether the certificate was imported with an associated intermediate certificate.
- issuance
Infos List<Property Map> - (List) Issuance information that is associated with your certificate. Nested scheme for issuance_info:
- issuer String
- (String) The distinguished name that identifies the entity that signed and issued the certificate.
- Constraints: The maximum length is
128
characters. The minimum length is2
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- key
Algorithm String - (String) The identifier for the cryptographic algorithm used to generate the public key that is associated with the certificate.
- Constraints: The maximum length is
10
characters. The minimum length is2
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- labels List<String>
- (List) Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.
- Constraints: The list items must match regular expression
/(.*?)/
. The maximum length is30
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- locks
Total Number - (Integer) The number of locks of the secret.
- Constraints: The maximum value is
1000
. The minimum value is0
.
- Constraints: The maximum value is
- name String
- (String) The resource key name of the generated service credentials.
- next
Rotation StringDate - (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 BooleanIncluded - (Boolean) Indicates whether the certificate was imported with an associated private key.
- reuse
Api BooleanKey - revocation
Time StringRfc3339 - (String) The date and time that the certificate was revoked. The date format follows RFC 3339.
- revocation
Time NumberSeconds - (Integer) The timestamp of the certificate revocation.
- rotations List<Property Map>
- (List) Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:
- secret
Group StringId - (String) A UUID identifier, or
default
secret group.- Constraints: The maximum length is
36
characters. The minimum length is7
characters. The value must match regular expression/^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|default)$/
.
- Constraints: The maximum length is
- secret
Type String - (String) The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.
- Constraints: Allowable values are:
arbitrary
,imported_cert
,public_cert
,iam_credentials
,kv
,username_password
,private_cert
.
- Constraints: Allowable values are:
- serial
Number String - (String) The unique serial number that was assigned to a certificate by the issuing certificate authority.
- Constraints: The maximum length is
64
characters. The minimum length is2
characters. The value must match regular expression/[^a-fA-F0-9]/
.
- Constraints: The maximum length is
- service
Id 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 BooleanIs Static - (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 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 List<Property Map> - (List) The properties required for creating the service credentials for the specified source service instance. Nested scheme for source_service:
- state Number
- (Integer) The secret state that is based on NIST SP 800-57. States are integers and correspond to the
Pre-activation = 0
,Active = 1
,Suspended = 2
,Deactivated = 3
, andDestroyed = 5
values.- Constraints: Allowable values are:
0
,1
,2
,3
,5
.
- Constraints: Allowable values are:
- state
Description String - (String) A text representation of the secret state.
- Constraints: Allowable values are:
pre_activation
,active
,suspended
,deactivated
,destroyed
.
- Constraints: Allowable values are:
- ttl 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 String - (String) The date when a resource was recently modified. The date format follows RFC 3339.
- validities List<Property Map>
- (List) The date and time that the certificate validity period begins and ends. Nested scheme for validity:
- versions
Total Number - (Integer) The number of versions of the secret.
- Constraints: The maximum value is
50
. The minimum value is0
.
- Constraints: The maximum value is
GetSmSecretsSecretIssuanceInfo
- Auto
Rotated bool - (Boolean) Indicates whether the issued certificate is configured with an automatic rotation policy.
- Challenges
List<Get
Sm 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 stringValidation Time - (String) The date that a user requests to validate DNS challenges for certificates that are ordered with a manual DNS provider. The date format follows RFC 3339.
- Error
Code string - (String) A code that identifies an issuance error.This field, along with
error_message
, is returned when Secrets Manager successfully processes your request, but the certificate authority is unable to issue a certificate. - Error
Message string - (String) A human-readable message that provides details about the issuance error.
- Ordered
On string - (String) The date when the certificate is ordered. The date format follows RFC 3339.
- State double
- (Integer) The secret state that is based on NIST SP 800-57. States are integers and correspond to the
Pre-activation = 0
,Active = 1
,Suspended = 2
,Deactivated = 3
, andDestroyed = 5
values.- Constraints: Allowable values are:
0
,1
,2
,3
,5
.
- Constraints: Allowable values are:
- State
Description string - (String) A text representation of the secret state.
- Constraints: Allowable values are:
pre_activation
,active
,suspended
,deactivated
,destroyed
.
- Constraints: Allowable values are:
- Auto
Rotated bool - (Boolean) Indicates whether the issued certificate is configured with an automatic rotation policy.
- Challenges
[]Get
Sm 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 stringValidation Time - (String) The date that a user requests to validate DNS challenges for certificates that are ordered with a manual DNS provider. The date format follows RFC 3339.
- Error
Code string - (String) A code that identifies an issuance error.This field, along with
error_message
, is returned when Secrets Manager successfully processes your request, but the certificate authority is unable to issue a certificate. - Error
Message string - (String) A human-readable message that provides details about the issuance error.
- Ordered
On string - (String) The date when the certificate is ordered. The date format follows RFC 3339.
- State float64
- (Integer) The secret state that is based on NIST SP 800-57. States are integers and correspond to the
Pre-activation = 0
,Active = 1
,Suspended = 2
,Deactivated = 3
, andDestroyed = 5
values.- Constraints: Allowable values are:
0
,1
,2
,3
,5
.
- Constraints: Allowable values are:
- State
Description string - (String) A text representation of the secret state.
- Constraints: Allowable values are:
pre_activation
,active
,suspended
,deactivated
,destroyed
.
- Constraints: Allowable values are:
- auto
Rotated Boolean - (Boolean) Indicates whether the issued certificate is configured with an automatic rotation policy.
- challenges
List<Get
Sm 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 StringValidation Time - (String) The date that a user requests to validate DNS challenges for certificates that are ordered with a manual DNS provider. The date format follows RFC 3339.
- error
Code String - (String) A code that identifies an issuance error.This field, along with
error_message
, is returned when Secrets Manager successfully processes your request, but the certificate authority is unable to issue a certificate. - error
Message String - (String) A human-readable message that provides details about the issuance error.
- ordered
On String - (String) The date when the certificate is ordered. The date format follows RFC 3339.
- state Double
- (Integer) The secret state that is based on NIST SP 800-57. States are integers and correspond to the
Pre-activation = 0
,Active = 1
,Suspended = 2
,Deactivated = 3
, andDestroyed = 5
values.- Constraints: Allowable values are:
0
,1
,2
,3
,5
.
- Constraints: Allowable values are:
- state
Description String - (String) A text representation of the secret state.
- Constraints: Allowable values are:
pre_activation
,active
,suspended
,deactivated
,destroyed
.
- Constraints: Allowable values are:
- auto
Rotated boolean - (Boolean) Indicates whether the issued certificate is configured with an automatic rotation policy.
- challenges
Get
Sm 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 stringValidation Time - (String) The date that a user requests to validate DNS challenges for certificates that are ordered with a manual DNS provider. The date format follows RFC 3339.
- error
Code string - (String) A code that identifies an issuance error.This field, along with
error_message
, is returned when Secrets Manager successfully processes your request, but the certificate authority is unable to issue a certificate. - error
Message string - (String) A human-readable message that provides details about the issuance error.
- ordered
On string - (String) The date when the certificate is ordered. The date format follows RFC 3339.
- state number
- (Integer) The secret state that is based on NIST SP 800-57. States are integers and correspond to the
Pre-activation = 0
,Active = 1
,Suspended = 2
,Deactivated = 3
, andDestroyed = 5
values.- Constraints: Allowable values are:
0
,1
,2
,3
,5
.
- Constraints: Allowable values are:
- state
Description string - (String) A text representation of the secret state.
- Constraints: Allowable values are:
pre_activation
,active
,suspended
,deactivated
,destroyed
.
- Constraints: Allowable values are:
- auto_
rotated bool - (Boolean) Indicates whether the issued certificate is configured with an automatic rotation policy.
- challenges
Sequence[Get
Sm 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_ strvalidation_ time - (String) The date that a user requests to validate DNS challenges for certificates that are ordered with a manual DNS provider. The date format follows RFC 3339.
- error_
code str - (String) A code that identifies an issuance error.This field, along with
error_message
, is returned when Secrets Manager successfully processes your request, but the certificate authority is unable to issue a certificate. - error_
message str - (String) A human-readable message that provides details about the issuance error.
- ordered_
on str - (String) The date when the certificate is ordered. The date format follows RFC 3339.
- state float
- (Integer) The secret state that is based on NIST SP 800-57. States are integers and correspond to the
Pre-activation = 0
,Active = 1
,Suspended = 2
,Deactivated = 3
, andDestroyed = 5
values.- Constraints: Allowable values are:
0
,1
,2
,3
,5
.
- Constraints: Allowable values are:
- state_
description str - (String) A text representation of the secret state.
- Constraints: Allowable values are:
pre_activation
,active
,suspended
,deactivated
,destroyed
.
- Constraints: Allowable values are:
- auto
Rotated Boolean - (Boolean) Indicates whether the issued certificate is configured with an automatic rotation policy.
- challenges List<Property Map>
- (List) The set of challenges. It is returned only when ordering public certificates by using manual DNS configuration.
- Constraints: The maximum length is
100
items. The minimum length is1
item. Nested scheme for challenges:
- Constraints: The maximum length is
- dns
Challenge StringValidation Time - (String) The date that a user requests to validate DNS challenges for certificates that are ordered with a manual DNS provider. The date format follows RFC 3339.
- error
Code String - (String) A code that identifies an issuance error.This field, along with
error_message
, is returned when Secrets Manager successfully processes your request, but the certificate authority is unable to issue a certificate. - error
Message String - (String) A human-readable message that provides details about the issuance error.
- ordered
On String - (String) The date when the certificate is ordered. The date format follows RFC 3339.
- state Number
- (Integer) The secret state that is based on NIST SP 800-57. States are integers and correspond to the
Pre-activation = 0
,Active = 1
,Suspended = 2
,Deactivated = 3
, andDestroyed = 5
values.- Constraints: Allowable values are:
0
,1
,2
,3
,5
.
- Constraints: Allowable values are:
- state
Description String - (String) A text representation of the secret state.
- Constraints: Allowable values are:
pre_activation
,active
,suspended
,deactivated
,destroyed
.
- Constraints: Allowable values are:
GetSmSecretsSecretIssuanceInfoChallenge
- Domain string
- (String) The challenge domain.
- Expiration string
- (String) The challenge expiration date. The date format follows RFC 3339.
- Status string
- (String) The challenge status.
- Txt
Record stringName - (String) The TXT record name.
- Txt
Record stringValue - (String) The TXT record value.
- Domain string
- (String) The challenge domain.
- Expiration string
- (String) The challenge expiration date. The date format follows RFC 3339.
- Status string
- (String) The challenge status.
- Txt
Record stringName - (String) The TXT record name.
- Txt
Record stringValue - (String) The TXT record value.
- domain String
- (String) The challenge domain.
- expiration String
- (String) The challenge expiration date. The date format follows RFC 3339.
- status String
- (String) The challenge status.
- txt
Record StringName - (String) The TXT record name.
- txt
Record StringValue - (String) The TXT record value.
- domain string
- (String) The challenge domain.
- expiration string
- (String) The challenge expiration date. The date format follows RFC 3339.
- status string
- (String) The challenge status.
- txt
Record stringName - (String) The TXT record name.
- txt
Record stringValue - (String) The TXT record value.
- domain str
- (String) The challenge domain.
- expiration str
- (String) The challenge expiration date. The date format follows RFC 3339.
- status str
- (String) The challenge status.
- txt_
record_ strname - (String) The TXT record name.
- txt_
record_ strvalue - (String) The TXT record value.
- domain String
- (String) The challenge domain.
- expiration String
- (String) The challenge expiration date. The date format follows RFC 3339.
- status String
- (String) The challenge status.
- txt
Record StringName - (String) The TXT record name.
- txt
Record StringValue - (String) The TXT record value.
GetSmSecretsSecretRotation
- Auto
Rotate 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 double
- (Integer) The length of the secret rotation time interval.
- Constraints: The minimum value is
1
.
- Constraints: The minimum value is
- Rotate
Keys bool - (Boolean) Determines whether Secrets Manager rotates the private key for your public certificate automatically.Default is
false
. If it is set totrue
, the service generates and stores a new private key for your rotated certificate. - Unit string
- (String) The units for the secret rotation time interval.
- Constraints: Allowable values are:
day
,month
.
- Constraints: Allowable values are:
- Auto
Rotate 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 float64
- (Integer) The length of the secret rotation time interval.
- Constraints: The minimum value is
1
.
- Constraints: The minimum value is
- Rotate
Keys bool - (Boolean) Determines whether Secrets Manager rotates the private key for your public certificate automatically.Default is
false
. If it is set totrue
, the service generates and stores a new private key for your rotated certificate. - Unit string
- (String) The units for the secret rotation time interval.
- Constraints: Allowable values are:
day
,month
.
- Constraints: Allowable values are:
- auto
Rotate 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 Double
- (Integer) The length of the secret rotation time interval.
- Constraints: The minimum value is
1
.
- Constraints: The minimum value is
- rotate
Keys Boolean - (Boolean) Determines whether Secrets Manager rotates the private key for your public certificate automatically.Default is
false
. If it is set totrue
, the service generates and stores a new private key for your rotated certificate. - unit String
- (String) The units for the secret rotation time interval.
- Constraints: Allowable values are:
day
,month
.
- Constraints: Allowable values are:
- auto
Rotate 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 number
- (Integer) The length of the secret rotation time interval.
- Constraints: The minimum value is
1
.
- Constraints: The minimum value is
- rotate
Keys boolean - (Boolean) Determines whether Secrets Manager rotates the private key for your public certificate automatically.Default is
false
. If it is set totrue
, the service generates and stores a new private key for your rotated certificate. - unit string
- (String) The units for the secret rotation time interval.
- Constraints: Allowable values are:
day
,month
.
- Constraints: Allowable values are:
- auto_
rotate 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 float
- (Integer) The length of the secret rotation time interval.
- Constraints: The minimum value is
1
.
- Constraints: The minimum value is
- rotate_
keys bool - (Boolean) Determines whether Secrets Manager rotates the private key for your public certificate automatically.Default is
false
. If it is set totrue
, the service generates and stores a new private key for your rotated certificate. - unit str
- (String) The units for the secret rotation time interval.
- Constraints: Allowable values are:
day
,month
.
- Constraints: Allowable values are:
- auto
Rotate 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 Number
- (Integer) The length of the secret rotation time interval.
- Constraints: The minimum value is
1
.
- Constraints: The minimum value is
- rotate
Keys Boolean - (Boolean) Determines whether Secrets Manager rotates the private key for your public certificate automatically.Default is
false
. If it is set totrue
, the service generates and stores a new private key for your rotated certificate. - unit String
- (String) The units for the secret rotation time interval.
- Constraints: Allowable values are:
day
,month
.
- Constraints: Allowable values are:
GetSmSecretsSecretSourceService
- Iams
List<Get
Sm 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
List<Get
Sm Secrets Secret Source Service Instance> - (List) The source service instance identifier. Nested scheme for instance:
- Parameters Dictionary<string, string>
- (Map) The collection of parameters for the service credentials target.
- Resource
Keys 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
List<Get
Sm Secrets Secret Source Service Role> - (List) The service-specific custom role object. Nested scheme for role:
- Iams
[]Get
Sm 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
[]Get
Sm Secrets Secret Source Service Instance - (List) The source service instance identifier. Nested scheme for instance:
- Parameters map[string]string
- (Map) The collection of parameters for the service credentials target.
- Resource
Keys []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
[]Get
Sm Secrets Secret Source Service Role - (List) The service-specific custom role object. Nested scheme for role:
- iams
List<Get
Sm 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
List<Get
Sm Secrets Secret Source Service Instance> - (List) The source service instance identifier. Nested scheme for instance:
- parameters Map<String,String>
- (Map) The collection of parameters for the service credentials target.
- resource
Keys 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
List<Get
Sm Secrets Secret Source Service Role> - (List) The service-specific custom role object. Nested scheme for role:
- iams
Get
Sm 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
Get
Sm Secrets Secret Source Service Instance[] - (List) The source service instance identifier. Nested scheme for instance:
- parameters {[key: string]: string}
- (Map) The collection of parameters for the service credentials target.
- resource
Keys 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
Get
Sm Secrets Secret Source Service Role[] - (List) The service-specific custom role object. Nested scheme for role:
- iams
Sequence[Get
Sm 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
Sequence[Get
Sm Secrets Secret Source Service Instance] - (List) The source service instance identifier. Nested scheme for instance:
- parameters Mapping[str, str]
- (Map) The collection of parameters for the service credentials target.
- resource_
keys 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
Sequence[Get
Sm Secrets Secret Source Service Role] - (List) The service-specific custom role object. Nested scheme for role:
- iams 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 List<Property Map>
- (List) The source service instance identifier. Nested scheme for instance:
- parameters Map<String>
- (Map) The collection of parameters for the service credentials target.
- resource
Keys List<Property Map> - (List) The source service resource key data of the generated service credentials. Nested scheme for resource_key:
- roles List<Property Map>
- (List) The service-specific custom role object. Nested scheme for role:
GetSmSecretsSecretSourceServiceIam
- Apikeys
List<Get
Sm Secrets Secret Source Service Iam Apikey> - (String) The IAM apikey metadata for the IAM credentials that were generated. Nested scheme for apikey:
- Roles
List<Get
Sm Secrets Secret Source Service Iam Role> - (List) The service-specific custom role object. Nested scheme for role:
- Serviceids
List<Get
Sm Secrets Secret Source Service Iam Serviceid> - (String) The IAM serviceid for the generated service credentials. Nested scheme for serviceid:
- Apikeys
[]Get
Sm Secrets Secret Source Service Iam Apikey - (String) The IAM apikey metadata for the IAM credentials that were generated. Nested scheme for apikey:
- Roles
[]Get
Sm Secrets Secret Source Service Iam Role - (List) The service-specific custom role object. Nested scheme for role:
- Serviceids
[]Get
Sm Secrets Secret Source Service Iam Serviceid - (String) The IAM serviceid for the generated service credentials. Nested scheme for serviceid:
- apikeys
List<Get
Sm Secrets Secret Source Service Iam Apikey> - (String) The IAM apikey metadata for the IAM credentials that were generated. Nested scheme for apikey:
- roles
List<Get
Sm Secrets Secret Source Service Iam Role> - (List) The service-specific custom role object. Nested scheme for role:
- serviceids
List<Get
Sm Secrets Secret Source Service Iam Serviceid> - (String) The IAM serviceid for the generated service credentials. Nested scheme for serviceid:
- apikeys
Get
Sm Secrets Secret Source Service Iam Apikey[] - (String) The IAM apikey metadata for the IAM credentials that were generated. Nested scheme for apikey:
- roles
Get
Sm Secrets Secret Source Service Iam Role[] - (List) The service-specific custom role object. Nested scheme for role:
- serviceids
Get
Sm Secrets Secret Source Service Iam Serviceid[] - (String) The IAM serviceid for the generated service credentials. Nested scheme for serviceid:
- apikeys
Sequence[Get
Sm Secrets Secret Source Service Iam Apikey] - (String) The IAM apikey metadata for the IAM credentials that were generated. Nested scheme for apikey:
- roles
Sequence[Get
Sm Secrets Secret Source Service Iam Role] - (List) The service-specific custom role object. Nested scheme for role:
- serviceids
Sequence[Get
Sm Secrets Secret Source Service Iam Serviceid] - (String) The IAM serviceid for the generated service credentials. Nested scheme for serviceid:
- apikeys List<Property Map>
- (String) The IAM apikey metadata for the IAM credentials that were generated. Nested scheme for apikey:
- roles List<Property Map>
- (List) The service-specific custom role object. Nested scheme for role:
- serviceids List<Property Map>
- (String) The IAM serviceid for the generated service credentials. Nested scheme for serviceid:
GetSmSecretsSecretSourceServiceIamApikey
- Description string
- (String) The IAM API key description for the generated service credentials.
- Name string
- (String) The resource key name of the generated service credentials.
- Description string
- (String) The IAM API key description for the generated service credentials.
- Name string
- (String) The resource key name of the generated service credentials.
- description String
- (String) The IAM API key description for the generated service credentials.
- name String
- (String) The resource key name of the generated service credentials.
- description string
- (String) The IAM API key description for the generated service credentials.
- name string
- (String) The resource key name of the generated service credentials.
- description str
- (String) The IAM API key description for the generated service credentials.
- name str
- (String) The resource key name of the generated service credentials.
- description String
- (String) The IAM API key description for the generated service credentials.
- name String
- (String) The resource key name of the generated service credentials.
GetSmSecretsSecretSourceServiceIamRole
- Crn string
- (String) The CRN role identifier for creating a service-id.
- Crn string
- (String) The CRN role identifier for creating a service-id.
- crn String
- (String) The CRN role identifier for creating a service-id.
- crn string
- (String) The CRN role identifier for creating a service-id.
- crn str
- (String) The CRN role identifier for creating a service-id.
- crn String
- (String) The CRN role identifier for creating a service-id.
GetSmSecretsSecretSourceServiceIamServiceid
- Crn string
- (String) The CRN role identifier for creating a service-id.
- Crn string
- (String) The CRN role identifier for creating a service-id.
- crn String
- (String) The CRN role identifier for creating a service-id.
- crn string
- (String) The CRN role identifier for creating a service-id.
- crn str
- (String) The CRN role identifier for creating a service-id.
- crn String
- (String) The CRN role identifier for creating a service-id.
GetSmSecretsSecretSourceServiceInstance
- Crn string
- (String) The CRN role identifier for creating a service-id.
- Crn string
- (String) The CRN role identifier for creating a service-id.
- crn String
- (String) The CRN role identifier for creating a service-id.
- crn string
- (String) The CRN role identifier for creating a service-id.
- crn str
- (String) The CRN role identifier for creating a service-id.
- crn String
- (String) The CRN role identifier for creating a service-id.
GetSmSecretsSecretSourceServiceResourceKey
GetSmSecretsSecretSourceServiceRole
- Crn string
- (String) The CRN role identifier for creating a service-id.
- Crn string
- (String) The CRN role identifier for creating a service-id.
- crn String
- (String) The CRN role identifier for creating a service-id.
- crn string
- (String) The CRN role identifier for creating a service-id.
- crn str
- (String) The CRN role identifier for creating a service-id.
- crn String
- (String) The CRN role identifier for creating a service-id.
GetSmSecretsSecretValidity
- not_
after str - (String) The date-time format follows RFC 3339.
- not_
before str - (String) The date-time format follows RFC 3339.
Package Details
- Repository
- ibm ibm-cloud/terraform-provider-ibm
- License
- Notes
- This Pulumi package is based on the
ibm
Terraform Provider.