Docs Home
Checkly v2.1.1 published on Tuesday, Mar 11, 2025 by Checkly
checkly.ClientCertificate
Explore with Pulumi AI
Use client certificates to authenticate your API checks to APIs that require mutual TLS (mTLS) authentication, or any other authentication scheme where the requester needs to provide a certificate.
Each client certificate is specific to a domain name, e.g. acme.com and will be used automatically by any API checks targeting that domain.
Changing the value of any attribute forces a new resource to be created.
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: ClientCertificateArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ClientCertificate(resource_name: str,
opts: Optional[ResourceOptions] = None,
certificate: Optional[str] = None,
host: Optional[str] = None,
private_key: Optional[str] = None,
passphrase: Optional[str] = None,
trusted_ca: Optional[str] = None)func NewClientCertificate(ctx *Context, name string, args ClientCertificateArgs, opts ...ResourceOption) (*ClientCertificate, error)public ClientCertificate(string name, ClientCertificateArgs args, CustomResourceOptions? opts = null)
public ClientCertificate(String name, ClientCertificateArgs args)
public ClientCertificate(String name, ClientCertificateArgs args, CustomResourceOptions options)
type: checkly: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 Checkly.ClientCertificate("clientCertificateResource", new()
{
Certificate = "string",
Host = "string",
PrivateKey = "string",
Passphrase = "string",
TrustedCa = "string",
});
example, err := checkly.NewClientCertificate(ctx, "clientCertificateResource", &checkly.ClientCertificateArgs{
Certificate: pulumi.String("string"),
Host: pulumi.String("string"),
PrivateKey: pulumi.String("string"),
Passphrase: pulumi.String("string"),
TrustedCa: pulumi.String("string"),
})
var clientCertificateResource = new ClientCertificate("clientCertificateResource", ClientCertificateArgs.builder()
.certificate("string")
.host("string")
.privateKey("string")
.passphrase("string")
.trustedCa("string")
.build());
client_certificate_resource = checkly.ClientCertificate("clientCertificateResource",
certificate="string",
host="string",
private_key="string",
passphrase="string",
trusted_ca="string")
const clientCertificateResource = new checkly.ClientCertificate("clientCertificateResource", {
certificate: "string",
host: "string",
privateKey: "string",
passphrase: "string",
trustedCa: "string",
});
type: checkly:ClientCertificate
properties:
certificate: string
host: string
passphrase: string
privateKey: string
trustedCa: 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:
- Certificate string
- The client certificate in PEM format.
- Host string
- The host domain that the certificate should be used for.
- Private
Key string - The private key for the certificate in PEM format.
- Passphrase string
- Passphrase for the private key.
- Trusted
Ca string - PEM formatted bundle of CA certificates that the client should trust. The bundle may contain many CA certificates.
- Certificate string
- The client certificate in PEM format.
- Host string
- The host domain that the certificate should be used for.
- Private
Key string - The private key for the certificate in PEM format.
- Passphrase string
- Passphrase for the private key.
- Trusted
Ca string - PEM formatted bundle of CA certificates that the client should trust. The bundle may contain many CA certificates.
- certificate String
- The client certificate in PEM format.
- host String
- The host domain that the certificate should be used for.
- private
Key String - The private key for the certificate in PEM format.
- passphrase String
- Passphrase for the private key.
- trusted
Ca String - PEM formatted bundle of CA certificates that the client should trust. The bundle may contain many CA certificates.
- certificate string
- The client certificate in PEM format.
- host string
- The host domain that the certificate should be used for.
- private
Key string - The private key for the certificate in PEM format.
- passphrase string
- Passphrase for the private key.
- trusted
Ca string - PEM formatted bundle of CA certificates that the client should trust. The bundle may contain many CA certificates.
- certificate str
- The client certificate in PEM format.
- host str
- The host domain that the certificate should be used for.
- private_
key str - The private key for the certificate in PEM format.
- passphrase str
- Passphrase for the private key.
- trusted_
ca str - PEM formatted bundle of CA certificates that the client should trust. The bundle may contain many CA certificates.
- certificate String
- The client certificate in PEM format.
- host String
- The host domain that the certificate should be used for.
- private
Key String - The private key for the certificate in PEM format.
- passphrase String
- Passphrase for the private key.
- trusted
Ca String - PEM formatted bundle of CA certificates that the client should trust. The bundle may contain many CA certificates.
Outputs
All input properties are implicitly available as output properties. Additionally, the ClientCertificate resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- 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>, state?: ClientCertificateState, opts?: CustomResourceOptions): ClientCertificate@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
certificate: Optional[str] = None,
host: Optional[str] = None,
passphrase: Optional[str] = None,
private_key: Optional[str] = None,
trusted_ca: Optional[str] = None) -> ClientCertificatefunc 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: checkly: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.
- Certificate string
- The client certificate in PEM format.
- Host string
- The host domain that the certificate should be used for.
- Passphrase string
- Passphrase for the private key.
- Private
Key string - The private key for the certificate in PEM format.
- Trusted
Ca string - PEM formatted bundle of CA certificates that the client should trust. The bundle may contain many CA certificates.
- Certificate string
- The client certificate in PEM format.
- Host string
- The host domain that the certificate should be used for.
- Passphrase string
- Passphrase for the private key.
- Private
Key string - The private key for the certificate in PEM format.
- Trusted
Ca string - PEM formatted bundle of CA certificates that the client should trust. The bundle may contain many CA certificates.
- certificate String
- The client certificate in PEM format.
- host String
- The host domain that the certificate should be used for.
- passphrase String
- Passphrase for the private key.
- private
Key String - The private key for the certificate in PEM format.
- trusted
Ca String - PEM formatted bundle of CA certificates that the client should trust. The bundle may contain many CA certificates.
- certificate string
- The client certificate in PEM format.
- host string
- The host domain that the certificate should be used for.
- passphrase string
- Passphrase for the private key.
- private
Key string - The private key for the certificate in PEM format.
- trusted
Ca string - PEM formatted bundle of CA certificates that the client should trust. The bundle may contain many CA certificates.
- certificate str
- The client certificate in PEM format.
- host str
- The host domain that the certificate should be used for.
- passphrase str
- Passphrase for the private key.
- private_
key str - The private key for the certificate in PEM format.
- trusted_
ca str - PEM formatted bundle of CA certificates that the client should trust. The bundle may contain many CA certificates.
- certificate String
- The client certificate in PEM format.
- host String
- The host domain that the certificate should be used for.
- passphrase String
- Passphrase for the private key.
- private
Key String - The private key for the certificate in PEM format.
- trusted
Ca String - PEM formatted bundle of CA certificates that the client should trust. The bundle may contain many CA certificates.
Package Details
- Repository
- checkly checkly/pulumi-checkly
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
checklyTerraform Provider.