Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Confluent Provider
  3. API Docs
  4. CertificatePool
Confluent v2.10.0 published on Wednesday, Nov 20, 2024 by Pulumi
pulumi/pulumi-confluentcloud

confluentcloud.CertificatePool

Explore with Pulumi AI

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

    General Availability

    confluentcloud.CertificatePool provides a Certificate Pool resource that enables creating, editing, and deleting Certificate Pools on Confluent Cloud.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as confluentcloud from "@pulumi/confluentcloud";

const main = new confluentcloud.CertificatePool("main", {
    certificateAuthority: {
        id: mainConfluentCertificateAuthority.id,
    },
    displayName: "my-certificate-pool",
    description: "example description",
    externalIdentifier: "CN",
    filter: "CN == \"test\"",
});

    import pulumi
import pulumi_confluentcloud as confluentcloud

main = confluentcloud.CertificatePool("main",
    certificate_authority={
        "id": main_confluent_certificate_authority["id"],
    },
    display_name="my-certificate-pool",
    description="example description",
    external_identifier="CN",
    filter="CN == \"test\"")

    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.NewCertificatePool(ctx, "main", &confluentcloud.CertificatePoolArgs{
			CertificateAuthority: &confluentcloud.CertificatePoolCertificateAuthorityArgs{
				Id: pulumi.Any(mainConfluentCertificateAuthority.Id),
			},
			DisplayName:        pulumi.String("my-certificate-pool"),
			Description:        pulumi.String("example description"),
			ExternalIdentifier: pulumi.String("CN"),
			Filter:             pulumi.String("CN == \"test\""),
		})
		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.CertificatePool("main", new()
    {
        CertificateAuthority = new ConfluentCloud.Inputs.CertificatePoolCertificateAuthorityArgs
        {
            Id = mainConfluentCertificateAuthority.Id,
        },
        DisplayName = "my-certificate-pool",
        Description = "example description",
        ExternalIdentifier = "CN",
        Filter = "CN == \"test\"",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.confluentcloud.CertificatePool;
import com.pulumi.confluentcloud.CertificatePoolArgs;
import com.pulumi.confluentcloud.inputs.CertificatePoolCertificateAuthorityArgs;
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 CertificatePool("main", CertificatePoolArgs.builder()
            .certificateAuthority(CertificatePoolCertificateAuthorityArgs.builder()
                .id(mainConfluentCertificateAuthority.id())
                .build())
            .displayName("my-certificate-pool")
            .description("example description")
            .externalIdentifier("CN")
            .filter("CN == \"test\"")
            .build());

    }
}

    resources:
  main:
    type: confluentcloud:CertificatePool
    properties:
      certificateAuthority:
        id: ${mainConfluentCertificateAuthority.id}
      displayName: my-certificate-pool
      description: example description
      externalIdentifier: CN
      filter: CN == "test"

    Create CertificatePool Resource

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

    Constructor syntax

    new CertificatePool(name: string, args: CertificatePoolArgs, opts?: CustomResourceOptions);
    @overload
def CertificatePool(resource_name: str,
                    args: CertificatePoolArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def CertificatePool(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    certificate_authority: Optional[CertificatePoolCertificateAuthorityArgs] = None,
                    description: Optional[str] = None,
                    display_name: Optional[str] = None,
                    external_identifier: Optional[str] = None,
                    filter: Optional[str] = None)
    func NewCertificatePool(ctx *Context, name string, args CertificatePoolArgs, opts ...ResourceOption) (*CertificatePool, error)
    public CertificatePool(string name, CertificatePoolArgs args, CustomResourceOptions? opts = null)
    public CertificatePool(String name, CertificatePoolArgs args)
public CertificatePool(String name, CertificatePoolArgs args, CustomResourceOptions options)

    type: confluentcloud:CertificatePool
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 CertificatePoolArgs
    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 CertificatePoolArgs
    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 CertificatePoolArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CertificatePoolArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CertificatePoolArgs
    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 certificatePoolResource = new ConfluentCloud.CertificatePool("certificatePoolResource", new()
{
    CertificateAuthority = new ConfluentCloud.Inputs.CertificatePoolCertificateAuthorityArgs
    {
        Id = "string",
    },
    Description = "string",
    DisplayName = "string",
    ExternalIdentifier = "string",
    Filter = "string",
});

    example, err := confluentcloud.NewCertificatePool(ctx, "certificatePoolResource", &confluentcloud.CertificatePoolArgs{
	CertificateAuthority: &confluentcloud.CertificatePoolCertificateAuthorityArgs{
		Id: pulumi.String("string"),
	},
	Description:        pulumi.String("string"),
	DisplayName:        pulumi.String("string"),
	ExternalIdentifier: pulumi.String("string"),
	Filter:             pulumi.String("string"),
})

    var certificatePoolResource = new CertificatePool("certificatePoolResource", CertificatePoolArgs.builder()
    .certificateAuthority(CertificatePoolCertificateAuthorityArgs.builder()
        .id("string")
        .build())
    .description("string")
    .displayName("string")
    .externalIdentifier("string")
    .filter("string")
    .build());

    certificate_pool_resource = confluentcloud.CertificatePool("certificatePoolResource",
    certificate_authority={
        "id": "string",
    },
    description="string",
    display_name="string",
    external_identifier="string",
    filter="string")

    const certificatePoolResource = new confluentcloud.CertificatePool("certificatePoolResource", {
    certificateAuthority: {
        id: "string",
    },
    description: "string",
    displayName: "string",
    externalIdentifier: "string",
    filter: "string",
});

    type: confluentcloud:CertificatePool
properties:
    certificateAuthority:
        id: string
    description: string
    displayName: string
    externalIdentifier: string
    filter: string

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

    CertificateAuthority Pulumi.ConfluentCloud.Inputs.CertificatePoolCertificateAuthority
    Description string
    A description of the Certificate Pool.
    DisplayName string
    The name of the Certificate Pool.
    ExternalIdentifier string
    The certificate field that will be used to represent the pool's external identity for audit logging.
    Filter string
    A filter expression in Supported Common Expression Language (CEL) that specifies which identities can authenticate using your certificate pool.
    CertificateAuthority CertificatePoolCertificateAuthorityArgs
    Description string
    A description of the Certificate Pool.
    DisplayName string
    The name of the Certificate Pool.
    ExternalIdentifier string
    The certificate field that will be used to represent the pool's external identity for audit logging.
    Filter string
    A filter expression in Supported Common Expression Language (CEL) that specifies which identities can authenticate using your certificate pool.
    certificateAuthority CertificatePoolCertificateAuthority
    description String
    A description of the Certificate Pool.
    displayName String
    The name of the Certificate Pool.
    externalIdentifier String
    The certificate field that will be used to represent the pool's external identity for audit logging.
    filter String
    A filter expression in Supported Common Expression Language (CEL) that specifies which identities can authenticate using your certificate pool.
    certificateAuthority CertificatePoolCertificateAuthority
    description string
    A description of the Certificate Pool.
    displayName string
    The name of the Certificate Pool.
    externalIdentifier string
    The certificate field that will be used to represent the pool's external identity for audit logging.
    filter string
    A filter expression in Supported Common Expression Language (CEL) that specifies which identities can authenticate using your certificate pool.
    certificate_authority CertificatePoolCertificateAuthorityArgs
    description str
    A description of the Certificate Pool.
    display_name str
    The name of the Certificate Pool.
    external_identifier str
    The certificate field that will be used to represent the pool's external identity for audit logging.
    filter str
    A filter expression in Supported Common Expression Language (CEL) that specifies which identities can authenticate using your certificate pool.
    certificateAuthority Property Map
    description String
    A description of the Certificate Pool.
    displayName String
    The name of the Certificate Pool.
    externalIdentifier String
    The certificate field that will be used to represent the pool's external identity for audit logging.
    filter String
    A filter expression in Supported Common Expression Language (CEL) that specifies which identities can authenticate using your certificate pool.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing CertificatePool Resource

    Get an existing CertificatePool 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?: CertificatePoolState, opts?: CustomResourceOptions): CertificatePool
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        certificate_authority: Optional[CertificatePoolCertificateAuthorityArgs] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        external_identifier: Optional[str] = None,
        filter: Optional[str] = None) -> CertificatePool
    func GetCertificatePool(ctx *Context, name string, id IDInput, state *CertificatePoolState, opts ...ResourceOption) (*CertificatePool, error)
    public static CertificatePool Get(string name, Input<string> id, CertificatePoolState? state, CustomResourceOptions? opts = null)
    public static CertificatePool get(String name, Output<String> id, CertificatePoolState 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:
    CertificateAuthority Pulumi.ConfluentCloud.Inputs.CertificatePoolCertificateAuthority
    Description string
    A description of the Certificate Pool.
    DisplayName string
    The name of the Certificate Pool.
    ExternalIdentifier string
    The certificate field that will be used to represent the pool's external identity for audit logging.
    Filter string
    A filter expression in Supported Common Expression Language (CEL) that specifies which identities can authenticate using your certificate pool.
    CertificateAuthority CertificatePoolCertificateAuthorityArgs
    Description string
    A description of the Certificate Pool.
    DisplayName string
    The name of the Certificate Pool.
    ExternalIdentifier string
    The certificate field that will be used to represent the pool's external identity for audit logging.
    Filter string
    A filter expression in Supported Common Expression Language (CEL) that specifies which identities can authenticate using your certificate pool.
    certificateAuthority CertificatePoolCertificateAuthority
    description String
    A description of the Certificate Pool.
    displayName String
    The name of the Certificate Pool.
    externalIdentifier String
    The certificate field that will be used to represent the pool's external identity for audit logging.
    filter String
    A filter expression in Supported Common Expression Language (CEL) that specifies which identities can authenticate using your certificate pool.
    certificateAuthority CertificatePoolCertificateAuthority
    description string
    A description of the Certificate Pool.
    displayName string
    The name of the Certificate Pool.
    externalIdentifier string
    The certificate field that will be used to represent the pool's external identity for audit logging.
    filter string
    A filter expression in Supported Common Expression Language (CEL) that specifies which identities can authenticate using your certificate pool.
    certificate_authority CertificatePoolCertificateAuthorityArgs
    description str
    A description of the Certificate Pool.
    display_name str
    The name of the Certificate Pool.
    external_identifier str
    The certificate field that will be used to represent the pool's external identity for audit logging.
    filter str
    A filter expression in Supported Common Expression Language (CEL) that specifies which identities can authenticate using your certificate pool.
    certificateAuthority Property Map
    description String
    A description of the Certificate Pool.
    displayName String
    The name of the Certificate Pool.
    externalIdentifier String
    The certificate field that will be used to represent the pool's external identity for audit logging.
    filter String
    A filter expression in Supported Common Expression Language (CEL) that specifies which identities can authenticate using your certificate pool.

    Supporting Types

    CertificatePoolCertificateAuthority, CertificatePoolCertificateAuthorityArgs

    Id string
    The ID of the Certificate Authority for this Certificate Pool, for example, op-123abc.
    Id string
    The ID of the Certificate Authority for this Certificate Pool, for example, op-123abc.
    id String
    The ID of the Certificate Authority for this Certificate Pool, for example, op-123abc.
    id string
    The ID of the Certificate Authority for this Certificate Pool, for example, op-123abc.
    id str
    The ID of the Certificate Authority for this Certificate Pool, for example, op-123abc.
    id String
    The ID of the Certificate Authority for this Certificate Pool, for example, op-123abc.

    Import

    You can import a Certificate Pool by using Certificate Authority ID and Certificate Pool ID, in the format <Certificate Authority ID>/<Certificate Pool ID>. The following example shows how to import a Certificate Pool:

    $ export CONFLUENT_CLOUD_API_KEY="<cloud_api_key>"

    $ export CONFLUENT_CLOUD_API_SECRET="<cloud_api_secret>"

    $ pulumi import confluentcloud:index/certificatePool:CertificatePool main op-abc123/pool-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
    pulumi/pulumi-confluentcloud