Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Cloudflare Provider
  3. API Docs
  4. ZeroTrustGatewayCertificate
Cloudflare v5.43.0 published on Wednesday, Nov 13, 2024 by Pulumi
pulumi/pulumi-cloudflare

cloudflare.ZeroTrustGatewayCertificate

Explore with Pulumi AI

cloudflare logo
Cloudflare v5.43.0 published on Wednesday, Nov 13, 2024 by Pulumi
pulumi/pulumi-cloudflare

    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 string
    The unique name of the resource.
    args ZeroTrustGatewayCertificateArgs
    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 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 string
    The unique name of the resource.
    args ZeroTrustGatewayCertificateArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ZeroTrustGatewayCertificateArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args 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:

    AccountId 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.
    GatewayManaged bool
    The type of certificate (custom or Gateway-managed). Must provide only one of custom, gateway_managed.
    ValidityPeriodDays int
    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 using gateway_managed. Conflicts with custom. Modifying this attribute will force creation of a new resource.
    AccountId 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.
    GatewayManaged bool
    The type of certificate (custom or Gateway-managed). Must provide only one of custom, gateway_managed.
    ValidityPeriodDays int
    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 using gateway_managed. Conflicts with custom. Modifying this attribute will force creation of a new resource.
    accountId 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.
    gatewayManaged Boolean
    The type of certificate (custom or Gateway-managed). Must provide only one of custom, gateway_managed.
    validityPeriodDays Integer
    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 using gateway_managed. Conflicts with custom. Modifying this attribute will force creation of a new resource.
    accountId 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.
    gatewayManaged boolean
    The type of certificate (custom or Gateway-managed). Must provide only one of custom, gateway_managed.
    validityPeriodDays number
    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 using gateway_managed. Conflicts with custom. 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.
    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 int
    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 using gateway_managed. Conflicts with custom. Modifying this attribute will force creation of a new resource.
    accountId 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.
    gatewayManaged Boolean
    The type of certificate (custom or Gateway-managed). Must provide only one of custom, gateway_managed.
    validityPeriodDays Number
    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 using gateway_managed. Conflicts with custom. 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:

    BindingStatus string
    The deployment status of the certificate on the edge Available values: IP, SERIAL, URL, DOMAIN, EMAIL.
    CreatedAt string
    ExpiresOn string
    Id string
    The provider-assigned unique ID for this managed resource.
    InUse bool
    Whether the certificate is in use by Gateway for TLS interception and the block page.
    QsPackId string
    UploadedOn string
    BindingStatus string
    The deployment status of the certificate on the edge Available values: IP, SERIAL, URL, DOMAIN, EMAIL.
    CreatedAt string
    ExpiresOn string
    Id string
    The provider-assigned unique ID for this managed resource.
    InUse bool
    Whether the certificate is in use by Gateway for TLS interception and the block page.
    QsPackId string
    UploadedOn string
    bindingStatus String
    The deployment status of the certificate on the edge Available values: IP, SERIAL, URL, DOMAIN, EMAIL.
    createdAt String
    expiresOn String
    id String
    The provider-assigned unique ID for this managed resource.
    inUse Boolean
    Whether the certificate is in use by Gateway for TLS interception and the block page.
    qsPackId String
    uploadedOn String
    bindingStatus string
    The deployment status of the certificate on the edge Available values: IP, SERIAL, URL, DOMAIN, EMAIL.
    createdAt string
    expiresOn string
    id string
    The provider-assigned unique ID for this managed resource.
    inUse boolean
    Whether the certificate is in use by Gateway for TLS interception and the block page.
    qsPackId string
    uploadedOn 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_id str
    uploaded_on str
    bindingStatus String
    The deployment status of the certificate on the edge Available values: IP, SERIAL, URL, DOMAIN, EMAIL.
    createdAt String
    expiresOn String
    id String
    The provider-assigned unique ID for this managed resource.
    inUse Boolean
    Whether the certificate is in use by Gateway for TLS interception and the block page.
    qsPackId String
    uploadedOn 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) -> ZeroTrustGatewayCertificate
    func 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)
    Resource lookup is not supported in YAML
    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.
    The following state arguments are supported:
    AccountId 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.
    BindingStatus string
    The deployment status of the certificate on the edge Available values: IP, SERIAL, URL, DOMAIN, EMAIL.
    CreatedAt string
    Custom bool
    The type of certificate (custom or Gateway-managed). Must provide only one of custom, gateway_managed.
    ExpiresOn string
    GatewayManaged bool
    The type of certificate (custom or Gateway-managed). Must provide only one of custom, gateway_managed.
    InUse bool
    Whether the certificate is in use by Gateway for TLS interception and the block page.
    QsPackId string
    UploadedOn string
    ValidityPeriodDays int
    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 using gateway_managed. Conflicts with custom. Modifying this attribute will force creation of a new resource.
    AccountId 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.
    BindingStatus string
    The deployment status of the certificate on the edge Available values: IP, SERIAL, URL, DOMAIN, EMAIL.
    CreatedAt string
    Custom bool
    The type of certificate (custom or Gateway-managed). Must provide only one of custom, gateway_managed.
    ExpiresOn string
    GatewayManaged bool
    The type of certificate (custom or Gateway-managed). Must provide only one of custom, gateway_managed.
    InUse bool
    Whether the certificate is in use by Gateway for TLS interception and the block page.
    QsPackId string
    UploadedOn string
    ValidityPeriodDays int
    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 using gateway_managed. Conflicts with custom. Modifying this attribute will force creation of a new resource.
    accountId 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.
    bindingStatus String
    The deployment status of the certificate on the edge Available values: IP, SERIAL, URL, DOMAIN, EMAIL.
    createdAt String
    custom Boolean
    The type of certificate (custom or Gateway-managed). Must provide only one of custom, gateway_managed.
    expiresOn String
    gatewayManaged Boolean
    The type of certificate (custom or Gateway-managed). Must provide only one of custom, gateway_managed.
    inUse Boolean
    Whether the certificate is in use by Gateway for TLS interception and the block page.
    qsPackId String
    uploadedOn String
    validityPeriodDays Integer
    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 using gateway_managed. Conflicts with custom. Modifying this attribute will force creation of a new resource.
    accountId 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.
    bindingStatus string
    The deployment status of the certificate on the edge Available values: IP, SERIAL, URL, DOMAIN, EMAIL.
    createdAt string
    custom boolean
    The type of certificate (custom or Gateway-managed). Must provide only one of custom, gateway_managed.
    expiresOn string
    gatewayManaged boolean
    The type of certificate (custom or Gateway-managed). Must provide only one of custom, gateway_managed.
    inUse boolean
    Whether the certificate is in use by Gateway for TLS interception and the block page.
    qsPackId string
    uploadedOn string
    validityPeriodDays number
    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 using gateway_managed. Conflicts with custom. 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_id str
    uploaded_on str
    validity_period_days int
    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 using gateway_managed. Conflicts with custom. Modifying this attribute will force creation of a new resource.
    accountId 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.
    bindingStatus String
    The deployment status of the certificate on the edge Available values: IP, SERIAL, URL, DOMAIN, EMAIL.
    createdAt String
    custom Boolean
    The type of certificate (custom or Gateway-managed). Must provide only one of custom, gateway_managed.
    expiresOn String
    gatewayManaged Boolean
    The type of certificate (custom or Gateway-managed). Must provide only one of custom, gateway_managed.
    inUse Boolean
    Whether the certificate is in use by Gateway for TLS interception and the block page.
    qsPackId String
    uploadedOn String
    validityPeriodDays Number
    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 using gateway_managed. Conflicts with custom. 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 cloudflare Terraform Provider.
    cloudflare logo
    Cloudflare v5.43.0 published on Wednesday, Nov 13, 2024 by Pulumi
    pulumi/pulumi-cloudflare