Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. apigateway
  5. ClientCertificate
AWS v6.80.0 published on Tuesday, May 6, 2025 by Pulumi
pulumi/pulumi-aws

aws.apigateway.ClientCertificate

Explore with Pulumi AI

aws logo
AWS v6.80.0 published on Tuesday, May 6, 2025 by Pulumi
pulumi/pulumi-aws

    Provides an API Gateway Client Certificate.

    Example Usage

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

const demo = new aws.apigateway.ClientCertificate("demo", {description: "My client certificate"});

    import pulumi
import pulumi_aws as aws

demo = aws.apigateway.ClientCertificate("demo", description="My client certificate")

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/apigateway"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apigateway.NewClientCertificate(ctx, "demo", &apigateway.ClientCertificateArgs{
			Description: pulumi.String("My client certificate"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var demo = new Aws.ApiGateway.ClientCertificate("demo", new()
    {
        Description = "My client certificate",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.apigateway.ClientCertificate;
import com.pulumi.aws.apigateway.ClientCertificateArgs;
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 demo = new ClientCertificate("demo", ClientCertificateArgs.builder()
            .description("My client certificate")
            .build());

    }
}

    resources:
  demo:
    type: aws:apigateway:ClientCertificate
    properties:
      description: My client certificate

    Create ClientCertificate Resource

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

    Constructor syntax

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

@overload
def ClientCertificate(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      description: Optional[str] = None,
                      tags: Optional[Mapping[str, str]] = None)
    func NewClientCertificate(ctx *Context, name string, args *ClientCertificateArgs, opts ...ResourceOption) (*ClientCertificate, error)
    public ClientCertificate(string name, ClientCertificateArgs? args = null, CustomResourceOptions? opts = null)
    public ClientCertificate(String name, ClientCertificateArgs args)
public ClientCertificate(String name, ClientCertificateArgs args, CustomResourceOptions options)

    type: aws:apigateway:ClientCertificate
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 ClientCertificateArgs
    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 ClientCertificateArgs
    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 ClientCertificateArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ClientCertificateArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ClientCertificateArgs
    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 clientCertificateResource = new Aws.ApiGateway.ClientCertificate("clientCertificateResource", new()
{
    Description = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := apigateway.NewClientCertificate(ctx, "clientCertificateResource", &apigateway.ClientCertificateArgs{
	Description: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var clientCertificateResource = new ClientCertificate("clientCertificateResource", ClientCertificateArgs.builder()
    .description("string")
    .tags(Map.of("string", "string"))
    .build());

    client_certificate_resource = aws.apigateway.ClientCertificate("clientCertificateResource",
    description="string",
    tags={
        "string": "string",
    })

    const clientCertificateResource = new aws.apigateway.ClientCertificate("clientCertificateResource", {
    description: "string",
    tags: {
        string: "string",
    },
});

    type: aws:apigateway:ClientCertificate
properties:
    description: string
    tags:
        string: string

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

    Description string
    Description of the client certificate.
    Tags Dictionary<string, string>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    Description string
    Description of the client certificate.
    Tags map[string]string
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    description String
    Description of the client certificate.
    tags Map<String,String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    description string
    Description of the client certificate.
    tags {[key: string]: string}
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    description str
    Description of the client certificate.
    tags Mapping[str, str]
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    description String
    Description of the client certificate.
    tags Map<String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

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

    Arn string
    ARN
    CreatedDate string
    Date when the client certificate was created.
    ExpirationDate string
    Date when the client certificate will expire.
    Id string
    The provider-assigned unique ID for this managed resource.
    PemEncodedCertificate string
    The PEM-encoded public key of the client certificate.
    TagsAll Dictionary<string, string>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    ARN
    CreatedDate string
    Date when the client certificate was created.
    ExpirationDate string
    Date when the client certificate will expire.
    Id string
    The provider-assigned unique ID for this managed resource.
    PemEncodedCertificate string
    The PEM-encoded public key of the client certificate.
    TagsAll map[string]string
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN
    createdDate String
    Date when the client certificate was created.
    expirationDate String
    Date when the client certificate will expire.
    id String
    The provider-assigned unique ID for this managed resource.
    pemEncodedCertificate String
    The PEM-encoded public key of the client certificate.
    tagsAll Map<String,String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    ARN
    createdDate string
    Date when the client certificate was created.
    expirationDate string
    Date when the client certificate will expire.
    id string
    The provider-assigned unique ID for this managed resource.
    pemEncodedCertificate string
    The PEM-encoded public key of the client certificate.
    tagsAll {[key: string]: string}
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    ARN
    created_date str
    Date when the client certificate was created.
    expiration_date str
    Date when the client certificate will expire.
    id str
    The provider-assigned unique ID for this managed resource.
    pem_encoded_certificate str
    The PEM-encoded public key of the client certificate.
    tags_all Mapping[str, str]
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN
    createdDate String
    Date when the client certificate was created.
    expirationDate String
    Date when the client certificate will expire.
    id String
    The provider-assigned unique ID for this managed resource.
    pemEncodedCertificate String
    The PEM-encoded public key of the client certificate.
    tagsAll Map<String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing ClientCertificate Resource

    Get an existing ClientCertificate 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?: ClientCertificateState, opts?: CustomResourceOptions): ClientCertificate
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        created_date: Optional[str] = None,
        description: Optional[str] = None,
        expiration_date: Optional[str] = None,
        pem_encoded_certificate: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> ClientCertificate
    func GetClientCertificate(ctx *Context, name string, id IDInput, state *ClientCertificateState, opts ...ResourceOption) (*ClientCertificate, error)
    public static ClientCertificate Get(string name, Input<string> id, ClientCertificateState? state, CustomResourceOptions? opts = null)
    public static ClientCertificate get(String name, Output<String> id, ClientCertificateState state, CustomResourceOptions options)
    resources:  _:    type: aws:apigateway:ClientCertificate    get:      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:
    Arn string
    ARN
    CreatedDate string
    Date when the client certificate was created.
    Description string
    Description of the client certificate.
    ExpirationDate string
    Date when the client certificate will expire.
    PemEncodedCertificate string
    The PEM-encoded public key of the client certificate.
    Tags Dictionary<string, string>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    ARN
    CreatedDate string
    Date when the client certificate was created.
    Description string
    Description of the client certificate.
    ExpirationDate string
    Date when the client certificate will expire.
    PemEncodedCertificate string
    The PEM-encoded public key of the client certificate.
    Tags map[string]string
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN
    createdDate String
    Date when the client certificate was created.
    description String
    Description of the client certificate.
    expirationDate String
    Date when the client certificate will expire.
    pemEncodedCertificate String
    The PEM-encoded public key of the client certificate.
    tags Map<String,String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    ARN
    createdDate string
    Date when the client certificate was created.
    description string
    Description of the client certificate.
    expirationDate string
    Date when the client certificate will expire.
    pemEncodedCertificate string
    The PEM-encoded public key of the client certificate.
    tags {[key: string]: string}
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    ARN
    created_date str
    Date when the client certificate was created.
    description str
    Description of the client certificate.
    expiration_date str
    Date when the client certificate will expire.
    pem_encoded_certificate str
    The PEM-encoded public key of the client certificate.
    tags Mapping[str, str]
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN
    createdDate String
    Date when the client certificate was created.
    description String
    Description of the client certificate.
    expirationDate String
    Date when the client certificate will expire.
    pemEncodedCertificate String
    The PEM-encoded public key of the client certificate.
    tags Map<String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Import

    Using pulumi import, import API Gateway Client Certificates using the id. For example:

    $ pulumi import aws:apigateway/clientCertificate:ClientCertificate demo ab1cqe

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

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.80.0 published on Tuesday, May 6, 2025 by Pulumi
    pulumi/pulumi-aws