1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. apigateway
  5. getClientCertificate

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

aws-native.apigateway.getClientCertificate

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 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.

Using getClientCertificate

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getClientCertificate(args: GetClientCertificateArgs, opts?: InvokeOptions): Promise<GetClientCertificateResult>
function getClientCertificateOutput(args: GetClientCertificateOutputArgs, opts?: InvokeOptions): Output<GetClientCertificateResult>
Copy
def get_client_certificate(client_certificate_id: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetClientCertificateResult
def get_client_certificate_output(client_certificate_id: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetClientCertificateResult]
Copy
func LookupClientCertificate(ctx *Context, args *LookupClientCertificateArgs, opts ...InvokeOption) (*LookupClientCertificateResult, error)
func LookupClientCertificateOutput(ctx *Context, args *LookupClientCertificateOutputArgs, opts ...InvokeOption) LookupClientCertificateResultOutput
Copy

> Note: This function is named LookupClientCertificate in the Go SDK.

public static class GetClientCertificate 
{
    public static Task<GetClientCertificateResult> InvokeAsync(GetClientCertificateArgs args, InvokeOptions? opts = null)
    public static Output<GetClientCertificateResult> Invoke(GetClientCertificateInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetClientCertificateResult> getClientCertificate(GetClientCertificateArgs args, InvokeOptions options)
public static Output<GetClientCertificateResult> getClientCertificate(GetClientCertificateArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:apigateway:getClientCertificate
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ClientCertificateId This property is required. string
The ID for the client certificate. For example: abc123 .
ClientCertificateId This property is required. string
The ID for the client certificate. For example: abc123 .
clientCertificateId This property is required. String
The ID for the client certificate. For example: abc123 .
clientCertificateId This property is required. string
The ID for the client certificate. For example: abc123 .
client_certificate_id This property is required. str
The ID for the client certificate. For example: abc123 .
clientCertificateId This property is required. String
The ID for the client certificate. For example: abc123 .

getClientCertificate Result

The following output properties are available:

ClientCertificateId string
The ID for the client certificate. For example: abc123 .
Description string
The description of the client certificate.
Tags List<Pulumi.AwsNative.Outputs.Tag>
The collection of tags. Each tag element is associated with a given resource.
ClientCertificateId string
The ID for the client certificate. For example: abc123 .
Description string
The description of the client certificate.
Tags Tag
The collection of tags. Each tag element is associated with a given resource.
clientCertificateId String
The ID for the client certificate. For example: abc123 .
description String
The description of the client certificate.
tags List<Tag>
The collection of tags. Each tag element is associated with a given resource.
clientCertificateId string
The ID for the client certificate. For example: abc123 .
description string
The description of the client certificate.
tags Tag[]
The collection of tags. Each tag element is associated with a given resource.
client_certificate_id str
The ID for the client certificate. For example: abc123 .
description str
The description of the client certificate.
tags Sequence[root_Tag]
The collection of tags. Each tag element is associated with a given resource.
clientCertificateId String
The ID for the client certificate. For example: abc123 .
description String
The description of the client certificate.
tags List<Property Map>
The collection of tags. Each tag element is associated with a given resource.

Supporting Types

Tag

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi