1. Packages
  2. Confluent Provider
  3. API Docs
  4. CertificateAuthority
Confluent v2.10.0 published on Wednesday, Nov 20, 2024 by Pulumi

confluentcloud.CertificateAuthority

Explore with Pulumi AI

confluentcloud logo
Confluent v2.10.0 published on Wednesday, Nov 20, 2024 by Pulumi

    General Availability

    confluentcloud.CertificateAuthority provides a Certificate Authority resource that enables creating, editing, and deleting Certificate Authorities on Confluent Cloud.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as confluentcloud from "@pulumi/confluentcloud";
    
    const main = new confluentcloud.CertificateAuthority("main", {
        displayName: "my_certificate_authority",
        description: "description",
        certificateChainFilename: "certificate.pem",
        certificateChain: "***REDACTED***",
    });
    
    import pulumi
    import pulumi_confluentcloud as confluentcloud
    
    main = confluentcloud.CertificateAuthority("main",
        display_name="my_certificate_authority",
        description="description",
        certificate_chain_filename="certificate.pem",
        certificate_chain="***REDACTED***")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-confluentcloud/sdk/v2/go/confluentcloud"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := confluentcloud.NewCertificateAuthority(ctx, "main", &confluentcloud.CertificateAuthorityArgs{
    			DisplayName:              pulumi.String("my_certificate_authority"),
    			Description:              pulumi.String("description"),
    			CertificateChainFilename: pulumi.String("certificate.pem"),
    			CertificateChain:         pulumi.String("***REDACTED***"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using ConfluentCloud = Pulumi.ConfluentCloud;
    
    return await Deployment.RunAsync(() => 
    {
        var main = new ConfluentCloud.CertificateAuthority("main", new()
        {
            DisplayName = "my_certificate_authority",
            Description = "description",
            CertificateChainFilename = "certificate.pem",
            CertificateChain = "***REDACTED***",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.confluentcloud.CertificateAuthority;
    import com.pulumi.confluentcloud.CertificateAuthorityArgs;
    import java.util.List;
    import java.util.ArrayList;
    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 main = new CertificateAuthority("main", CertificateAuthorityArgs.builder()
                .displayName("my_certificate_authority")
                .description("description")
                .certificateChainFilename("certificate.pem")
                .certificateChain("***REDACTED***")
                .build());
    
        }
    }
    
    resources:
      main:
        type: confluentcloud:CertificateAuthority
        properties:
          displayName: my_certificate_authority
          description: description
          certificateChainFilename: certificate.pem
          certificateChain: '***REDACTED***'
    

    Create CertificateAuthority Resource

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

    Constructor syntax

    new CertificateAuthority(name: string, args: CertificateAuthorityArgs, opts?: CustomResourceOptions);
    @overload
    def CertificateAuthority(resource_name: str,
                             args: CertificateAuthorityArgs,
                             opts: Optional[ResourceOptions] = None)
    
    @overload
    def CertificateAuthority(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             certificate_chain: Optional[str] = None,
                             certificate_chain_filename: Optional[str] = None,
                             description: Optional[str] = None,
                             display_name: Optional[str] = None,
                             crl_chain: Optional[str] = None,
                             crl_url: Optional[str] = None)
    func NewCertificateAuthority(ctx *Context, name string, args CertificateAuthorityArgs, opts ...ResourceOption) (*CertificateAuthority, error)
    public CertificateAuthority(string name, CertificateAuthorityArgs args, CustomResourceOptions? opts = null)
    public CertificateAuthority(String name, CertificateAuthorityArgs args)
    public CertificateAuthority(String name, CertificateAuthorityArgs args, CustomResourceOptions options)
    
    type: confluentcloud:CertificateAuthority
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args CertificateAuthorityArgs
    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 CertificateAuthorityArgs
    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 CertificateAuthorityArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CertificateAuthorityArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CertificateAuthorityArgs
    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 certificateAuthorityResource = new ConfluentCloud.CertificateAuthority("certificateAuthorityResource", new()
    {
        CertificateChain = "string",
        CertificateChainFilename = "string",
        Description = "string",
        DisplayName = "string",
        CrlChain = "string",
        CrlUrl = "string",
    });
    
    example, err := confluentcloud.NewCertificateAuthority(ctx, "certificateAuthorityResource", &confluentcloud.CertificateAuthorityArgs{
    	CertificateChain:         pulumi.String("string"),
    	CertificateChainFilename: pulumi.String("string"),
    	Description:              pulumi.String("string"),
    	DisplayName:              pulumi.String("string"),
    	CrlChain:                 pulumi.String("string"),
    	CrlUrl:                   pulumi.String("string"),
    })
    
    var certificateAuthorityResource = new CertificateAuthority("certificateAuthorityResource", CertificateAuthorityArgs.builder()
        .certificateChain("string")
        .certificateChainFilename("string")
        .description("string")
        .displayName("string")
        .crlChain("string")
        .crlUrl("string")
        .build());
    
    certificate_authority_resource = confluentcloud.CertificateAuthority("certificateAuthorityResource",
        certificate_chain="string",
        certificate_chain_filename="string",
        description="string",
        display_name="string",
        crl_chain="string",
        crl_url="string")
    
    const certificateAuthorityResource = new confluentcloud.CertificateAuthority("certificateAuthorityResource", {
        certificateChain: "string",
        certificateChainFilename: "string",
        description: "string",
        displayName: "string",
        crlChain: "string",
        crlUrl: "string",
    });
    
    type: confluentcloud:CertificateAuthority
    properties:
        certificateChain: string
        certificateChainFilename: string
        crlChain: string
        crlUrl: string
        description: string
        displayName: string
    

    CertificateAuthority 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 CertificateAuthority resource accepts the following input properties:

    CertificateChain string
    A base64 encoded string containing the signing certificate chain.
    CertificateChainFilename string
    The name of the certificate file.
    Description string
    A description of the Certificate Authority.
    DisplayName string
    The name of the Certificate Authority.
    CrlChain string
    A base64 encoded string containing the CRL for this certificate authority.
    CrlUrl string
    The url from which to fetch the CRL for the certificate authority.
    CertificateChain string
    A base64 encoded string containing the signing certificate chain.
    CertificateChainFilename string
    The name of the certificate file.
    Description string
    A description of the Certificate Authority.
    DisplayName string
    The name of the Certificate Authority.
    CrlChain string
    A base64 encoded string containing the CRL for this certificate authority.
    CrlUrl string
    The url from which to fetch the CRL for the certificate authority.
    certificateChain String
    A base64 encoded string containing the signing certificate chain.
    certificateChainFilename String
    The name of the certificate file.
    description String
    A description of the Certificate Authority.
    displayName String
    The name of the Certificate Authority.
    crlChain String
    A base64 encoded string containing the CRL for this certificate authority.
    crlUrl String
    The url from which to fetch the CRL for the certificate authority.
    certificateChain string
    A base64 encoded string containing the signing certificate chain.
    certificateChainFilename string
    The name of the certificate file.
    description string
    A description of the Certificate Authority.
    displayName string
    The name of the Certificate Authority.
    crlChain string
    A base64 encoded string containing the CRL for this certificate authority.
    crlUrl string
    The url from which to fetch the CRL for the certificate authority.
    certificate_chain str
    A base64 encoded string containing the signing certificate chain.
    certificate_chain_filename str
    The name of the certificate file.
    description str
    A description of the Certificate Authority.
    display_name str
    The name of the Certificate Authority.
    crl_chain str
    A base64 encoded string containing the CRL for this certificate authority.
    crl_url str
    The url from which to fetch the CRL for the certificate authority.
    certificateChain String
    A base64 encoded string containing the signing certificate chain.
    certificateChainFilename String
    The name of the certificate file.
    description String
    A description of the Certificate Authority.
    displayName String
    The name of the Certificate Authority.
    crlChain String
    A base64 encoded string containing the CRL for this certificate authority.
    crlUrl String
    The url from which to fetch the CRL for the certificate authority.

    Outputs

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

    CrlSource string
    (Optional String) The source specifies whether the Certificate Revocation List (CRL) is updated from either local file uploaded (LOCAL) or from url of CRL (URL).
    CrlUpdatedAt string
    (Optional String) The timestamp for when CRL was last updated.
    ExpirationDates List<string>
    (Required List of Strings) The expiration dates of certificates in the chain.
    Fingerprints List<string>
    (Required List of Strings) The fingerprints for each certificate in the certificate chain.
    Id string
    The provider-assigned unique ID for this managed resource.
    SerialNumbers List<string>
    (Required List of Strings) The serial numbers for each certificate in the certificate chain.
    CrlSource string
    (Optional String) The source specifies whether the Certificate Revocation List (CRL) is updated from either local file uploaded (LOCAL) or from url of CRL (URL).
    CrlUpdatedAt string
    (Optional String) The timestamp for when CRL was last updated.
    ExpirationDates []string
    (Required List of Strings) The expiration dates of certificates in the chain.
    Fingerprints []string
    (Required List of Strings) The fingerprints for each certificate in the certificate chain.
    Id string
    The provider-assigned unique ID for this managed resource.
    SerialNumbers []string
    (Required List of Strings) The serial numbers for each certificate in the certificate chain.
    crlSource String
    (Optional String) The source specifies whether the Certificate Revocation List (CRL) is updated from either local file uploaded (LOCAL) or from url of CRL (URL).
    crlUpdatedAt String
    (Optional String) The timestamp for when CRL was last updated.
    expirationDates List<String>
    (Required List of Strings) The expiration dates of certificates in the chain.
    fingerprints List<String>
    (Required List of Strings) The fingerprints for each certificate in the certificate chain.
    id String
    The provider-assigned unique ID for this managed resource.
    serialNumbers List<String>
    (Required List of Strings) The serial numbers for each certificate in the certificate chain.
    crlSource string
    (Optional String) The source specifies whether the Certificate Revocation List (CRL) is updated from either local file uploaded (LOCAL) or from url of CRL (URL).
    crlUpdatedAt string
    (Optional String) The timestamp for when CRL was last updated.
    expirationDates string[]
    (Required List of Strings) The expiration dates of certificates in the chain.
    fingerprints string[]
    (Required List of Strings) The fingerprints for each certificate in the certificate chain.
    id string
    The provider-assigned unique ID for this managed resource.
    serialNumbers string[]
    (Required List of Strings) The serial numbers for each certificate in the certificate chain.
    crl_source str
    (Optional String) The source specifies whether the Certificate Revocation List (CRL) is updated from either local file uploaded (LOCAL) or from url of CRL (URL).
    crl_updated_at str
    (Optional String) The timestamp for when CRL was last updated.
    expiration_dates Sequence[str]
    (Required List of Strings) The expiration dates of certificates in the chain.
    fingerprints Sequence[str]
    (Required List of Strings) The fingerprints for each certificate in the certificate chain.
    id str
    The provider-assigned unique ID for this managed resource.
    serial_numbers Sequence[str]
    (Required List of Strings) The serial numbers for each certificate in the certificate chain.
    crlSource String
    (Optional String) The source specifies whether the Certificate Revocation List (CRL) is updated from either local file uploaded (LOCAL) or from url of CRL (URL).
    crlUpdatedAt String
    (Optional String) The timestamp for when CRL was last updated.
    expirationDates List<String>
    (Required List of Strings) The expiration dates of certificates in the chain.
    fingerprints List<String>
    (Required List of Strings) The fingerprints for each certificate in the certificate chain.
    id String
    The provider-assigned unique ID for this managed resource.
    serialNumbers List<String>
    (Required List of Strings) The serial numbers for each certificate in the certificate chain.

    Look up Existing CertificateAuthority Resource

    Get an existing CertificateAuthority 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?: CertificateAuthorityState, opts?: CustomResourceOptions): CertificateAuthority
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            certificate_chain: Optional[str] = None,
            certificate_chain_filename: Optional[str] = None,
            crl_chain: Optional[str] = None,
            crl_source: Optional[str] = None,
            crl_updated_at: Optional[str] = None,
            crl_url: Optional[str] = None,
            description: Optional[str] = None,
            display_name: Optional[str] = None,
            expiration_dates: Optional[Sequence[str]] = None,
            fingerprints: Optional[Sequence[str]] = None,
            serial_numbers: Optional[Sequence[str]] = None) -> CertificateAuthority
    func GetCertificateAuthority(ctx *Context, name string, id IDInput, state *CertificateAuthorityState, opts ...ResourceOption) (*CertificateAuthority, error)
    public static CertificateAuthority Get(string name, Input<string> id, CertificateAuthorityState? state, CustomResourceOptions? opts = null)
    public static CertificateAuthority get(String name, Output<String> id, CertificateAuthorityState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    CertificateChain string
    A base64 encoded string containing the signing certificate chain.
    CertificateChainFilename string
    The name of the certificate file.
    CrlChain string
    A base64 encoded string containing the CRL for this certificate authority.
    CrlSource string
    (Optional String) The source specifies whether the Certificate Revocation List (CRL) is updated from either local file uploaded (LOCAL) or from url of CRL (URL).
    CrlUpdatedAt string
    (Optional String) The timestamp for when CRL was last updated.
    CrlUrl string
    The url from which to fetch the CRL for the certificate authority.
    Description string
    A description of the Certificate Authority.
    DisplayName string
    The name of the Certificate Authority.
    ExpirationDates List<string>
    (Required List of Strings) The expiration dates of certificates in the chain.
    Fingerprints List<string>
    (Required List of Strings) The fingerprints for each certificate in the certificate chain.
    SerialNumbers List<string>
    (Required List of Strings) The serial numbers for each certificate in the certificate chain.
    CertificateChain string
    A base64 encoded string containing the signing certificate chain.
    CertificateChainFilename string
    The name of the certificate file.
    CrlChain string
    A base64 encoded string containing the CRL for this certificate authority.
    CrlSource string
    (Optional String) The source specifies whether the Certificate Revocation List (CRL) is updated from either local file uploaded (LOCAL) or from url of CRL (URL).
    CrlUpdatedAt string
    (Optional String) The timestamp for when CRL was last updated.
    CrlUrl string
    The url from which to fetch the CRL for the certificate authority.
    Description string
    A description of the Certificate Authority.
    DisplayName string
    The name of the Certificate Authority.
    ExpirationDates []string
    (Required List of Strings) The expiration dates of certificates in the chain.
    Fingerprints []string
    (Required List of Strings) The fingerprints for each certificate in the certificate chain.
    SerialNumbers []string
    (Required List of Strings) The serial numbers for each certificate in the certificate chain.
    certificateChain String
    A base64 encoded string containing the signing certificate chain.
    certificateChainFilename String
    The name of the certificate file.
    crlChain String
    A base64 encoded string containing the CRL for this certificate authority.
    crlSource String
    (Optional String) The source specifies whether the Certificate Revocation List (CRL) is updated from either local file uploaded (LOCAL) or from url of CRL (URL).
    crlUpdatedAt String
    (Optional String) The timestamp for when CRL was last updated.
    crlUrl String
    The url from which to fetch the CRL for the certificate authority.
    description String
    A description of the Certificate Authority.
    displayName String
    The name of the Certificate Authority.
    expirationDates List<String>
    (Required List of Strings) The expiration dates of certificates in the chain.
    fingerprints List<String>
    (Required List of Strings) The fingerprints for each certificate in the certificate chain.
    serialNumbers List<String>
    (Required List of Strings) The serial numbers for each certificate in the certificate chain.
    certificateChain string
    A base64 encoded string containing the signing certificate chain.
    certificateChainFilename string
    The name of the certificate file.
    crlChain string
    A base64 encoded string containing the CRL for this certificate authority.
    crlSource string
    (Optional String) The source specifies whether the Certificate Revocation List (CRL) is updated from either local file uploaded (LOCAL) or from url of CRL (URL).
    crlUpdatedAt string
    (Optional String) The timestamp for when CRL was last updated.
    crlUrl string
    The url from which to fetch the CRL for the certificate authority.
    description string
    A description of the Certificate Authority.
    displayName string
    The name of the Certificate Authority.
    expirationDates string[]
    (Required List of Strings) The expiration dates of certificates in the chain.
    fingerprints string[]
    (Required List of Strings) The fingerprints for each certificate in the certificate chain.
    serialNumbers string[]
    (Required List of Strings) The serial numbers for each certificate in the certificate chain.
    certificate_chain str
    A base64 encoded string containing the signing certificate chain.
    certificate_chain_filename str
    The name of the certificate file.
    crl_chain str
    A base64 encoded string containing the CRL for this certificate authority.
    crl_source str
    (Optional String) The source specifies whether the Certificate Revocation List (CRL) is updated from either local file uploaded (LOCAL) or from url of CRL (URL).
    crl_updated_at str
    (Optional String) The timestamp for when CRL was last updated.
    crl_url str
    The url from which to fetch the CRL for the certificate authority.
    description str
    A description of the Certificate Authority.
    display_name str
    The name of the Certificate Authority.
    expiration_dates Sequence[str]
    (Required List of Strings) The expiration dates of certificates in the chain.
    fingerprints Sequence[str]
    (Required List of Strings) The fingerprints for each certificate in the certificate chain.
    serial_numbers Sequence[str]
    (Required List of Strings) The serial numbers for each certificate in the certificate chain.
    certificateChain String
    A base64 encoded string containing the signing certificate chain.
    certificateChainFilename String
    The name of the certificate file.
    crlChain String
    A base64 encoded string containing the CRL for this certificate authority.
    crlSource String
    (Optional String) The source specifies whether the Certificate Revocation List (CRL) is updated from either local file uploaded (LOCAL) or from url of CRL (URL).
    crlUpdatedAt String
    (Optional String) The timestamp for when CRL was last updated.
    crlUrl String
    The url from which to fetch the CRL for the certificate authority.
    description String
    A description of the Certificate Authority.
    displayName String
    The name of the Certificate Authority.
    expirationDates List<String>
    (Required List of Strings) The expiration dates of certificates in the chain.
    fingerprints List<String>
    (Required List of Strings) The fingerprints for each certificate in the certificate chain.
    serialNumbers List<String>
    (Required List of Strings) The serial numbers for each certificate in the certificate chain.

    Import

    You can import a Certificate Authority by using Certificate Authority ID, for example:

    $ export CONFLUENT_CLOUD_API_KEY="<cloud_api_key>"

    $ export CONFLUENT_CLOUD_API_SECRET="<cloud_api_secret>"

    $ pulumi import confluentcloud:index/certificateAuthority:CertificateAuthority main op-abc123
    

    !> Warning: Do not forget to delete terminal command history afterwards for security purposes.

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

    Package Details

    Repository
    Confluent Cloud pulumi/pulumi-confluentcloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the confluent Terraform Provider.
    confluentcloud logo
    Confluent v2.10.0 published on Wednesday, Nov 20, 2024 by Pulumi