Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. apigateway
  5. ClientCertificate

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
pulumi/pulumi-aws-native

aws-native.apigateway.ClientCertificate

Explore with Pulumi AI

aws-native logo

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
pulumi/pulumi-aws-native

    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.

    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.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    The collection of tags. Each tag element is associated with a given resource.
    Description string
    The description of the client certificate.
    Tags TagArgs
    The collection of tags. Each tag element is associated with a given resource.
    description String
    The description of the client certificate.
    tags List<Tag>
    The collection of tags. Each tag element is associated with a given resource.
    description string
    The description of the client certificate.
    tags Tag[]
    The collection of tags. Each tag element is associated with a given resource.
    description str
    The description of the client certificate.
    tags Sequence[TagArgs]
    The collection of tags. Each tag element is associated with a given resource.
    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.

    Outputs

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

    ClientCertificateId string
    The ID for the client certificate. For example: abc123 .
    Id string
    The provider-assigned unique ID for this managed resource.
    ClientCertificateId string
    The ID for the client certificate. For example: abc123 .
    Id string
    The provider-assigned unique ID for this managed resource.
    clientCertificateId String
    The ID for the client certificate. For example: abc123 .
    id String
    The provider-assigned unique ID for this managed resource.
    clientCertificateId string
    The ID for the client certificate. For example: abc123 .
    id string
    The provider-assigned unique ID for this managed resource.
    client_certificate_id str
    The ID for the client certificate. For example: abc123 .
    id str
    The provider-assigned unique ID for this managed resource.
    clientCertificateId String
    The ID for the client certificate. For example: abc123 .
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

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

    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
    pulumi/pulumi-aws-native