Pulumi Registry
← All packages

AWS Classic

v4.35.0 published on Tuesday, Jan 18, 2022 by Pulumi
Source code
  1. AWS Classic
  2. apigateway
  3. ClientCertificate

ClientCertificate

Provides an API Gateway Client Certificate.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var demo = new Aws.ApiGateway.ClientCertificate("demo", new Aws.ApiGateway.ClientCertificateArgs
        {
            Description = "My client certificate",
        });
    }

}

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v4/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
	})
}

import pulumi
import pulumi_aws as aws

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

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

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

Create a ClientCertificate Resource

new ClientCertificate(name: string, args?: ClientCertificateArgs, opts?: CustomResourceOptions);
 
@overload
def ClientCertificate(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      description: Optional[str] = None,
                      tags: Optional[Mapping[str, str]] = None)
@overload
def ClientCertificate(resource_name: str,
                      args: Optional[ClientCertificateArgs] = None,
                      opts: Optional[ResourceOptions] = None)
 
func NewClientCertificate(ctx *Context, name string, args *ClientCertificateArgs, opts ...ResourceOption) (*ClientCertificate, error)
 
public ClientCertificate(string name, ClientCertificateArgs? args = null, CustomResourceOptions? opts = null)
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.

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

The ClientCertificate resource accepts the following input properties:

Description string
The 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
The 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
The 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
The 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.

Outputs

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

Arn string
Amazon Resource Name (ARN)
CreatedDate string
The date when the client certificate was created.
ExpirationDate string
The 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>
A map of tags assigned to the resource, including those inherited from the provider .
Arn string
Amazon Resource Name (ARN)
CreatedDate string
The date when the client certificate was created.
ExpirationDate string
The 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
A map of tags assigned to the resource, including those inherited from the provider .
arn string
Amazon Resource Name (ARN)
createdDate string
The date when the client certificate was created.
expirationDate string
The 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}
A map of tags assigned to the resource, including those inherited from the provider .
arn str
Amazon Resource Name (ARN)
created_date str
The date when the client certificate was created.
expiration_date str
The 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]
A map of tags assigned to the resource, including those inherited from the provider .

Look up an 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)
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.

The following state arguments are supported:

Arn string
Amazon Resource Name (ARN)
CreatedDate string
The date when the client certificate was created.
Description string
The description of the client certificate.
ExpirationDate string
The 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>
A map of tags assigned to the resource, including those inherited from the provider .
Arn string
Amazon Resource Name (ARN)
CreatedDate string
The date when the client certificate was created.
Description string
The description of the client certificate.
ExpirationDate string
The 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
A map of tags assigned to the resource, including those inherited from the provider .
arn string
Amazon Resource Name (ARN)
createdDate string
The date when the client certificate was created.
description string
The description of the client certificate.
expirationDate string
The 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}
A map of tags assigned to the resource, including those inherited from the provider .
arn str
Amazon Resource Name (ARN)
created_date str
The date when the client certificate was created.
description str
The description of the client certificate.
expiration_date str
The 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]
A map of tags assigned to the resource, including those inherited from the provider .

Import

API Gateway Client Certificates can be imported using the id, e.g.,

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

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.