1 - SecretsManager

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : 3265ab469f0d406d83073da3e11e7a6c
string
acl_cidr
required
Access control list of secret in CIDR
Example : 192.168.1.1/24, 10.0.0.1/16
any of [string, null]
created_at
required
Created At
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
deleted_at
required
Date of deletion
Example : 2025-02-25 03:07:17.000
any of [string (date-time), null]
description
required
Description of secret
Example : description
any of [string, null]
id
required
ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
string
kms_id
required
Resource ID created in the Key Management Service (KMS) product
Example : 3265ab469f0d406d83073da3e11e7a6c
string
kms_name
required
Resource name of KMS key
Example : kmsname
string
modified_at
required
Modified At
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
Name of key
Example : my-secret-name
any of [string, null]
recent_searched_at
required
Date of recent search
Example : 2025-02-25 03:07:17.000
any of [string (date-time), null]
state
required
State of key(Creating, Active, Error, Stop, To_Be_Terminated)
Example : Active
any of [string, null]
type
required
Type of secret
Example : General
any of [string, null]

2 - SecretsManagerCreateRequest

NameDescriptionSchemaDefault
acl_cidr
required
Access control list of secret in CIDR
Example : 192.168.1.1/24, 10.0.0.1/16
string
description
optional
Description of secret
Example : description
any of [string, null]
kms_id
required
Resource ID created in the Key Management Service (KMS) product
Example : 3265ab469f0d406d83073da3e11e7a6c
string
name
required
Secret Name
Example : name
Pattern : ^[A-Za-z0-9_-]*$
Minimum length : 3
Maximum length : 63
string
secret_value
required
The value of a Secret can be entered as a JSON string in key/value format, up to 10 pairs.
Example : {"key1":"value1","key2":"value2"}
string
tags
optional
Tag List’
any of [array[Tag], null]

3 - SecretsManagerCreateResponse

NameDescriptionSchemaDefault
secret
required

SecretsManager

4 - SecretsManagerListResponse

NameDescriptionSchemaDefault
count
required
count
Example : 20
integer
page
required
page
Example : 0
integer
secret
required

array[SecretsManager]
size
required
size
Example : 20
integer
sort
optional
sort
Example : ['created_at:asc']
any of [array[string], null]

5 - SecretsManagerSetCidrRequest

NameDescriptionSchemaDefault
acl_cidr
required
Access control list of secret in CIDR
Example : 192.168.1.1/24, 10.0.0.1/16
any of [string, null]

6 - SecretsManagerSetDescriptionRequest

NameDescriptionSchemaDefault
description
required
Description of secret
Example : description
any of [string, null]

7 - SecretsManagerSetKmsRequest

NameDescriptionSchemaDefault
kms_id
required
Resource ID created in the Key Management Service (KMS) product
Example : 3265ab469f0d406d83073da3e11e7a6c
string

8 - SecretsManagerSetSecretValueRequest

NameDescriptionSchemaDefault
secret_value
required
The value of a Secret can be entered as a JSON string in key/value format, up to 10 pairs.
Example : {"key1":"value1","key2":"value2"}
string

9 - SecretsManagerShowResponse

NameDescriptionSchemaDefault
secret
required

SecretsManager

10 - SecretsManagerShowSecretValueRequest

NameDescriptionSchemaDefault
label
optional
Label of secret version. Not allow duplication.
Example : CURRENT
Minimum length : 1
Maximum length : 256
string
version_id
optional
Secret Version ID
Example : e7b638507d9f4feeb6032a22b7640bf7
string

11 - SecretsManagerShowSecretValueResponse

NameDescriptionSchemaDefault
secret_value
required
The value of a Secret can be entered as a JSON string in key/value format, up to 10 pairs.
Example : {"key1":"value1","key2":"value2"}
string

12 - SecretsManagerTerminatedRequest

NameDescriptionSchemaDefault
waiting_time_ndays
required
Days remaining until deletion
Example : 7
Minimum : 7
Maximum : 30
integer

13 - SecretsManagerUpdateLabelRequest

NameDescriptionSchemaDefault
label
required
Label of secret version. Not allow duplication.
Example : My Custom Label
Minimum length : 1
Maximum length : 256
string
move_to_version_id
optional
Secret Version ID
Example : 3265ab469f0d406d83073da3e11e7a6c
any of [string, null]
remove_from_version_id
optional
Secret Version ID
Example : 3265ab469f0d406d83073da3e11e7a6c
any of [string, null]

14 - SecretsManagerVersionListResponse

NameDescriptionSchemaDefault
version_list
required

array[object]

15 - SecretsRandomPasswordRequest

NameDescriptionSchemaDefault
exclude_characters
optional
Characters to exclude when generating password
Example : abcdefg
Maximum length : 4096
string
exclude_lowercase
optional
Option to exclude lowercase letters
Example : false
boolean
exclude_numbers
optional
Option to exclude numbers
Example : false
boolean
exclude_punctuation
optional
Option to exclude punctuation
Example : false
boolean
exclude_uppercase
optional
Option to exclude uppercase letters
Example : false
boolean
include_space
optional
Option to include spaces
Example : false
boolean
password_length
optional
Length of the password to generate
Example : 32
Minimum : 5
Maximum : 1024
integer32
require_each_included_type
optional
Require all included character types
Example : true
booleanTrue

16 - SecretsRandomPasswordResponse

NameDescriptionSchemaDefault
random_password
required
Generate random password.
Example : random-value
string

17 - Tag

NameDescriptionSchemaDefault
key
required
tag key
Example :
string
value
required
tag value
Example :
string