We recommend new projects start with resources from the AWS provider.
published on Wednesday, Nov 18, 2026 by Pulumi
We recommend new projects start with resources from the AWS provider.
published on Wednesday, Nov 18, 2026 by Pulumi
The AWS::ApiGateway::ClientCertificate resource creates a client certificate that API Gateway uses to configure client-side SSL authentication for sending requests to the integration endpoint.
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[Sequence[_root_inputs.TagArgs]] = 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-native:apigateway:ClientCertificate
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "aws-native_apigateway_client_certificate" "name" {
# resource properties
}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.
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
- The description of the client certificate.
-
List<Pulumi.
Aws Native. Inputs. Tag> - The collection of tags. Each tag element is associated with a given resource.
- Description string
- The description of the client certificate.
-
Tag
Args - The collection of tags. Each tag element is associated with a given resource.
- description string
- The description of the client certificate.
- list(object)
- The collection of tags. Each tag element is associated with a given resource.
- description String
- The description of the client certificate.
- List<Tag>
- The collection of tags. Each tag element is associated with a given resource.
- description string
- The description of the client certificate.
- Tag[]
- The collection of tags. Each tag element is associated with a given resource.
- description str
- The description of the client certificate.
-
Sequence[Tag
Args] - The collection of tags. Each tag element is associated with a given resource.
- description String
- The description of the client certificate.
- List<Property Map>
- The collection of tags. Each tag element is associated with a given resource.
Outputs
All input properties are implicitly available as output properties. Additionally, the ClientCertificate resource produces the following output properties:
- Client
Certificate stringId - The ID for the client certificate. For example:
abc123. - Id string
- The provider-assigned unique ID for this managed resource.
- Client
Certificate stringId - The ID for the client certificate. For example:
abc123. - Id string
- The provider-assigned unique ID for this managed resource.
- client_
certificate_ stringid - The ID for the client certificate. For example:
abc123. - id string
- The provider-assigned unique ID for this managed resource.
- client
Certificate StringId - The ID for the client certificate. For example:
abc123. - id String
- The provider-assigned unique ID for this managed resource.
- client
Certificate stringId - The ID for the client certificate. For example:
abc123. - id string
- The provider-assigned unique ID for this managed resource.
- client_
certificate_ strid - The ID for the client certificate. For example:
abc123. - id str
- The provider-assigned unique ID for this managed resource.
- client
Certificate StringId - The ID for the client certificate. For example:
abc123. - id String
- The provider-assigned unique ID for this managed resource.
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>, opts?: CustomResourceOptions): ClientCertificate@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None) -> ClientCertificatefunc GetClientCertificate(ctx *Context, name string, id IDInput, state *ClientCertificateState, opts ...ResourceOption) (*ClientCertificate, error)public static ClientCertificate Get(string name, Input<string> id, CustomResourceOptions? opts = null)public static ClientCertificate get(String name, Output<String> id, CustomResourceOptions options)resources: existingClientCertificate: type: aws-native:apigateway:ClientCertificate get: id: ${id}import {
to = aws-native_apigateway_client_certificate.example
id = "${id}"
}
- name string
- The unique name of the resulting resource.
- id Input<ID>
- The unique provider ID of the resource to look up.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resulting resource.
- id str
- The unique provider ID of the resource to look up.
- 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 resulting resource.
- id IDInput
- The unique provider ID of the resource to look up.
- state ClientCertificateState
- Pass nil. This resource has no state arguments.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resulting resource.
- id Input<string>
- The unique provider ID of the resource to look up.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resulting resource.
- id Output<String>
- The unique provider ID of the resource to look up.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Supporting Types
Tag, TagArgs
A set of tags to apply to the resource.
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
published on Wednesday, Nov 18, 2026 by Pulumi