This is the multi-page printable view of this section. Click here to print.
Models
- 1: SecretsManager
- 2: SecretsManagerCreateRequest
- 3: SecretsManagerCreateResponse
- 4: SecretsManagerListResponse
- 5: SecretsManagerSetCidrRequest
- 6: SecretsManagerSetDescriptionRequest
- 7: SecretsManagerSetKmsRequest
- 8: SecretsManagerSetSecretValueRequest
- 9: SecretsManagerShowResponse
- 10: SecretsManagerShowSecretValueRequest
- 11: SecretsManagerShowSecretValueResponse
- 12: SecretsManagerTerminatedRequest
- 13: SecretsManagerUpdateLabelRequest
- 14: SecretsManagerVersionListResponse
- 15: SecretsRandomPasswordRequest
- 16: SecretsRandomPasswordResponse
- 17: Tag
1 - SecretsManager
| Name | Description | Schema | Default |
|---|---|---|---|
| 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
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 : namePattern : ^[A-Za-z0-9_-]*$Minimum length : 3Maximum 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
| Name | Description | Schema | Default |
|---|---|---|---|
| secret required | SecretsManager |
4 - SecretsManagerListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| 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
| Name | Description | Schema | Default |
|---|---|---|---|
| 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
| Name | Description | Schema | Default |
|---|---|---|---|
| description required | Description of secret Example : description | any of [string, null] |
7 - SecretsManagerSetKmsRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| kms_id required | Resource ID created in the Key Management Service (KMS) product Example : 3265ab469f0d406d83073da3e11e7a6c | string |
8 - SecretsManagerSetSecretValueRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| 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
| Name | Description | Schema | Default |
|---|---|---|---|
| secret required | SecretsManager |
10 - SecretsManagerShowSecretValueRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| label optional | Label of secret version. Not allow duplication. Example : CURRENTMinimum length : 1Maximum length : 256 | string | |
| version_id optional | Secret Version ID Example : e7b638507d9f4feeb6032a22b7640bf7 | string |
11 - SecretsManagerShowSecretValueResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| 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
| Name | Description | Schema | Default |
|---|---|---|---|
| waiting_time_ndays required | Days remaining until deletion Example : 7Minimum : 7Maximum : 30 | integer |
13 - SecretsManagerUpdateLabelRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| label required | Label of secret version. Not allow duplication. Example : My Custom LabelMinimum length : 1Maximum 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
| Name | Description | Schema | Default |
|---|---|---|---|
| version_list required | array[object] |
15 - SecretsRandomPasswordRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| exclude_characters optional | Characters to exclude when generating password Example : abcdefgMaximum 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 : 32Minimum : 5Maximum : 1024 | integer | 32 |
| require_each_included_type optional | Require all included character types Example : true | boolean | True |
16 - SecretsRandomPasswordResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| random_password required | Generate random password. Example : random-value | string |
17 - Tag
| Name | Description | Schema | Default |
|---|---|---|---|
| key required | tag key Example : | string | |
| value required | tag value Example : | string |