com.tencentcloudapi.ssm.v20190923

Class SsmClient

java.lang.Object

com.tencentcloudapi.common.AbstractClient

com.tencentcloudapi.ssm.v20190923.SsmClient

public class SsmClient
extends AbstractClient

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractClient

gson, HTTP_RSP_OK, SDK_VERSION

Constructor Summary

Constructors

Constructor and Description
SsmClient(Credential credential, String region)
SsmClient(Credential credential, String region, ClientProfile profile)

Method Summary

Modifier and Type	Method and Description
CreateSecretResponse	CreateSecret(CreateSecretRequest req) This API is used to create a KMS-encrypted Secret.
DeleteSecretResponse	DeleteSecret(DeleteSecretRequest req) This API is used to delete a Secret.
DeleteSecretVersionResponse	DeleteSecretVersion(DeleteSecretVersionRequest req) This API is used to delete a version of a Secret.
DescribeSecretResponse	DescribeSecret(DescribeSecretRequest req) This API is used to obtain the detailed attribute information of a Secret.
DisableSecretResponse	DisableSecret(DisableSecretRequest req) This API is used to disable a Secret and will change its status to `Disabled`.
EnableSecretResponse	EnableSecret(EnableSecretRequest req) This API is used to enable a Secret and will change its status to `Enabled`.
GetRegionsResponse	GetRegions(GetRegionsRequest req) This API is used to obtain the list of regions displayed on Console.
GetSecretValueResponse	GetSecretValue(GetSecretValueRequest req) This API is used to obtain the plaintext of a specified Secret and version.
GetServiceStatusResponse	GetServiceStatus(GetServiceStatusRequest req) This API is used to obtain the SecretsManager service status of a user.
ListSecretsResponse	ListSecrets(ListSecretsRequest req) This API is used to obtain the detailed information list of all Secrets.
ListSecretVersionIdsResponse	ListSecretVersionIds(ListSecretVersionIdsRequest req) This API is used to obtain list of versions of a Secret.
PutSecretValueResponse	PutSecretValue(PutSecretValueRequest req) This API is used to add a new version to a specified Secret.
RestoreSecretResponse	RestoreSecret(RestoreSecretRequest req) This API is used to restore a `PendingDelete` Secret, canceling its scheduled deletion.
UpdateDescriptionResponse	UpdateDescription(UpdateDescriptionRequest req) This API is used to update the description of a Secret.
UpdateSecretResponse	UpdateSecret(UpdateSecretRequest req) This API is used to update the name and version ID of a Secret.

Methods inherited from class com.tencentcloudapi.common.AbstractClient

call, getClientProfile, getCredential, getRegion, internalRequest, setClientProfile, setCredential, setRegion

Methods inherited from class java.lang.Object

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

Constructor Detail

SsmClient

public SsmClient(Credential credential,
                 String region)

SsmClient

public SsmClient(Credential credential,
                 String region,
                 ClientProfile profile)

Method Detail

CreateSecret

public CreateSecretResponse CreateSecret(CreateSecretRequest req)
                                  throws TencentCloudSDKException

This API is used to create a KMS-encrypted Secret. You can create and store up to 1,000 Secrets in each region.

Parameters:

req - CreateSecretRequest

Returns:

CreateSecretResponse

Throws:

TencentCloudSDKException

DeleteSecret

public DeleteSecretResponse DeleteSecret(DeleteSecretRequest req)
                                  throws TencentCloudSDKException

This API is used to delete a Secret. You can set whether to delete the Secret immediately or on schedule using the `RecoveryWindowInDays` parameter. For a Secret to be deleted on schedule, its status will be `PendingDelete` before the scheduled deletion time. You can use `RestoreSecret` to restore a deleted Secret during this time. A deleted Secret will not be restorable after the scheduled deletion time. A Secret can only be deleted after being disabled using `DisableSecret`.

Parameters:

req - DeleteSecretRequest

Returns:

DeleteSecretResponse

Throws:

TencentCloudSDKException

DeleteSecretVersion

public DeleteSecretVersionResponse DeleteSecretVersion(DeleteSecretVersionRequest req)
                                                throws TencentCloudSDKException

This API is used to delete a version of a Secret. The deletion takes effect immediately. Secret versions in any status can be deleted.

Parameters:

req - DeleteSecretVersionRequest

Returns:

DeleteSecretVersionResponse

Throws:

TencentCloudSDKException

DescribeSecret

public DescribeSecretResponse DescribeSecret(DescribeSecretRequest req)
                                      throws TencentCloudSDKException

This API is used to obtain the detailed attribute information of a Secret.

Parameters:

req - DescribeSecretRequest

Returns:

DescribeSecretResponse

Throws:

TencentCloudSDKException

DisableSecret

public DisableSecretResponse DisableSecret(DisableSecretRequest req)
                                    throws TencentCloudSDKException

This API is used to disable a Secret and will change its status to `Disabled`. The plaintext of a disabled Secret cannot be obtained through APIs.

Parameters:

req - DisableSecretRequest

Returns:

DisableSecretResponse

Throws:

TencentCloudSDKException

EnableSecret

public EnableSecretResponse EnableSecret(EnableSecretRequest req)
                                  throws TencentCloudSDKException

This API is used to enable a Secret and will change its status to `Enabled`. You can call the `GetSecretValue` API to obtain the plaintext of this Secret. Secrets in `PendingDelete` status can only be enabled after being restored by using `RestoreSecret`.

Parameters:

req - EnableSecretRequest

Returns:

EnableSecretResponse

Throws:

TencentCloudSDKException

GetRegions

public GetRegionsResponse GetRegions(GetRegionsRequest req)
                              throws TencentCloudSDKException

This API is used to obtain the list of regions displayed on Console.

Parameters:

req - GetRegionsRequest

Returns:

GetRegionsResponse

Throws:

TencentCloudSDKException

GetSecretValue

public GetSecretValueResponse GetSecretValue(GetSecretValueRequest req)
                                      throws TencentCloudSDKException

This API is used to obtain the plaintext of a specified Secret and version. Only plaintext of an enabled Secret can be obtained.

Parameters:

req - GetSecretValueRequest

Returns:

GetSecretValueResponse

Throws:

TencentCloudSDKException

GetServiceStatus

public GetServiceStatusResponse GetServiceStatus(GetServiceStatusRequest req)
                                          throws TencentCloudSDKException

This API is used to obtain the SecretsManager service status of a user.

Parameters:

req - GetServiceStatusRequest

Returns:

GetServiceStatusResponse

Throws:

TencentCloudSDKException

ListSecretVersionIds

public ListSecretVersionIdsResponse ListSecretVersionIds(ListSecretVersionIdsRequest req)
                                                  throws TencentCloudSDKException

This API is used to obtain list of versions of a Secret.

Parameters:

req - ListSecretVersionIdsRequest

Returns:

ListSecretVersionIdsResponse

Throws:

TencentCloudSDKException

ListSecrets

public ListSecretsResponse ListSecrets(ListSecretsRequest req)
                                throws TencentCloudSDKException

This API is used to obtain the detailed information list of all Secrets. You can specify the filter fields and sorting order as needed.

Parameters:

req - ListSecretsRequest

Returns:

ListSecretsResponse

Throws:

TencentCloudSDKException

PutSecretValue

public PutSecretValueResponse PutSecretValue(PutSecretValueRequest req)
                                      throws TencentCloudSDKException

This API is used to add a new version to a specified Secret. Each Secret supports up to 10 versions. You can only add versions to Secrets in `Enabled` or `Disabled` status.

Parameters:

req - PutSecretValueRequest

Returns:

PutSecretValueResponse

Throws:

TencentCloudSDKException

RestoreSecret

public RestoreSecretResponse RestoreSecret(RestoreSecretRequest req)
                                    throws TencentCloudSDKException

This API is used to restore a `PendingDelete` Secret, canceling its scheduled deletion. The restored Secret will be in `Disabled` status. You can call the `EnableSecret` API to enable this Secret again.

Parameters:

req - RestoreSecretRequest

Returns:

RestoreSecretResponse

Throws:

TencentCloudSDKException

UpdateDescription

public UpdateDescriptionResponse UpdateDescription(UpdateDescriptionRequest req)
                                            throws TencentCloudSDKException

This API is used to update the description of a Secret. This API can only update Secrets in `Enabled` or `Disabled` status.

Parameters:

req - UpdateDescriptionRequest

Returns:

UpdateDescriptionResponse

Throws:

TencentCloudSDKException

UpdateSecret

public UpdateSecretResponse UpdateSecret(UpdateSecretRequest req)
                                  throws TencentCloudSDKException

This API is used to update the name and version ID of a Secret. Calling this API encrypts the new Secret content and overwrites the old content. This API can only update Secrets in `Enabled` or `Disabled` status.

Parameters:

req - UpdateSecretRequest

Returns:

UpdateSecretResponse

Throws:

TencentCloudSDKException