Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. kms
  6. getSecret
Viewing docs for volcenginecc v0.0.38
published on Monday, May 25, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

volcenginecc.kms.getSecret

volcenginecc logo
Viewing docs for volcenginecc v0.0.38
published on Monday, May 25, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

    Data Source schema for Volcengine::KMS::Secret

    Using getSecret

    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 getSecret(args: GetSecretArgs, opts?: InvokeOptions): Promise<GetSecretResult>
function getSecretOutput(args: GetSecretOutputArgs, opts?: InvokeOptions): Output<GetSecretResult>
    def get_secret(id: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetSecretResult
def get_secret_output(id: pulumi.Input[Optional[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetSecretResult]
    func LookupSecret(ctx *Context, args *LookupSecretArgs, opts ...InvokeOption) (*LookupSecretResult, error)
func LookupSecretOutput(ctx *Context, args *LookupSecretOutputArgs, opts ...InvokeOption) LookupSecretResultOutput

    > Note: This function is named LookupSecret in the Go SDK.

    public static class GetSecret 
{
    public static Task<GetSecretResult> InvokeAsync(GetSecretArgs args, InvokeOptions? opts = null)
    public static Output<GetSecretResult> Invoke(GetSecretInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetSecretResult> getSecret(GetSecretArgs args, InvokeOptions options)
public static Output<GetSecretResult> getSecret(GetSecretArgs args, InvokeOptions options)

    fn::invoke:
  function: volcenginecc:kms/getSecret:getSecret
  arguments:
    # arguments dictionary
    data "volcenginecc_kms_getsecret" "name" {
    # arguments
}

    The following arguments are supported:

    Id string
    Uniquely identifies the resource.
    Id string
    Uniquely identifies the resource.
    id string
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.
    id string
    Uniquely identifies the resource.
    id str
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.

    getSecret Result

    The following output properties are available:

    AutomaticRotation bool
    Whether to enable automatic rotation. Applies only to credentials of type IAM|RDS|Redis|ECS
    CreatedTime int
    Credential creation time
    Description string
    Credential description, length: 0 ~ 8192 characters
    EncryptionKey string
    KMS key TRN for encrypting credential value. If not specified, the default key of Credential Manager is used
    ExtendedConfig string
    Credential extension configuration, used to specify properties for non-Generic credentials
    Id string
    Uniquely identifies the resource.
    LastRotationTime string
    Credential last rotation time
    Managed bool
    Is managed credential
    OwningService string
    Managed Cloud Service
    ProjectName string
    Credential project name. Default value: default
    RotationInterval string
    Automatic rotation interval. Range: 1 ~ 365 days. Format: integer[unit], where integer is the duration and unit is the time unit. Unit value: d (days). For example: 7d means a 7-day interval
    RotationIntervalRead int
    Automatic rotation interval, unit: seconds
    RotationState string
    Rotation status: Enable: automatic rotation enabled, Disable: automatic rotation disabled, Rotating: automatic rotation in progress, None: automatic rotation not supported
    ScheduleDeleteTime string
    Credential Scheduled Deletion Time
    ScheduleRotationTime string
    Credential next rotation time
    SecretId string
    Credential unique identifier, UUID format
    SecretName string
    Credential name. Valid characters: [a-zA-Z0-9/_+=.@-]
    SecretState string
    Credential status. Enable: enabled, Disable: disabled, PendingDelete: scheduled for deletion
    SecretType string
    Credential type. Currently supports Generic|IAM|RDS|Redis|ECS|PGSQL|SQLServer
    SecretValue string
    Credential value. When SecretType is Generic, users can customize it. It is recommended to use JSON key-value pairs
    Trn string
    Credential resource name. Format: trn:kms:${Region}:${AccountID}:secrets/${secret}
    Uid string
    Credential tenant ID
    UpdatedTime int
    Credential update date
    VersionName string
    Version alias. Valid characters: [a-zA-Z0-9/_+=.@-]
    AutomaticRotation bool
    Whether to enable automatic rotation. Applies only to credentials of type IAM|RDS|Redis|ECS
    CreatedTime int
    Credential creation time
    Description string
    Credential description, length: 0 ~ 8192 characters
    EncryptionKey string
    KMS key TRN for encrypting credential value. If not specified, the default key of Credential Manager is used
    ExtendedConfig string
    Credential extension configuration, used to specify properties for non-Generic credentials
    Id string
    Uniquely identifies the resource.
    LastRotationTime string
    Credential last rotation time
    Managed bool
    Is managed credential
    OwningService string
    Managed Cloud Service
    ProjectName string
    Credential project name. Default value: default
    RotationInterval string
    Automatic rotation interval. Range: 1 ~ 365 days. Format: integer[unit], where integer is the duration and unit is the time unit. Unit value: d (days). For example: 7d means a 7-day interval
    RotationIntervalRead int
    Automatic rotation interval, unit: seconds
    RotationState string
    Rotation status: Enable: automatic rotation enabled, Disable: automatic rotation disabled, Rotating: automatic rotation in progress, None: automatic rotation not supported
    ScheduleDeleteTime string
    Credential Scheduled Deletion Time
    ScheduleRotationTime string
    Credential next rotation time
    SecretId string
    Credential unique identifier, UUID format
    SecretName string
    Credential name. Valid characters: [a-zA-Z0-9/_+=.@-]
    SecretState string
    Credential status. Enable: enabled, Disable: disabled, PendingDelete: scheduled for deletion
    SecretType string
    Credential type. Currently supports Generic|IAM|RDS|Redis|ECS|PGSQL|SQLServer
    SecretValue string
    Credential value. When SecretType is Generic, users can customize it. It is recommended to use JSON key-value pairs
    Trn string
    Credential resource name. Format: trn:kms:${Region}:${AccountID}:secrets/${secret}
    Uid string
    Credential tenant ID
    UpdatedTime int
    Credential update date
    VersionName string
    Version alias. Valid characters: [a-zA-Z0-9/_+=.@-]
    automatic_rotation bool
    Whether to enable automatic rotation. Applies only to credentials of type IAM|RDS|Redis|ECS
    created_time number
    Credential creation time
    description string
    Credential description, length: 0 ~ 8192 characters
    encryption_key string
    KMS key TRN for encrypting credential value. If not specified, the default key of Credential Manager is used
    extended_config string
    Credential extension configuration, used to specify properties for non-Generic credentials
    id string
    Uniquely identifies the resource.
    last_rotation_time string
    Credential last rotation time
    managed bool
    Is managed credential
    owning_service string
    Managed Cloud Service
    project_name string
    Credential project name. Default value: default
    rotation_interval string
    Automatic rotation interval. Range: 1 ~ 365 days. Format: integer[unit], where integer is the duration and unit is the time unit. Unit value: d (days). For example: 7d means a 7-day interval
    rotation_interval_read number
    Automatic rotation interval, unit: seconds
    rotation_state string
    Rotation status: Enable: automatic rotation enabled, Disable: automatic rotation disabled, Rotating: automatic rotation in progress, None: automatic rotation not supported
    schedule_delete_time string
    Credential Scheduled Deletion Time
    schedule_rotation_time string
    Credential next rotation time
    secret_id string
    Credential unique identifier, UUID format
    secret_name string
    Credential name. Valid characters: [a-zA-Z0-9/_+=.@-]
    secret_state string
    Credential status. Enable: enabled, Disable: disabled, PendingDelete: scheduled for deletion
    secret_type string
    Credential type. Currently supports Generic|IAM|RDS|Redis|ECS|PGSQL|SQLServer
    secret_value string
    Credential value. When SecretType is Generic, users can customize it. It is recommended to use JSON key-value pairs
    trn string
    Credential resource name. Format: trn:kms:${Region}:${AccountID}:secrets/${secret}
    uid string
    Credential tenant ID
    updated_time number
    Credential update date
    version_name string
    Version alias. Valid characters: [a-zA-Z0-9/_+=.@-]
    automaticRotation Boolean
    Whether to enable automatic rotation. Applies only to credentials of type IAM|RDS|Redis|ECS
    createdTime Integer
    Credential creation time
    description String
    Credential description, length: 0 ~ 8192 characters
    encryptionKey String
    KMS key TRN for encrypting credential value. If not specified, the default key of Credential Manager is used
    extendedConfig String
    Credential extension configuration, used to specify properties for non-Generic credentials
    id String
    Uniquely identifies the resource.
    lastRotationTime String
    Credential last rotation time
    managed Boolean
    Is managed credential
    owningService String
    Managed Cloud Service
    projectName String
    Credential project name. Default value: default
    rotationInterval String
    Automatic rotation interval. Range: 1 ~ 365 days. Format: integer[unit], where integer is the duration and unit is the time unit. Unit value: d (days). For example: 7d means a 7-day interval
    rotationIntervalRead Integer
    Automatic rotation interval, unit: seconds
    rotationState String
    Rotation status: Enable: automatic rotation enabled, Disable: automatic rotation disabled, Rotating: automatic rotation in progress, None: automatic rotation not supported
    scheduleDeleteTime String
    Credential Scheduled Deletion Time
    scheduleRotationTime String
    Credential next rotation time
    secretId String
    Credential unique identifier, UUID format
    secretName String
    Credential name. Valid characters: [a-zA-Z0-9/_+=.@-]
    secretState String
    Credential status. Enable: enabled, Disable: disabled, PendingDelete: scheduled for deletion
    secretType String
    Credential type. Currently supports Generic|IAM|RDS|Redis|ECS|PGSQL|SQLServer
    secretValue String
    Credential value. When SecretType is Generic, users can customize it. It is recommended to use JSON key-value pairs
    trn String
    Credential resource name. Format: trn:kms:${Region}:${AccountID}:secrets/${secret}
    uid String
    Credential tenant ID
    updatedTime Integer
    Credential update date
    versionName String
    Version alias. Valid characters: [a-zA-Z0-9/_+=.@-]
    automaticRotation boolean
    Whether to enable automatic rotation. Applies only to credentials of type IAM|RDS|Redis|ECS
    createdTime number
    Credential creation time
    description string
    Credential description, length: 0 ~ 8192 characters
    encryptionKey string
    KMS key TRN for encrypting credential value. If not specified, the default key of Credential Manager is used
    extendedConfig string
    Credential extension configuration, used to specify properties for non-Generic credentials
    id string
    Uniquely identifies the resource.
    lastRotationTime string
    Credential last rotation time
    managed boolean
    Is managed credential
    owningService string
    Managed Cloud Service
    projectName string
    Credential project name. Default value: default
    rotationInterval string
    Automatic rotation interval. Range: 1 ~ 365 days. Format: integer[unit], where integer is the duration and unit is the time unit. Unit value: d (days). For example: 7d means a 7-day interval
    rotationIntervalRead number
    Automatic rotation interval, unit: seconds
    rotationState string
    Rotation status: Enable: automatic rotation enabled, Disable: automatic rotation disabled, Rotating: automatic rotation in progress, None: automatic rotation not supported
    scheduleDeleteTime string
    Credential Scheduled Deletion Time
    scheduleRotationTime string
    Credential next rotation time
    secretId string
    Credential unique identifier, UUID format
    secretName string
    Credential name. Valid characters: [a-zA-Z0-9/_+=.@-]
    secretState string
    Credential status. Enable: enabled, Disable: disabled, PendingDelete: scheduled for deletion
    secretType string
    Credential type. Currently supports Generic|IAM|RDS|Redis|ECS|PGSQL|SQLServer
    secretValue string
    Credential value. When SecretType is Generic, users can customize it. It is recommended to use JSON key-value pairs
    trn string
    Credential resource name. Format: trn:kms:${Region}:${AccountID}:secrets/${secret}
    uid string
    Credential tenant ID
    updatedTime number
    Credential update date
    versionName string
    Version alias. Valid characters: [a-zA-Z0-9/_+=.@-]
    automatic_rotation bool
    Whether to enable automatic rotation. Applies only to credentials of type IAM|RDS|Redis|ECS
    created_time int
    Credential creation time
    description str
    Credential description, length: 0 ~ 8192 characters
    encryption_key str
    KMS key TRN for encrypting credential value. If not specified, the default key of Credential Manager is used
    extended_config str
    Credential extension configuration, used to specify properties for non-Generic credentials
    id str
    Uniquely identifies the resource.
    last_rotation_time str
    Credential last rotation time
    managed bool
    Is managed credential
    owning_service str
    Managed Cloud Service
    project_name str
    Credential project name. Default value: default
    rotation_interval str
    Automatic rotation interval. Range: 1 ~ 365 days. Format: integer[unit], where integer is the duration and unit is the time unit. Unit value: d (days). For example: 7d means a 7-day interval
    rotation_interval_read int
    Automatic rotation interval, unit: seconds
    rotation_state str
    Rotation status: Enable: automatic rotation enabled, Disable: automatic rotation disabled, Rotating: automatic rotation in progress, None: automatic rotation not supported
    schedule_delete_time str
    Credential Scheduled Deletion Time
    schedule_rotation_time str
    Credential next rotation time
    secret_id str
    Credential unique identifier, UUID format
    secret_name str
    Credential name. Valid characters: [a-zA-Z0-9/_+=.@-]
    secret_state str
    Credential status. Enable: enabled, Disable: disabled, PendingDelete: scheduled for deletion
    secret_type str
    Credential type. Currently supports Generic|IAM|RDS|Redis|ECS|PGSQL|SQLServer
    secret_value str
    Credential value. When SecretType is Generic, users can customize it. It is recommended to use JSON key-value pairs
    trn str
    Credential resource name. Format: trn:kms:${Region}:${AccountID}:secrets/${secret}
    uid str
    Credential tenant ID
    updated_time int
    Credential update date
    version_name str
    Version alias. Valid characters: [a-zA-Z0-9/_+=.@-]
    automaticRotation Boolean
    Whether to enable automatic rotation. Applies only to credentials of type IAM|RDS|Redis|ECS
    createdTime Number
    Credential creation time
    description String
    Credential description, length: 0 ~ 8192 characters
    encryptionKey String
    KMS key TRN for encrypting credential value. If not specified, the default key of Credential Manager is used
    extendedConfig String
    Credential extension configuration, used to specify properties for non-Generic credentials
    id String
    Uniquely identifies the resource.
    lastRotationTime String
    Credential last rotation time
    managed Boolean
    Is managed credential
    owningService String
    Managed Cloud Service
    projectName String
    Credential project name. Default value: default
    rotationInterval String
    Automatic rotation interval. Range: 1 ~ 365 days. Format: integer[unit], where integer is the duration and unit is the time unit. Unit value: d (days). For example: 7d means a 7-day interval
    rotationIntervalRead Number
    Automatic rotation interval, unit: seconds
    rotationState String
    Rotation status: Enable: automatic rotation enabled, Disable: automatic rotation disabled, Rotating: automatic rotation in progress, None: automatic rotation not supported
    scheduleDeleteTime String
    Credential Scheduled Deletion Time
    scheduleRotationTime String
    Credential next rotation time
    secretId String
    Credential unique identifier, UUID format
    secretName String
    Credential name. Valid characters: [a-zA-Z0-9/_+=.@-]
    secretState String
    Credential status. Enable: enabled, Disable: disabled, PendingDelete: scheduled for deletion
    secretType String
    Credential type. Currently supports Generic|IAM|RDS|Redis|ECS|PGSQL|SQLServer
    secretValue String
    Credential value. When SecretType is Generic, users can customize it. It is recommended to use JSON key-value pairs
    trn String
    Credential resource name. Format: trn:kms:${Region}:${AccountID}:secrets/${secret}
    uid String
    Credential tenant ID
    updatedTime Number
    Credential update date
    versionName String
    Version alias. Valid characters: [a-zA-Z0-9/_+=.@-]

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    Viewing docs for volcenginecc v0.0.38
    published on Monday, May 25, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcenginecc

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial