1. Registry
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. rdsmysql
  6. Ssl
Viewing docs for volcenginecc v0.0.57
published on Monday, Aug 24, 2026 by Volcengine
volcenginecc logo
Viewing docs for volcenginecc v0.0.57
published on Monday, Aug 24, 2026 by Volcengine

    SSL encryption configuration for Volcano Engine RDS MySQL instances. Use ModifyDBInstanceSSL to enable, disable, or adjust the instance’s SSL settings, and use DescribeDBInstanceSSL to query the current SSL status.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as volcenginecc from "@volcengine/pulumi-volcenginecc";
    
    const example = new volcenginecc.rdsmysql.Ssl("example", {instanceId: "mysql-xxxxxx"});
    
    import pulumi
    import pulumi_volcenginecc as volcenginecc
    
    example = volcenginecc.rdsmysql.Ssl("example", instance_id="mysql-xxxxxx")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/rdsmysql"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := rdsmysql.NewSsl(ctx, "example", &rdsmysql.SslArgs{
    			InstanceId: pulumi.String("mysql-xxxxxx"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Volcenginecc = Volcengine.Pulumi.Volcenginecc;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Volcenginecc.Rdsmysql.Ssl("example", new()
        {
            InstanceId = "mysql-xxxxxx",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.volcengine.volcenginecc.rdsmysql.Ssl;
    import com.volcengine.volcenginecc.rdsmysql.SslArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var example = new Ssl("example", SslArgs.builder()
                .instanceId("mysql-xxxxxx")
                .build());
    
        }
    }
    
    resources:
      example:
        type: volcenginecc:rdsmysql:Ssl
        properties:
          instanceId: mysql-xxxxxx
    
    pulumi {
      required_providers {
        volcenginecc = {
          source = "pulumi/volcenginecc"
        }
      }
    }
    
    resource "volcenginecc_rdsmysql_ssl" "example" {
      instance_id = "mysql-xxxxxx"
    }
    

    Create Ssl Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Ssl(name: string, args: SslArgs, opts?: CustomResourceOptions);
    @overload
    def Ssl(resource_name: str,
            args: SslArgs,
            opts: Optional[ResourceOptions] = None)
    
    @overload
    def Ssl(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            instance_id: Optional[str] = None,
            reload_ssl_certificate: Optional[bool] = None)
    func NewSsl(ctx *Context, name string, args SslArgs, opts ...ResourceOption) (*Ssl, error)
    public Ssl(string name, SslArgs args, CustomResourceOptions? opts = null)
    public Ssl(String name, SslArgs args)
    public Ssl(String name, SslArgs args, CustomResourceOptions options)
    
    type: volcenginecc:rdsmysql:Ssl
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "volcenginecc_rdsmysql_ssl" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args SslArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args SslArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args SslArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SslArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SslArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var sslResource = new Volcenginecc.Rdsmysql.Ssl("sslResource", new()
    {
        InstanceId = "string",
        ReloadSslCertificate = false,
    });
    
    example, err := rdsmysql.NewSsl(ctx, "sslResource", &rdsmysql.SslArgs{
    	InstanceId:           pulumi.String("string"),
    	ReloadSslCertificate: pulumi.Bool(false),
    })
    
    resource "volcenginecc_rdsmysql_ssl" "sslResource" {
      lifecycle {
        create_before_destroy = true
      }
      instance_id            = "string"
      reload_ssl_certificate = false
    }
    
    var sslResource = new Ssl("sslResource", SslArgs.builder()
        .instanceId("string")
        .reloadSslCertificate(false)
        .build());
    
    ssl_resource = volcenginecc.rdsmysql.Ssl("sslResource",
        instance_id="string",
        reload_ssl_certificate=False)
    
    const sslResource = new volcenginecc.rdsmysql.Ssl("sslResource", {
        instanceId: "string",
        reloadSslCertificate: false,
    });
    
    type: volcenginecc:rdsmysql:Ssl
    properties:
        instanceId: string
        reloadSslCertificate: false
    

    Ssl Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Ssl resource accepts the following input properties:

    InstanceId string
    Instance ID.
    ReloadSslCertificate bool
    Update SSL certificate validity period. Set to true to update the SSL certificate validity period. Takes effect only when SSL encryption is enabled for the instance, and cannot be modified together with the SSLEnable field.
    InstanceId string
    Instance ID.
    ReloadSslCertificate bool
    Update SSL certificate validity period. Set to true to update the SSL certificate validity period. Takes effect only when SSL encryption is enabled for the instance, and cannot be modified together with the SSLEnable field.
    instance_id string
    Instance ID.
    reload_ssl_certificate bool
    Update SSL certificate validity period. Set to true to update the SSL certificate validity period. Takes effect only when SSL encryption is enabled for the instance, and cannot be modified together with the SSLEnable field.
    instanceId String
    Instance ID.
    reloadSslCertificate Boolean
    Update SSL certificate validity period. Set to true to update the SSL certificate validity period. Takes effect only when SSL encryption is enabled for the instance, and cannot be modified together with the SSLEnable field.
    instanceId string
    Instance ID.
    reloadSslCertificate boolean
    Update SSL certificate validity period. Set to true to update the SSL certificate validity period. Takes effect only when SSL encryption is enabled for the instance, and cannot be modified together with the SSLEnable field.
    instance_id str
    Instance ID.
    reload_ssl_certificate bool
    Update SSL certificate validity period. Set to true to update the SSL certificate validity period. Takes effect only when SSL encryption is enabled for the instance, and cannot be modified together with the SSLEnable field.
    instanceId String
    Instance ID.
    reloadSslCertificate Boolean
    Update SSL certificate validity period. Set to true to update the SSL certificate validity period. Takes effect only when SSL encryption is enabled for the instance, and cannot be modified together with the SSLEnable field.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Ssl resource produces the following output properties:

    Address string
    Protected address.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsValid bool
    Certificate validity. Values:

    - `true`: Valid
    - `false`: Invalid
    SslEnable bool
    SSL switch. Values:

    - `true`: Enabled
    - `false`: Disabled
    SslExpireTime string
    Certificate expiration time. Format: yyyy-MM-dd HH:mm:ss (UTC time).
    TlsVersion string
    Supported TLS versions. Separate multiple versions with commas (,).
    Address string
    Protected address.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsValid bool
    Certificate validity. Values:

    - `true`: Valid
    - `false`: Invalid
    SslEnable bool
    SSL switch. Values:

    - `true`: Enabled
    - `false`: Disabled
    SslExpireTime string
    Certificate expiration time. Format: yyyy-MM-dd HH:mm:ss (UTC time).
    TlsVersion string
    Supported TLS versions. Separate multiple versions with commas (,).
    address string
    Protected address.
    id string
    The provider-assigned unique ID for this managed resource.
    is_valid bool
    Certificate validity. Values:

    - `true`: Valid
    - `false`: Invalid
    ssl_enable bool
    SSL switch. Values:

    - `true`: Enabled
    - `false`: Disabled
    ssl_expire_time string
    Certificate expiration time. Format: yyyy-MM-dd HH:mm:ss (UTC time).
    tls_version string
    Supported TLS versions. Separate multiple versions with commas (,).
    address String
    Protected address.
    id String
    The provider-assigned unique ID for this managed resource.
    isValid Boolean
    Certificate validity. Values:

    - `true`: Valid
    - `false`: Invalid
    sslEnable Boolean
    SSL switch. Values:

    - `true`: Enabled
    - `false`: Disabled
    sslExpireTime String
    Certificate expiration time. Format: yyyy-MM-dd HH:mm:ss (UTC time).
    tlsVersion String
    Supported TLS versions. Separate multiple versions with commas (,).
    address string
    Protected address.
    id string
    The provider-assigned unique ID for this managed resource.
    isValid boolean
    Certificate validity. Values:

    - `true`: Valid
    - `false`: Invalid
    sslEnable boolean
    SSL switch. Values:

    - `true`: Enabled
    - `false`: Disabled
    sslExpireTime string
    Certificate expiration time. Format: yyyy-MM-dd HH:mm:ss (UTC time).
    tlsVersion string
    Supported TLS versions. Separate multiple versions with commas (,).
    address str
    Protected address.
    id str
    The provider-assigned unique ID for this managed resource.
    is_valid bool
    Certificate validity. Values:

    - `true`: Valid
    - `false`: Invalid
    ssl_enable bool
    SSL switch. Values:

    - `true`: Enabled
    - `false`: Disabled
    ssl_expire_time str
    Certificate expiration time. Format: yyyy-MM-dd HH:mm:ss (UTC time).
    tls_version str
    Supported TLS versions. Separate multiple versions with commas (,).
    address String
    Protected address.
    id String
    The provider-assigned unique ID for this managed resource.
    isValid Boolean
    Certificate validity. Values:

    - `true`: Valid
    - `false`: Invalid
    sslEnable Boolean
    SSL switch. Values:

    - `true`: Enabled
    - `false`: Disabled
    sslExpireTime String
    Certificate expiration time. Format: yyyy-MM-dd HH:mm:ss (UTC time).
    tlsVersion String
    Supported TLS versions. Separate multiple versions with commas (,).

    Look up Existing Ssl Resource

    Get an existing Ssl resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: SslState, opts?: CustomResourceOptions): Ssl
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            address: Optional[str] = None,
            instance_id: Optional[str] = None,
            is_valid: Optional[bool] = None,
            reload_ssl_certificate: Optional[bool] = None,
            ssl_enable: Optional[bool] = None,
            ssl_expire_time: Optional[str] = None,
            tls_version: Optional[str] = None) -> Ssl
    func GetSsl(ctx *Context, name string, id IDInput, state *SslState, opts ...ResourceOption) (*Ssl, error)
    public static Ssl Get(string name, Input<string> id, SslState? state, CustomResourceOptions? opts = null)
    public static Ssl get(String name, Output<String> id, SslState state, CustomResourceOptions options)
    resources:  _:    type: volcenginecc:rdsmysql:Ssl    get:      id: ${id}
    import {
      to = volcenginecc_rdsmysql_ssl.example
      id = "${id}"
    }
    
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Address string
    Protected address.
    InstanceId string
    Instance ID.
    IsValid bool
    Certificate validity. Values:

    - `true`: Valid
    - `false`: Invalid
    ReloadSslCertificate bool
    Update SSL certificate validity period. Set to true to update the SSL certificate validity period. Takes effect only when SSL encryption is enabled for the instance, and cannot be modified together with the SSLEnable field.
    SslEnable bool
    SSL switch. Values:

    - `true`: Enabled
    - `false`: Disabled
    SslExpireTime string
    Certificate expiration time. Format: yyyy-MM-dd HH:mm:ss (UTC time).
    TlsVersion string
    Supported TLS versions. Separate multiple versions with commas (,).
    Address string
    Protected address.
    InstanceId string
    Instance ID.
    IsValid bool
    Certificate validity. Values:

    - `true`: Valid
    - `false`: Invalid
    ReloadSslCertificate bool
    Update SSL certificate validity period. Set to true to update the SSL certificate validity period. Takes effect only when SSL encryption is enabled for the instance, and cannot be modified together with the SSLEnable field.
    SslEnable bool
    SSL switch. Values:

    - `true`: Enabled
    - `false`: Disabled
    SslExpireTime string
    Certificate expiration time. Format: yyyy-MM-dd HH:mm:ss (UTC time).
    TlsVersion string
    Supported TLS versions. Separate multiple versions with commas (,).
    address string
    Protected address.
    instance_id string
    Instance ID.
    is_valid bool
    Certificate validity. Values:

    - `true`: Valid
    - `false`: Invalid
    reload_ssl_certificate bool
    Update SSL certificate validity period. Set to true to update the SSL certificate validity period. Takes effect only when SSL encryption is enabled for the instance, and cannot be modified together with the SSLEnable field.
    ssl_enable bool
    SSL switch. Values:

    - `true`: Enabled
    - `false`: Disabled
    ssl_expire_time string
    Certificate expiration time. Format: yyyy-MM-dd HH:mm:ss (UTC time).
    tls_version string
    Supported TLS versions. Separate multiple versions with commas (,).
    address String
    Protected address.
    instanceId String
    Instance ID.
    isValid Boolean
    Certificate validity. Values:

    - `true`: Valid
    - `false`: Invalid
    reloadSslCertificate Boolean
    Update SSL certificate validity period. Set to true to update the SSL certificate validity period. Takes effect only when SSL encryption is enabled for the instance, and cannot be modified together with the SSLEnable field.
    sslEnable Boolean
    SSL switch. Values:

    - `true`: Enabled
    - `false`: Disabled
    sslExpireTime String
    Certificate expiration time. Format: yyyy-MM-dd HH:mm:ss (UTC time).
    tlsVersion String
    Supported TLS versions. Separate multiple versions with commas (,).
    address string
    Protected address.
    instanceId string
    Instance ID.
    isValid boolean
    Certificate validity. Values:

    - `true`: Valid
    - `false`: Invalid
    reloadSslCertificate boolean
    Update SSL certificate validity period. Set to true to update the SSL certificate validity period. Takes effect only when SSL encryption is enabled for the instance, and cannot be modified together with the SSLEnable field.
    sslEnable boolean
    SSL switch. Values:

    - `true`: Enabled
    - `false`: Disabled
    sslExpireTime string
    Certificate expiration time. Format: yyyy-MM-dd HH:mm:ss (UTC time).
    tlsVersion string
    Supported TLS versions. Separate multiple versions with commas (,).
    address str
    Protected address.
    instance_id str
    Instance ID.
    is_valid bool
    Certificate validity. Values:

    - `true`: Valid
    - `false`: Invalid
    reload_ssl_certificate bool
    Update SSL certificate validity period. Set to true to update the SSL certificate validity period. Takes effect only when SSL encryption is enabled for the instance, and cannot be modified together with the SSLEnable field.
    ssl_enable bool
    SSL switch. Values:

    - `true`: Enabled
    - `false`: Disabled
    ssl_expire_time str
    Certificate expiration time. Format: yyyy-MM-dd HH:mm:ss (UTC time).
    tls_version str
    Supported TLS versions. Separate multiple versions with commas (,).
    address String
    Protected address.
    instanceId String
    Instance ID.
    isValid Boolean
    Certificate validity. Values:

    - `true`: Valid
    - `false`: Invalid
    reloadSslCertificate Boolean
    Update SSL certificate validity period. Set to true to update the SSL certificate validity period. Takes effect only when SSL encryption is enabled for the instance, and cannot be modified together with the SSLEnable field.
    sslEnable Boolean
    SSL switch. Values:

    - `true`: Enabled
    - `false`: Disabled
    sslExpireTime String
    Certificate expiration time. Format: yyyy-MM-dd HH:mm:ss (UTC time).
    tlsVersion String
    Supported TLS versions. Separate multiple versions with commas (,).

    Import

    $ pulumi import volcenginecc:rdsmysql/ssl:Ssl example "instance_id"
    

    To learn more about importing existing cloud resources, see Importing resources.

    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.57
    published on Monday, Aug 24, 2026 by Volcengine

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial