Docs Home
Cloudflare v5.49.1 published on Tuesday, Feb 18, 2025 by Pulumi
cloudflare.ZeroTrustGatewayCertificate
Explore with Pulumi AI
Provides a Cloudflare Teams Gateway Certificate resource. A Teams Certificate can be specified for Gateway TLS interception and block pages.
Create ZeroTrustGatewayCertificate Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ZeroTrustGatewayCertificate(name: string, args: ZeroTrustGatewayCertificateArgs, opts?: CustomResourceOptions);@overload
def ZeroTrustGatewayCertificate(resource_name: str,
args: ZeroTrustGatewayCertificateArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ZeroTrustGatewayCertificate(resource_name: str,
opts: Optional[ResourceOptions] = None,
account_id: Optional[str] = None,
activate: Optional[bool] = None,
custom: Optional[bool] = None,
gateway_managed: Optional[bool] = None,
validity_period_days: Optional[int] = None)func NewZeroTrustGatewayCertificate(ctx *Context, name string, args ZeroTrustGatewayCertificateArgs, opts ...ResourceOption) (*ZeroTrustGatewayCertificate, error)public ZeroTrustGatewayCertificate(string name, ZeroTrustGatewayCertificateArgs args, CustomResourceOptions? opts = null)public ZeroTrustGatewayCertificate(String name, ZeroTrustGatewayCertificateArgs args)
public ZeroTrustGatewayCertificate(String name, ZeroTrustGatewayCertificateArgs args, CustomResourceOptions options)
type: cloudflare:ZeroTrustGatewayCertificate
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name
This property is required. string - The unique name of the resource.
- args
This property is required. ZeroTrustGatewayCertificateArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
This property is required. str - The unique name of the resource.
- args
This property is required. ZeroTrustGatewayCertificateArgs - The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. ZeroTrustGatewayCertificateArgs - The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. ZeroTrustGatewayCertificateArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name
This property is required. String - The unique name of the resource.
- args
This property is required. ZeroTrustGatewayCertificateArgs - 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 zeroTrustGatewayCertificateResource = new Cloudflare.ZeroTrustGatewayCertificate("zeroTrustGatewayCertificateResource", new()
{
AccountId = "string",
Activate = false,
Custom = false,
GatewayManaged = false,
ValidityPeriodDays = 0,
});
example, err := cloudflare.NewZeroTrustGatewayCertificate(ctx, "zeroTrustGatewayCertificateResource", &cloudflare.ZeroTrustGatewayCertificateArgs{
AccountId: pulumi.String("string"),
Activate: pulumi.Bool(false),
Custom: pulumi.Bool(false),
GatewayManaged: pulumi.Bool(false),
ValidityPeriodDays: pulumi.Int(0),
})
var zeroTrustGatewayCertificateResource = new ZeroTrustGatewayCertificate("zeroTrustGatewayCertificateResource", ZeroTrustGatewayCertificateArgs.builder()
.accountId("string")
.activate(false)
.custom(false)
.gatewayManaged(false)
.validityPeriodDays(0)
.build());
zero_trust_gateway_certificate_resource = cloudflare.ZeroTrustGatewayCertificate("zeroTrustGatewayCertificateResource",
account_id="string",
activate=False,
custom=False,
gateway_managed=False,
validity_period_days=0)
const zeroTrustGatewayCertificateResource = new cloudflare.ZeroTrustGatewayCertificate("zeroTrustGatewayCertificateResource", {
accountId: "string",
activate: false,
custom: false,
gatewayManaged: false,
validityPeriodDays: 0,
});
type: cloudflare:ZeroTrustGatewayCertificate
properties:
accountId: string
activate: false
custom: false
gatewayManaged: false
validityPeriodDays: 0
ZeroTrustGatewayCertificate 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 ZeroTrustGatewayCertificate resource accepts the following input properties:
- Account
Id This property is required. string - The account identifier to target for the resource.
- Activate bool
- Whether or not to activate a certificate. A certificate must be activated to use in Gateway certificate settings. Defaults to
false. - Custom bool
- The type of certificate (custom or Gateway-managed). Must provide only one of
custom,gateway_managed. - Gateway
Managed bool - The type of certificate (custom or Gateway-managed). Must provide only one of
custom,gateway_managed. - Validity
Period Days 
Changes to this property will trigger replacement. - Number of days the generated certificate will be valid, minimum 1 day and maximum 30 years. Defaults to 5 years. Defaults to
1826. Required when usinggateway_managed. Conflicts withcustom. Modifying this attribute will force creation of a new resource.
- Account
Id This property is required. string - The account identifier to target for the resource.
- Activate bool
- Whether or not to activate a certificate. A certificate must be activated to use in Gateway certificate settings. Defaults to
false. - Custom bool
- The type of certificate (custom or Gateway-managed). Must provide only one of
custom,gateway_managed. - Gateway
Managed bool - The type of certificate (custom or Gateway-managed). Must provide only one of
custom,gateway_managed. - Validity
Period Days - Number of days the generated certificate will be valid, minimum 1 day and maximum 30 years. Defaults to 5 years. Defaults to
1826. Required when usinggateway_managed. Conflicts withcustom. Modifying this attribute will force creation of a new resource.
- account
Id This property is required. String - The account identifier to target for the resource.
- activate Boolean
- Whether or not to activate a certificate. A certificate must be activated to use in Gateway certificate settings. Defaults to
false. - custom Boolean
- The type of certificate (custom or Gateway-managed). Must provide only one of
custom,gateway_managed. - gateway
Managed Boolean - The type of certificate (custom or Gateway-managed). Must provide only one of
custom,gateway_managed. - validity
Period Days - Number of days the generated certificate will be valid, minimum 1 day and maximum 30 years. Defaults to 5 years. Defaults to
1826. Required when usinggateway_managed. Conflicts withcustom. Modifying this attribute will force creation of a new resource.
- account
Id This property is required. string - The account identifier to target for the resource.
- activate boolean
- Whether or not to activate a certificate. A certificate must be activated to use in Gateway certificate settings. Defaults to
false. - custom boolean
- The type of certificate (custom or Gateway-managed). Must provide only one of
custom,gateway_managed. - gateway
Managed boolean - The type of certificate (custom or Gateway-managed). Must provide only one of
custom,gateway_managed. - validity
Period Days - Number of days the generated certificate will be valid, minimum 1 day and maximum 30 years. Defaults to 5 years. Defaults to
1826. Required when usinggateway_managed. Conflicts withcustom. Modifying this attribute will force creation of a new resource.
- account_
id This property is required. str - The account identifier to target for the resource.
- activate bool
- Whether or not to activate a certificate. A certificate must be activated to use in Gateway certificate settings. Defaults to
false. - custom bool
- The type of certificate (custom or Gateway-managed). Must provide only one of
custom,gateway_managed. - gateway_
managed bool - The type of certificate (custom or Gateway-managed). Must provide only one of
custom,gateway_managed. - validity_
period_ days - Number of days the generated certificate will be valid, minimum 1 day and maximum 30 years. Defaults to 5 years. Defaults to
1826. Required when usinggateway_managed. Conflicts withcustom. Modifying this attribute will force creation of a new resource.
- account
Id This property is required. String - The account identifier to target for the resource.
- activate Boolean
- Whether or not to activate a certificate. A certificate must be activated to use in Gateway certificate settings. Defaults to
false. - custom Boolean
- The type of certificate (custom or Gateway-managed). Must provide only one of
custom,gateway_managed. - gateway
Managed Boolean - The type of certificate (custom or Gateway-managed). Must provide only one of
custom,gateway_managed. - validity
Period Days - Number of days the generated certificate will be valid, minimum 1 day and maximum 30 years. Defaults to 5 years. Defaults to
1826. Required when usinggateway_managed. Conflicts withcustom. Modifying this attribute will force creation of a new resource.
Outputs
All input properties are implicitly available as output properties. Additionally, the ZeroTrustGatewayCertificate resource produces the following output properties:
- Binding
Status string - The deployment status of the certificate on the edge Available values:
IP,SERIAL,URL,DOMAIN,EMAIL. - Created
At string - Expires
On string - Id string
- The provider-assigned unique ID for this managed resource.
- In
Use bool - Whether the certificate is in use by Gateway for TLS interception and the block page.
- Qs
Pack stringId - Uploaded
On string
- Binding
Status string - The deployment status of the certificate on the edge Available values:
IP,SERIAL,URL,DOMAIN,EMAIL. - Created
At string - Expires
On string - Id string
- The provider-assigned unique ID for this managed resource.
- In
Use bool - Whether the certificate is in use by Gateway for TLS interception and the block page.
- Qs
Pack stringId - Uploaded
On string
- binding
Status String - The deployment status of the certificate on the edge Available values:
IP,SERIAL,URL,DOMAIN,EMAIL. - created
At String - expires
On String - id String
- The provider-assigned unique ID for this managed resource.
- in
Use Boolean - Whether the certificate is in use by Gateway for TLS interception and the block page.
- qs
Pack StringId - uploaded
On String
- binding
Status string - The deployment status of the certificate on the edge Available values:
IP,SERIAL,URL,DOMAIN,EMAIL. - created
At string - expires
On string - id string
- The provider-assigned unique ID for this managed resource.
- in
Use boolean - Whether the certificate is in use by Gateway for TLS interception and the block page.
- qs
Pack stringId - uploaded
On string
- binding_
status str - The deployment status of the certificate on the edge Available values:
IP,SERIAL,URL,DOMAIN,EMAIL. - created_
at str - expires_
on str - id str
- The provider-assigned unique ID for this managed resource.
- in_
use bool - Whether the certificate is in use by Gateway for TLS interception and the block page.
- qs_
pack_ strid - uploaded_
on str
- binding
Status String - The deployment status of the certificate on the edge Available values:
IP,SERIAL,URL,DOMAIN,EMAIL. - created
At String - expires
On String - id String
- The provider-assigned unique ID for this managed resource.
- in
Use Boolean - Whether the certificate is in use by Gateway for TLS interception and the block page.
- qs
Pack StringId - uploaded
On String
Look up Existing ZeroTrustGatewayCertificate Resource
Get an existing ZeroTrustGatewayCertificate 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?: ZeroTrustGatewayCertificateState, opts?: CustomResourceOptions): ZeroTrustGatewayCertificate@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
account_id: Optional[str] = None,
activate: Optional[bool] = None,
binding_status: Optional[str] = None,
created_at: Optional[str] = None,
custom: Optional[bool] = None,
expires_on: Optional[str] = None,
gateway_managed: Optional[bool] = None,
in_use: Optional[bool] = None,
qs_pack_id: Optional[str] = None,
uploaded_on: Optional[str] = None,
validity_period_days: Optional[int] = None) -> ZeroTrustGatewayCertificatefunc GetZeroTrustGatewayCertificate(ctx *Context, name string, id IDInput, state *ZeroTrustGatewayCertificateState, opts ...ResourceOption) (*ZeroTrustGatewayCertificate, error)public static ZeroTrustGatewayCertificate Get(string name, Input<string> id, ZeroTrustGatewayCertificateState? state, CustomResourceOptions? opts = null)public static ZeroTrustGatewayCertificate get(String name, Output<String> id, ZeroTrustGatewayCertificateState state, CustomResourceOptions options)resources: _: type: cloudflare:ZeroTrustGatewayCertificate get: id: ${id}- name
This property is required. - The unique name of the resulting resource.
- id
This property is required. - 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
This property is required. - The unique name of the resulting resource.
- id
This property is required. - The unique provider ID of the resource to lookup.
- name
This property is required. - The unique name of the resulting resource.
- id
This property is required. - 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
This property is required. - The unique name of the resulting resource.
- id
This property is required. - 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
This property is required. - The unique name of the resulting resource.
- id
This property is required. - 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:
- Account
Id string - The account identifier to target for the resource.
- Activate bool
- Whether or not to activate a certificate. A certificate must be activated to use in Gateway certificate settings. Defaults to
false. - Binding
Status string - The deployment status of the certificate on the edge Available values:
IP,SERIAL,URL,DOMAIN,EMAIL. - Created
At string - Custom bool
- The type of certificate (custom or Gateway-managed). Must provide only one of
custom,gateway_managed. - Expires
On string - Gateway
Managed bool - The type of certificate (custom or Gateway-managed). Must provide only one of
custom,gateway_managed. - In
Use bool - Whether the certificate is in use by Gateway for TLS interception and the block page.
- Qs
Pack stringId - Uploaded
On string - Validity
Period Days - Number of days the generated certificate will be valid, minimum 1 day and maximum 30 years. Defaults to 5 years. Defaults to
1826. Required when usinggateway_managed. Conflicts withcustom. Modifying this attribute will force creation of a new resource.
- Account
Id string - The account identifier to target for the resource.
- Activate bool
- Whether or not to activate a certificate. A certificate must be activated to use in Gateway certificate settings. Defaults to
false. - Binding
Status string - The deployment status of the certificate on the edge Available values:
IP,SERIAL,URL,DOMAIN,EMAIL. - Created
At string - Custom bool
- The type of certificate (custom or Gateway-managed). Must provide only one of
custom,gateway_managed. - Expires
On string - Gateway
Managed bool - The type of certificate (custom or Gateway-managed). Must provide only one of
custom,gateway_managed. - In
Use bool - Whether the certificate is in use by Gateway for TLS interception and the block page.
- Qs
Pack stringId - Uploaded
On string - Validity
Period Days - Number of days the generated certificate will be valid, minimum 1 day and maximum 30 years. Defaults to 5 years. Defaults to
1826. Required when usinggateway_managed. Conflicts withcustom. Modifying this attribute will force creation of a new resource.
- account
Id String - The account identifier to target for the resource.
- activate Boolean
- Whether or not to activate a certificate. A certificate must be activated to use in Gateway certificate settings. Defaults to
false. - binding
Status String - The deployment status of the certificate on the edge Available values:
IP,SERIAL,URL,DOMAIN,EMAIL. - created
At String - custom Boolean
- The type of certificate (custom or Gateway-managed). Must provide only one of
custom,gateway_managed. - expires
On String - gateway
Managed Boolean - The type of certificate (custom or Gateway-managed). Must provide only one of
custom,gateway_managed. - in
Use Boolean - Whether the certificate is in use by Gateway for TLS interception and the block page.
- qs
Pack StringId - uploaded
On String - validity
Period Days - Number of days the generated certificate will be valid, minimum 1 day and maximum 30 years. Defaults to 5 years. Defaults to
1826. Required when usinggateway_managed. Conflicts withcustom. Modifying this attribute will force creation of a new resource.
- account
Id string - The account identifier to target for the resource.
- activate boolean
- Whether or not to activate a certificate. A certificate must be activated to use in Gateway certificate settings. Defaults to
false. - binding
Status string - The deployment status of the certificate on the edge Available values:
IP,SERIAL,URL,DOMAIN,EMAIL. - created
At string - custom boolean
- The type of certificate (custom or Gateway-managed). Must provide only one of
custom,gateway_managed. - expires
On string - gateway
Managed boolean - The type of certificate (custom or Gateway-managed). Must provide only one of
custom,gateway_managed. - in
Use boolean - Whether the certificate is in use by Gateway for TLS interception and the block page.
- qs
Pack stringId - uploaded
On string - validity
Period Days - Number of days the generated certificate will be valid, minimum 1 day and maximum 30 years. Defaults to 5 years. Defaults to
1826. Required when usinggateway_managed. Conflicts withcustom. Modifying this attribute will force creation of a new resource.
- account_
id str - The account identifier to target for the resource.
- activate bool
- Whether or not to activate a certificate. A certificate must be activated to use in Gateway certificate settings. Defaults to
false. - binding_
status str - The deployment status of the certificate on the edge Available values:
IP,SERIAL,URL,DOMAIN,EMAIL. - created_
at str - custom bool
- The type of certificate (custom or Gateway-managed). Must provide only one of
custom,gateway_managed. - expires_
on str - gateway_
managed bool - The type of certificate (custom or Gateway-managed). Must provide only one of
custom,gateway_managed. - in_
use bool - Whether the certificate is in use by Gateway for TLS interception and the block page.
- qs_
pack_ strid - uploaded_
on str - validity_
period_ days - Number of days the generated certificate will be valid, minimum 1 day and maximum 30 years. Defaults to 5 years. Defaults to
1826. Required when usinggateway_managed. Conflicts withcustom. Modifying this attribute will force creation of a new resource.
- account
Id String - The account identifier to target for the resource.
- activate Boolean
- Whether or not to activate a certificate. A certificate must be activated to use in Gateway certificate settings. Defaults to
false. - binding
Status String - The deployment status of the certificate on the edge Available values:
IP,SERIAL,URL,DOMAIN,EMAIL. - created
At String - custom Boolean
- The type of certificate (custom or Gateway-managed). Must provide only one of
custom,gateway_managed. - expires
On String - gateway
Managed Boolean - The type of certificate (custom or Gateway-managed). Must provide only one of
custom,gateway_managed. - in
Use Boolean - Whether the certificate is in use by Gateway for TLS interception and the block page.
- qs
Pack StringId - uploaded
On String - validity
Period Days - Number of days the generated certificate will be valid, minimum 1 day and maximum 30 years. Defaults to 5 years. Defaults to
1826. Required when usinggateway_managed. Conflicts withcustom. Modifying this attribute will force creation of a new resource.
Package Details
- Repository
- Cloudflare pulumi/pulumi-cloudflare
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
cloudflareTerraform Provider.