com.aliyun.sdk.service.kms20160120.models

类 CreateSecretRequest.Builder

java.lang.Object

com.aliyun.sdk.service.kms20160120.models.CreateSecretRequest.Builder

所有已实现的接口:

darabonba.core.RequestModel.Builder<CreateSecretRequest,CreateSecretRequest.Builder>

封闭类:

CreateSecretRequest

public static final class CreateSecretRequest.Builder
extends Object

方法概要

限定符和类型	方法和说明
CreateSecretRequest	build()
CreateSecretRequest.Builder	description(String description) Specifies whether to enable automatic rotation.
CreateSecretRequest.Builder	DKMSInstanceId(String DKMSInstanceId) The version number of the secret.
CreateSecretRequest.Builder	enableAutomaticRotation(Boolean enableAutomaticRotation) Indicates whether automatic rotation is enabled.
CreateSecretRequest.Builder	encryptionKeyId(String encryptionKeyId) The description of the secret.
CreateSecretRequest.Builder	extendedConfig(Map<String,?> extendedConfig) The ID of the request, which is used to locate and troubleshoot issues.
CreateSecretRequest.Builder	rotationInterval(String rotationInterval) The name of the secret.
CreateSecretRequest.Builder	secretData(String secretData) The tags of the secret.
CreateSecretRequest.Builder	secretDataType(String secretDataType) The extended configuration of the secret.
CreateSecretRequest.Builder	secretName(String secretName) The value of the secret that you want to create.
CreateSecretRequest.Builder	secretType(String secretType) The ID of the dedicated KMS instance.
CreateSecretRequest.Builder	tags(String tags) The interval for automatic rotation.
CreateSecretRequest.Builder	versionId(String versionId) The type of the secret value.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

方法详细资料

DKMSInstanceId

public CreateSecretRequest.Builder DKMSInstanceId(String DKMSInstanceId)

The version number of the secret.

description

public CreateSecretRequest.Builder description(String description)

Specifies whether to enable automatic rotation. Valid values:

* true: specifies to enable automatic rotation. * false: specifies to disable automatic rotation. This is the default value. > This parameter is valid if you set the SecretType parameter to Rds, RAMCredentials, or ECS.

enableAutomaticRotation

public CreateSecretRequest.Builder enableAutomaticRotation(Boolean enableAutomaticRotation)

Indicates whether automatic rotation is enabled. Valid values:

* Enabled: indicates that automatic rotation is enabled. * Disabled: indicates that automatic rotation is disabled. * Invalid: indicates that the status of automatic rotation is abnormal. In this case, Secrets Manager cannot automatically rotate the secret. > This parameter is returned if you set the SecretType parameter to Rds, RAMCredentials, or ECS.

encryptionKeyId

public CreateSecretRequest.Builder encryptionKeyId(String encryptionKeyId)

The description of the secret.

extendedConfig

public CreateSecretRequest.Builder extendedConfig(Map<String,?> extendedConfig)

The ID of the request, which is used to locate and troubleshoot issues.

rotationInterval

public CreateSecretRequest.Builder rotationInterval(String rotationInterval)

The name of the secret.

secretData

public CreateSecretRequest.Builder secretData(String secretData)

The tags of the secret.

secretDataType

public CreateSecretRequest.Builder secretDataType(String secretDataType)

The extended configuration of the secret. This parameter specifies the properties of the secret of the specific type. The description can be up to 1,024 characters in length.

* If you set the SecretType parameter to Generic, you do not need to configure this parameter. * If you set the SecretType parameter to Rds, configure the following fields for the ExtendedConfig parameter: * SecretSubType: required. The subtype of the secret. Valid values: * SingleUser: Secrets Manager manages the ApsaraDB RDS secret in single-account mode. When the secret is rotated, the password of the specified account is reset to a new random password. * DoubleUsers: Secrets Manager manages the ApsaraDB RDS secret in dual-account mode. One account is referenced by the ACSCurrent version, and the other account is referenced by the ACSPrevious version. When the secret is rotated, the password of the account referenced by the ACSPrevious version is reset to a new random password. Then, Secrets Manager switches the referenced accounts between the ACSCurrent and ACSPrevious versions. * DBInstanceId: required. The ApsaraDB RDS instance to which the ApsaraDB RDS account belongs. * CustomData: optional. The custom data. The value is a collection of key-value pairs in the JSON format. Up to 10 key-value pairs can be specified. Separate multiple key-value pairs with commas (,). Example: `{"Key1": "v1", "fds":"fdsf"}`. The default value is a pair of empty braces (`{}`). * If you set the SecretType parameter to RAMCredentials, configure the following fields for the ExtendedConfig parameter: * SecretSubType: required. The subtype of the secret. Set the value to RamUserAccessKey. * UserName: required. The name of the RAM user. * CustomData: optional. The custom data. The value is a collection of key-value pairs in the JSON format. Up to 10 key-value pairs can be specified. Separate multiple key-value pairs with commas (,). The default value is a pair of empty braces (`{}`). * If you set the SecretType parameter to ECS, configure the following fields for the ExtendedConfig parameter: * SecretSubType: required. The subtype of the secret. Valid values: * Password: the password that is used to log on to the ECS instance. * SSHKey: the SSH public key and private key that are used to log on to the ECS instance. * RegionId: required. The ID of the region in which the ECS instance resides. * InstanceId: required. The ID of the ECS instance. * CustomData: optional. The custom data. The value is a collection of key-value pairs in the JSON format. Up to 10 key-value pairs can be specified. Separate multiple key-value pairs with commas (,). The default value is a pair of empty braces (`{}`). > This parameter is required if you set the SecretType parameter to Rds, RAMCredentials, or ECS.

secretName

public CreateSecretRequest.Builder secretName(String secretName)

The value of the secret that you want to create. Secrets Manager encrypts the secret value and stores the encrypted value in the initial version.

* If you set the SecretType parameter to Generic that indicates a generic secret, you can customize the secret value. * If you set the SecretType parameter to Rds that indicates a managed ApsaraDB RDS secret, the secret value must be in the format of `{"Accounts":[{"AccountName":"","AccountPassword":""}]}`. In the preceding format, `AccountName` indicates the username of the account that is used to connect to your ApsaraDB RDS instance, and `AccountPassword` specifies the password of the account. * If you set the SecretType parameter to RAMCredentials that indicates a managed RAM secret, the secret value must be in the format of `{"AccessKeys":[{"AccessKeyId":"","AccessKeySecret":"",}]}`. In the preceding format, `AccessKeyId` indicates the AccessKey ID of the RAM user and `AccessKeySecret` specifies the AccessKey secret of the RAM user. You must specify all the AccessKey pairs of the RAM user. * If you set the SecretType parameter to ECS that indicates a managed ECS secret, the secret value must be in one of the following formats: * `{"UserName":"","Password": ""}`: In the format, `UserName` specifies the username that is used to log on to the ECS instance, and `Password` specifies the password that is used to log on to the ECS instance. * `{"UserName":"","PublicKey": "", "PrivateKey": ""}`: In the format, `PublicKey` indicates the SSH public key that is used to log on to the ECS instance, and `PrivateKey` specifies the SSH private key that is used to log on to the ECS instance.

secretType

public CreateSecretRequest.Builder secretType(String secretType)

The ID of the dedicated KMS instance.

tags

public CreateSecretRequest.Builder tags(String tags)

The interval for automatic rotation. Valid values: 6 hours to 8,760 hours (365 days).

The value is in the `integer[unit]` format. The unit can be d (day), h (hour), m (minute), or s (second). For example, both 7d and 604800s indicate a seven-day interval. > This parameter is required if you set the EnableAutomaticRotation parameter to true. This parameter is ignored if you set the EnableAutomaticRotation parameter to false or if the EnableAutomaticRotation parameter is not configured.

versionId

public CreateSecretRequest.Builder versionId(String versionId)

The type of the secret value. Valid values:

* text * binary > If you set the SecretType parameter to Rds, RAMCredentials, or ECS, the SecretDataType parameter must be set to text.

build

public CreateSecretRequest build()