Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. networksecurity
  5. ClientTlsPolicy
Google Cloud Classic v8.3.1 published on Wednesday, Sep 25, 2024 by Pulumi
pulumi/pulumi-gcp

gcp.networksecurity.ClientTlsPolicy

Explore with Pulumi AI

gcp logo
Google Cloud Classic v8.3.1 published on Wednesday, Sep 25, 2024 by Pulumi
pulumi/pulumi-gcp

    ClientTlsPolicy is a resource that specifies how a client should authenticate connections to backends of a service. This resource itself does not affect configuration unless it is attached to a backend service resource.

    To get more information about ClientTlsPolicy, see:

    Example Usage

    Network Security Client Tls Policy Basic

    import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const _default = new gcp.networksecurity.ClientTlsPolicy("default", {
    name: "my-client-tls-policy",
    labels: {
        foo: "bar",
    },
    description: "my description",
    sni: "secure.example.com",
});

    import pulumi
import pulumi_gcp as gcp

default = gcp.networksecurity.ClientTlsPolicy("default",
    name="my-client-tls-policy",
    labels={
        "foo": "bar",
    },
    description="my description",
    sni="secure.example.com")

    package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/networksecurity"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := networksecurity.NewClientTlsPolicy(ctx, "default", &networksecurity.ClientTlsPolicyArgs{
			Name: pulumi.String("my-client-tls-policy"),
			Labels: pulumi.StringMap{
				"foo": pulumi.String("bar"),
			},
			Description: pulumi.String("my description"),
			Sni:         pulumi.String("secure.example.com"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var @default = new Gcp.NetworkSecurity.ClientTlsPolicy("default", new()
    {
        Name = "my-client-tls-policy",
        Labels = 
        {
            { "foo", "bar" },
        },
        Description = "my description",
        Sni = "secure.example.com",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.networksecurity.ClientTlsPolicy;
import com.pulumi.gcp.networksecurity.ClientTlsPolicyArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var default_ = new ClientTlsPolicy("default", ClientTlsPolicyArgs.builder()
            .name("my-client-tls-policy")
            .labels(Map.of("foo", "bar"))
            .description("my description")
            .sni("secure.example.com")
            .build());

    }
}

    resources:
  default:
    type: gcp:networksecurity:ClientTlsPolicy
    properties:
      name: my-client-tls-policy
      labels:
        foo: bar
      description: my description
      sni: secure.example.com

    Network Security Client Tls Policy Advanced

    import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const _default = new gcp.networksecurity.ClientTlsPolicy("default", {
    name: "my-client-tls-policy",
    labels: {
        foo: "bar",
    },
    description: "my description",
    clientCertificate: {
        certificateProviderInstance: {
            pluginInstance: "google_cloud_private_spiffe",
        },
    },
    serverValidationCas: [{
        grpcEndpoint: {
            targetUri: "unix:mypath",
        },
    }],
});

    import pulumi
import pulumi_gcp as gcp

default = gcp.networksecurity.ClientTlsPolicy("default",
    name="my-client-tls-policy",
    labels={
        "foo": "bar",
    },
    description="my description",
    client_certificate={
        "certificate_provider_instance": {
            "plugin_instance": "google_cloud_private_spiffe",
        },
    },
    server_validation_cas=[{
        "grpc_endpoint": {
            "target_uri": "unix:mypath",
        },
    }])

    package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/networksecurity"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := networksecurity.NewClientTlsPolicy(ctx, "default", &networksecurity.ClientTlsPolicyArgs{
			Name: pulumi.String("my-client-tls-policy"),
			Labels: pulumi.StringMap{
				"foo": pulumi.String("bar"),
			},
			Description: pulumi.String("my description"),
			ClientCertificate: &networksecurity.ClientTlsPolicyClientCertificateArgs{
				CertificateProviderInstance: &networksecurity.ClientTlsPolicyClientCertificateCertificateProviderInstanceArgs{
					PluginInstance: pulumi.String("google_cloud_private_spiffe"),
				},
			},
			ServerValidationCas: networksecurity.ClientTlsPolicyServerValidationCaArray{
				&networksecurity.ClientTlsPolicyServerValidationCaArgs{
					GrpcEndpoint: &networksecurity.ClientTlsPolicyServerValidationCaGrpcEndpointArgs{
						TargetUri: pulumi.String("unix:mypath"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var @default = new Gcp.NetworkSecurity.ClientTlsPolicy("default", new()
    {
        Name = "my-client-tls-policy",
        Labels = 
        {
            { "foo", "bar" },
        },
        Description = "my description",
        ClientCertificate = new Gcp.NetworkSecurity.Inputs.ClientTlsPolicyClientCertificateArgs
        {
            CertificateProviderInstance = new Gcp.NetworkSecurity.Inputs.ClientTlsPolicyClientCertificateCertificateProviderInstanceArgs
            {
                PluginInstance = "google_cloud_private_spiffe",
            },
        },
        ServerValidationCas = new[]
        {
            new Gcp.NetworkSecurity.Inputs.ClientTlsPolicyServerValidationCaArgs
            {
                GrpcEndpoint = new Gcp.NetworkSecurity.Inputs.ClientTlsPolicyServerValidationCaGrpcEndpointArgs
                {
                    TargetUri = "unix:mypath",
                },
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.networksecurity.ClientTlsPolicy;
import com.pulumi.gcp.networksecurity.ClientTlsPolicyArgs;
import com.pulumi.gcp.networksecurity.inputs.ClientTlsPolicyClientCertificateArgs;
import com.pulumi.gcp.networksecurity.inputs.ClientTlsPolicyClientCertificateCertificateProviderInstanceArgs;
import com.pulumi.gcp.networksecurity.inputs.ClientTlsPolicyServerValidationCaArgs;
import com.pulumi.gcp.networksecurity.inputs.ClientTlsPolicyServerValidationCaGrpcEndpointArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var default_ = new ClientTlsPolicy("default", ClientTlsPolicyArgs.builder()
            .name("my-client-tls-policy")
            .labels(Map.of("foo", "bar"))
            .description("my description")
            .clientCertificate(ClientTlsPolicyClientCertificateArgs.builder()
                .certificateProviderInstance(ClientTlsPolicyClientCertificateCertificateProviderInstanceArgs.builder()
                    .pluginInstance("google_cloud_private_spiffe")
                    .build())
                .build())
            .serverValidationCas(ClientTlsPolicyServerValidationCaArgs.builder()
                .grpcEndpoint(ClientTlsPolicyServerValidationCaGrpcEndpointArgs.builder()
                    .targetUri("unix:mypath")
                    .build())
                .build())
            .build());

    }
}

    resources:
  default:
    type: gcp:networksecurity:ClientTlsPolicy
    properties:
      name: my-client-tls-policy
      labels:
        foo: bar
      description: my description
      clientCertificate:
        certificateProviderInstance:
          pluginInstance: google_cloud_private_spiffe
      serverValidationCas:
        - grpcEndpoint:
            targetUri: unix:mypath

    Create ClientTlsPolicy Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ClientTlsPolicy(name: string, args?: ClientTlsPolicyArgs, opts?: CustomResourceOptions);
    @overload
def ClientTlsPolicy(resource_name: str,
                    args: Optional[ClientTlsPolicyArgs] = None,
                    opts: Optional[ResourceOptions] = None)

@overload
def ClientTlsPolicy(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    client_certificate: Optional[ClientTlsPolicyClientCertificateArgs] = None,
                    description: Optional[str] = None,
                    labels: Optional[Mapping[str, str]] = None,
                    location: Optional[str] = None,
                    name: Optional[str] = None,
                    project: Optional[str] = None,
                    server_validation_cas: Optional[Sequence[ClientTlsPolicyServerValidationCaArgs]] = None,
                    sni: Optional[str] = None)
    func NewClientTlsPolicy(ctx *Context, name string, args *ClientTlsPolicyArgs, opts ...ResourceOption) (*ClientTlsPolicy, error)
    public ClientTlsPolicy(string name, ClientTlsPolicyArgs? args = null, CustomResourceOptions? opts = null)
    public ClientTlsPolicy(String name, ClientTlsPolicyArgs args)
public ClientTlsPolicy(String name, ClientTlsPolicyArgs args, CustomResourceOptions options)

    type: gcp:networksecurity:ClientTlsPolicy
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 ClientTlsPolicyArgs
    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 ClientTlsPolicyArgs
    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 ClientTlsPolicyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ClientTlsPolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ClientTlsPolicyArgs
    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 clientTlsPolicyResource = new Gcp.NetworkSecurity.ClientTlsPolicy("clientTlsPolicyResource", new()
{
    ClientCertificate = new Gcp.NetworkSecurity.Inputs.ClientTlsPolicyClientCertificateArgs
    {
        CertificateProviderInstance = new Gcp.NetworkSecurity.Inputs.ClientTlsPolicyClientCertificateCertificateProviderInstanceArgs
        {
            PluginInstance = "string",
        },
        GrpcEndpoint = new Gcp.NetworkSecurity.Inputs.ClientTlsPolicyClientCertificateGrpcEndpointArgs
        {
            TargetUri = "string",
        },
    },
    Description = "string",
    Labels = 
    {
        { "string", "string" },
    },
    Location = "string",
    Name = "string",
    Project = "string",
    ServerValidationCas = new[]
    {
        new Gcp.NetworkSecurity.Inputs.ClientTlsPolicyServerValidationCaArgs
        {
            CertificateProviderInstance = new Gcp.NetworkSecurity.Inputs.ClientTlsPolicyServerValidationCaCertificateProviderInstanceArgs
            {
                PluginInstance = "string",
            },
            GrpcEndpoint = new Gcp.NetworkSecurity.Inputs.ClientTlsPolicyServerValidationCaGrpcEndpointArgs
            {
                TargetUri = "string",
            },
        },
    },
    Sni = "string",
});

    example, err := networksecurity.NewClientTlsPolicy(ctx, "clientTlsPolicyResource", &networksecurity.ClientTlsPolicyArgs{
	ClientCertificate: &networksecurity.ClientTlsPolicyClientCertificateArgs{
		CertificateProviderInstance: &networksecurity.ClientTlsPolicyClientCertificateCertificateProviderInstanceArgs{
			PluginInstance: pulumi.String("string"),
		},
		GrpcEndpoint: &networksecurity.ClientTlsPolicyClientCertificateGrpcEndpointArgs{
			TargetUri: pulumi.String("string"),
		},
	},
	Description: pulumi.String("string"),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Location: pulumi.String("string"),
	Name:     pulumi.String("string"),
	Project:  pulumi.String("string"),
	ServerValidationCas: networksecurity.ClientTlsPolicyServerValidationCaArray{
		&networksecurity.ClientTlsPolicyServerValidationCaArgs{
			CertificateProviderInstance: &networksecurity.ClientTlsPolicyServerValidationCaCertificateProviderInstanceArgs{
				PluginInstance: pulumi.String("string"),
			},
			GrpcEndpoint: &networksecurity.ClientTlsPolicyServerValidationCaGrpcEndpointArgs{
				TargetUri: pulumi.String("string"),
			},
		},
	},
	Sni: pulumi.String("string"),
})

    var clientTlsPolicyResource = new ClientTlsPolicy("clientTlsPolicyResource", ClientTlsPolicyArgs.builder()
    .clientCertificate(ClientTlsPolicyClientCertificateArgs.builder()
        .certificateProviderInstance(ClientTlsPolicyClientCertificateCertificateProviderInstanceArgs.builder()
            .pluginInstance("string")
            .build())
        .grpcEndpoint(ClientTlsPolicyClientCertificateGrpcEndpointArgs.builder()
            .targetUri("string")
            .build())
        .build())
    .description("string")
    .labels(Map.of("string", "string"))
    .location("string")
    .name("string")
    .project("string")
    .serverValidationCas(ClientTlsPolicyServerValidationCaArgs.builder()
        .certificateProviderInstance(ClientTlsPolicyServerValidationCaCertificateProviderInstanceArgs.builder()
            .pluginInstance("string")
            .build())
        .grpcEndpoint(ClientTlsPolicyServerValidationCaGrpcEndpointArgs.builder()
            .targetUri("string")
            .build())
        .build())
    .sni("string")
    .build());

    client_tls_policy_resource = gcp.networksecurity.ClientTlsPolicy("clientTlsPolicyResource",
    client_certificate={
        "certificateProviderInstance": {
            "pluginInstance": "string",
        },
        "grpcEndpoint": {
            "targetUri": "string",
        },
    },
    description="string",
    labels={
        "string": "string",
    },
    location="string",
    name="string",
    project="string",
    server_validation_cas=[{
        "certificateProviderInstance": {
            "pluginInstance": "string",
        },
        "grpcEndpoint": {
            "targetUri": "string",
        },
    }],
    sni="string")

    const clientTlsPolicyResource = new gcp.networksecurity.ClientTlsPolicy("clientTlsPolicyResource", {
    clientCertificate: {
        certificateProviderInstance: {
            pluginInstance: "string",
        },
        grpcEndpoint: {
            targetUri: "string",
        },
    },
    description: "string",
    labels: {
        string: "string",
    },
    location: "string",
    name: "string",
    project: "string",
    serverValidationCas: [{
        certificateProviderInstance: {
            pluginInstance: "string",
        },
        grpcEndpoint: {
            targetUri: "string",
        },
    }],
    sni: "string",
});

    type: gcp:networksecurity:ClientTlsPolicy
properties:
    clientCertificate:
        certificateProviderInstance:
            pluginInstance: string
        grpcEndpoint:
            targetUri: string
    description: string
    labels:
        string: string
    location: string
    name: string
    project: string
    serverValidationCas:
        - certificateProviderInstance:
            pluginInstance: string
          grpcEndpoint:
            targetUri: string
    sni: string

    ClientTlsPolicy Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The ClientTlsPolicy resource accepts the following input properties:

    ClientCertificate ClientTlsPolicyClientCertificate
    Defines a mechanism to provision client identity (public and private keys) for peer to peer authentication. The presence of this dictates mTLS. Structure is documented below.
    Description string
    A free-text description of the resource. Max length 1024 characters.
    Labels Dictionary<string, string>
    Set of label tags associated with the ClientTlsPolicy resource. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.
    Location string
    The location of the client tls policy. The default value is global.
    Name string
    Name of the ClientTlsPolicy resource.

    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    ServerValidationCas List<ClientTlsPolicyServerValidationCa>
    Defines the mechanism to obtain the Certificate Authority certificate to validate the server certificate. If empty, client does not validate the server certificate. Structure is documented below.
    Sni string
    Server Name Indication string to present to the server during TLS handshake. E.g: "secure.example.com".
    ClientCertificate ClientTlsPolicyClientCertificateArgs
    Defines a mechanism to provision client identity (public and private keys) for peer to peer authentication. The presence of this dictates mTLS. Structure is documented below.
    Description string
    A free-text description of the resource. Max length 1024 characters.
    Labels map[string]string
    Set of label tags associated with the ClientTlsPolicy resource. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.
    Location string
    The location of the client tls policy. The default value is global.
    Name string
    Name of the ClientTlsPolicy resource.

    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    ServerValidationCas []ClientTlsPolicyServerValidationCaArgs
    Defines the mechanism to obtain the Certificate Authority certificate to validate the server certificate. If empty, client does not validate the server certificate. Structure is documented below.
    Sni string
    Server Name Indication string to present to the server during TLS handshake. E.g: "secure.example.com".
    clientCertificate ClientTlsPolicyClientCertificate
    Defines a mechanism to provision client identity (public and private keys) for peer to peer authentication. The presence of this dictates mTLS. Structure is documented below.
    description String
    A free-text description of the resource. Max length 1024 characters.
    labels Map<String,String>
    Set of label tags associated with the ClientTlsPolicy resource. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.
    location String
    The location of the client tls policy. The default value is global.
    name String
    Name of the ClientTlsPolicy resource.

    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    serverValidationCas List<ClientTlsPolicyServerValidationCa>
    Defines the mechanism to obtain the Certificate Authority certificate to validate the server certificate. If empty, client does not validate the server certificate. Structure is documented below.
    sni String
    Server Name Indication string to present to the server during TLS handshake. E.g: "secure.example.com".
    clientCertificate ClientTlsPolicyClientCertificate
    Defines a mechanism to provision client identity (public and private keys) for peer to peer authentication. The presence of this dictates mTLS. Structure is documented below.
    description string
    A free-text description of the resource. Max length 1024 characters.
    labels {[key: string]: string}
    Set of label tags associated with the ClientTlsPolicy resource. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.
    location string
    The location of the client tls policy. The default value is global.
    name string
    Name of the ClientTlsPolicy resource.

    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    serverValidationCas ClientTlsPolicyServerValidationCa[]
    Defines the mechanism to obtain the Certificate Authority certificate to validate the server certificate. If empty, client does not validate the server certificate. Structure is documented below.
    sni string
    Server Name Indication string to present to the server during TLS handshake. E.g: "secure.example.com".
    client_certificate ClientTlsPolicyClientCertificateArgs
    Defines a mechanism to provision client identity (public and private keys) for peer to peer authentication. The presence of this dictates mTLS. Structure is documented below.
    description str
    A free-text description of the resource. Max length 1024 characters.
    labels Mapping[str, str]
    Set of label tags associated with the ClientTlsPolicy resource. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.
    location str
    The location of the client tls policy. The default value is global.
    name str
    Name of the ClientTlsPolicy resource.

    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    server_validation_cas Sequence[ClientTlsPolicyServerValidationCaArgs]
    Defines the mechanism to obtain the Certificate Authority certificate to validate the server certificate. If empty, client does not validate the server certificate. Structure is documented below.
    sni str
    Server Name Indication string to present to the server during TLS handshake. E.g: "secure.example.com".
    clientCertificate Property Map
    Defines a mechanism to provision client identity (public and private keys) for peer to peer authentication. The presence of this dictates mTLS. Structure is documented below.
    description String
    A free-text description of the resource. Max length 1024 characters.
    labels Map<String>
    Set of label tags associated with the ClientTlsPolicy resource. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.
    location String
    The location of the client tls policy. The default value is global.
    name String
    Name of the ClientTlsPolicy resource.

    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    serverValidationCas List<Property Map>
    Defines the mechanism to obtain the Certificate Authority certificate to validate the server certificate. If empty, client does not validate the server certificate. Structure is documented below.
    sni String
    Server Name Indication string to present to the server during TLS handshake. E.g: "secure.example.com".

    Outputs

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

    CreateTime string
    Time the ClientTlsPolicy was created in UTC.
    EffectiveLabels Dictionary<string, string>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    Id string
    The provider-assigned unique ID for this managed resource.
    PulumiLabels Dictionary<string, string>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    UpdateTime string
    Time the ClientTlsPolicy was updated in UTC.
    CreateTime string
    Time the ClientTlsPolicy was created in UTC.
    EffectiveLabels map[string]string
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    Id string
    The provider-assigned unique ID for this managed resource.
    PulumiLabels map[string]string
    The combination of labels configured directly on the resource and default labels configured on the provider.
    UpdateTime string
    Time the ClientTlsPolicy was updated in UTC.
    createTime String
    Time the ClientTlsPolicy was created in UTC.
    effectiveLabels Map<String,String>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    id String
    The provider-assigned unique ID for this managed resource.
    pulumiLabels Map<String,String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    updateTime String
    Time the ClientTlsPolicy was updated in UTC.
    createTime string
    Time the ClientTlsPolicy was created in UTC.
    effectiveLabels {[key: string]: string}
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    id string
    The provider-assigned unique ID for this managed resource.
    pulumiLabels {[key: string]: string}
    The combination of labels configured directly on the resource and default labels configured on the provider.
    updateTime string
    Time the ClientTlsPolicy was updated in UTC.
    create_time str
    Time the ClientTlsPolicy was created in UTC.
    effective_labels Mapping[str, str]
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    id str
    The provider-assigned unique ID for this managed resource.
    pulumi_labels Mapping[str, str]
    The combination of labels configured directly on the resource and default labels configured on the provider.
    update_time str
    Time the ClientTlsPolicy was updated in UTC.
    createTime String
    Time the ClientTlsPolicy was created in UTC.
    effectiveLabels Map<String>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    id String
    The provider-assigned unique ID for this managed resource.
    pulumiLabels Map<String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    updateTime String
    Time the ClientTlsPolicy was updated in UTC.

    Look up Existing ClientTlsPolicy Resource

    Get an existing ClientTlsPolicy 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?: ClientTlsPolicyState, opts?: CustomResourceOptions): ClientTlsPolicy
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        client_certificate: Optional[ClientTlsPolicyClientCertificateArgs] = None,
        create_time: Optional[str] = None,
        description: Optional[str] = None,
        effective_labels: Optional[Mapping[str, str]] = None,
        labels: Optional[Mapping[str, str]] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        project: Optional[str] = None,
        pulumi_labels: Optional[Mapping[str, str]] = None,
        server_validation_cas: Optional[Sequence[ClientTlsPolicyServerValidationCaArgs]] = None,
        sni: Optional[str] = None,
        update_time: Optional[str] = None) -> ClientTlsPolicy
    func GetClientTlsPolicy(ctx *Context, name string, id IDInput, state *ClientTlsPolicyState, opts ...ResourceOption) (*ClientTlsPolicy, error)
    public static ClientTlsPolicy Get(string name, Input<string> id, ClientTlsPolicyState? state, CustomResourceOptions? opts = null)
    public static ClientTlsPolicy get(String name, Output<String> id, ClientTlsPolicyState 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:
    ClientCertificate ClientTlsPolicyClientCertificate
    Defines a mechanism to provision client identity (public and private keys) for peer to peer authentication. The presence of this dictates mTLS. Structure is documented below.
    CreateTime string
    Time the ClientTlsPolicy was created in UTC.
    Description string
    A free-text description of the resource. Max length 1024 characters.
    EffectiveLabels Dictionary<string, string>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    Labels Dictionary<string, string>
    Set of label tags associated with the ClientTlsPolicy resource. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.
    Location string
    The location of the client tls policy. The default value is global.
    Name string
    Name of the ClientTlsPolicy resource.

    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    PulumiLabels Dictionary<string, string>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    ServerValidationCas List<ClientTlsPolicyServerValidationCa>
    Defines the mechanism to obtain the Certificate Authority certificate to validate the server certificate. If empty, client does not validate the server certificate. Structure is documented below.
    Sni string
    Server Name Indication string to present to the server during TLS handshake. E.g: "secure.example.com".
    UpdateTime string
    Time the ClientTlsPolicy was updated in UTC.
    ClientCertificate ClientTlsPolicyClientCertificateArgs
    Defines a mechanism to provision client identity (public and private keys) for peer to peer authentication. The presence of this dictates mTLS. Structure is documented below.
    CreateTime string
    Time the ClientTlsPolicy was created in UTC.
    Description string
    A free-text description of the resource. Max length 1024 characters.
    EffectiveLabels map[string]string
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    Labels map[string]string
    Set of label tags associated with the ClientTlsPolicy resource. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.
    Location string
    The location of the client tls policy. The default value is global.
    Name string
    Name of the ClientTlsPolicy resource.

    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    PulumiLabels map[string]string
    The combination of labels configured directly on the resource and default labels configured on the provider.
    ServerValidationCas []ClientTlsPolicyServerValidationCaArgs
    Defines the mechanism to obtain the Certificate Authority certificate to validate the server certificate. If empty, client does not validate the server certificate. Structure is documented below.
    Sni string
    Server Name Indication string to present to the server during TLS handshake. E.g: "secure.example.com".
    UpdateTime string
    Time the ClientTlsPolicy was updated in UTC.
    clientCertificate ClientTlsPolicyClientCertificate
    Defines a mechanism to provision client identity (public and private keys) for peer to peer authentication. The presence of this dictates mTLS. Structure is documented below.
    createTime String
    Time the ClientTlsPolicy was created in UTC.
    description String
    A free-text description of the resource. Max length 1024 characters.
    effectiveLabels Map<String,String>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    labels Map<String,String>
    Set of label tags associated with the ClientTlsPolicy resource. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.
    location String
    The location of the client tls policy. The default value is global.
    name String
    Name of the ClientTlsPolicy resource.

    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    pulumiLabels Map<String,String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    serverValidationCas List<ClientTlsPolicyServerValidationCa>
    Defines the mechanism to obtain the Certificate Authority certificate to validate the server certificate. If empty, client does not validate the server certificate. Structure is documented below.
    sni String
    Server Name Indication string to present to the server during TLS handshake. E.g: "secure.example.com".
    updateTime String
    Time the ClientTlsPolicy was updated in UTC.
    clientCertificate ClientTlsPolicyClientCertificate
    Defines a mechanism to provision client identity (public and private keys) for peer to peer authentication. The presence of this dictates mTLS. Structure is documented below.
    createTime string
    Time the ClientTlsPolicy was created in UTC.
    description string
    A free-text description of the resource. Max length 1024 characters.
    effectiveLabels {[key: string]: string}
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    labels {[key: string]: string}
    Set of label tags associated with the ClientTlsPolicy resource. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.
    location string
    The location of the client tls policy. The default value is global.
    name string
    Name of the ClientTlsPolicy resource.

    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    pulumiLabels {[key: string]: string}
    The combination of labels configured directly on the resource and default labels configured on the provider.
    serverValidationCas ClientTlsPolicyServerValidationCa[]
    Defines the mechanism to obtain the Certificate Authority certificate to validate the server certificate. If empty, client does not validate the server certificate. Structure is documented below.
    sni string
    Server Name Indication string to present to the server during TLS handshake. E.g: "secure.example.com".
    updateTime string
    Time the ClientTlsPolicy was updated in UTC.
    client_certificate ClientTlsPolicyClientCertificateArgs
    Defines a mechanism to provision client identity (public and private keys) for peer to peer authentication. The presence of this dictates mTLS. Structure is documented below.
    create_time str
    Time the ClientTlsPolicy was created in UTC.
    description str
    A free-text description of the resource. Max length 1024 characters.
    effective_labels Mapping[str, str]
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    labels Mapping[str, str]
    Set of label tags associated with the ClientTlsPolicy resource. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.
    location str
    The location of the client tls policy. The default value is global.
    name str
    Name of the ClientTlsPolicy resource.

    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    pulumi_labels Mapping[str, str]
    The combination of labels configured directly on the resource and default labels configured on the provider.
    server_validation_cas Sequence[ClientTlsPolicyServerValidationCaArgs]
    Defines the mechanism to obtain the Certificate Authority certificate to validate the server certificate. If empty, client does not validate the server certificate. Structure is documented below.
    sni str
    Server Name Indication string to present to the server during TLS handshake. E.g: "secure.example.com".
    update_time str
    Time the ClientTlsPolicy was updated in UTC.
    clientCertificate Property Map
    Defines a mechanism to provision client identity (public and private keys) for peer to peer authentication. The presence of this dictates mTLS. Structure is documented below.
    createTime String
    Time the ClientTlsPolicy was created in UTC.
    description String
    A free-text description of the resource. Max length 1024 characters.
    effectiveLabels Map<String>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    labels Map<String>
    Set of label tags associated with the ClientTlsPolicy resource. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.
    location String
    The location of the client tls policy. The default value is global.
    name String
    Name of the ClientTlsPolicy resource.

    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    pulumiLabels Map<String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    serverValidationCas List<Property Map>
    Defines the mechanism to obtain the Certificate Authority certificate to validate the server certificate. If empty, client does not validate the server certificate. Structure is documented below.
    sni String
    Server Name Indication string to present to the server during TLS handshake. E.g: "secure.example.com".
    updateTime String
    Time the ClientTlsPolicy was updated in UTC.

    Supporting Types

    ClientTlsPolicyClientCertificate, ClientTlsPolicyClientCertificateArgs

    CertificateProviderInstance ClientTlsPolicyClientCertificateCertificateProviderInstance
    The certificate provider instance specification that will be passed to the data plane, which will be used to load necessary credential information. Structure is documented below.
    GrpcEndpoint ClientTlsPolicyClientCertificateGrpcEndpoint
    gRPC specific configuration to access the gRPC server to obtain the cert and private key. Structure is documented below.
    CertificateProviderInstance ClientTlsPolicyClientCertificateCertificateProviderInstance
    The certificate provider instance specification that will be passed to the data plane, which will be used to load necessary credential information. Structure is documented below.
    GrpcEndpoint ClientTlsPolicyClientCertificateGrpcEndpoint
    gRPC specific configuration to access the gRPC server to obtain the cert and private key. Structure is documented below.
    certificateProviderInstance ClientTlsPolicyClientCertificateCertificateProviderInstance
    The certificate provider instance specification that will be passed to the data plane, which will be used to load necessary credential information. Structure is documented below.
    grpcEndpoint ClientTlsPolicyClientCertificateGrpcEndpoint
    gRPC specific configuration to access the gRPC server to obtain the cert and private key. Structure is documented below.
    certificateProviderInstance ClientTlsPolicyClientCertificateCertificateProviderInstance
    The certificate provider instance specification that will be passed to the data plane, which will be used to load necessary credential information. Structure is documented below.
    grpcEndpoint ClientTlsPolicyClientCertificateGrpcEndpoint
    gRPC specific configuration to access the gRPC server to obtain the cert and private key. Structure is documented below.
    certificate_provider_instance ClientTlsPolicyClientCertificateCertificateProviderInstance
    The certificate provider instance specification that will be passed to the data plane, which will be used to load necessary credential information. Structure is documented below.
    grpc_endpoint ClientTlsPolicyClientCertificateGrpcEndpoint
    gRPC specific configuration to access the gRPC server to obtain the cert and private key. Structure is documented below.
    certificateProviderInstance Property Map
    The certificate provider instance specification that will be passed to the data plane, which will be used to load necessary credential information. Structure is documented below.
    grpcEndpoint Property Map
    gRPC specific configuration to access the gRPC server to obtain the cert and private key. Structure is documented below.

    ClientTlsPolicyClientCertificateCertificateProviderInstance, ClientTlsPolicyClientCertificateCertificateProviderInstanceArgs

    PluginInstance string
    Plugin instance name, used to locate and load CertificateProvider instance configuration. Set to "google_cloud_private_spiffe" to use Certificate Authority Service certificate provider instance.
    PluginInstance string
    Plugin instance name, used to locate and load CertificateProvider instance configuration. Set to "google_cloud_private_spiffe" to use Certificate Authority Service certificate provider instance.
    pluginInstance String
    Plugin instance name, used to locate and load CertificateProvider instance configuration. Set to "google_cloud_private_spiffe" to use Certificate Authority Service certificate provider instance.
    pluginInstance string
    Plugin instance name, used to locate and load CertificateProvider instance configuration. Set to "google_cloud_private_spiffe" to use Certificate Authority Service certificate provider instance.
    plugin_instance str
    Plugin instance name, used to locate and load CertificateProvider instance configuration. Set to "google_cloud_private_spiffe" to use Certificate Authority Service certificate provider instance.
    pluginInstance String
    Plugin instance name, used to locate and load CertificateProvider instance configuration. Set to "google_cloud_private_spiffe" to use Certificate Authority Service certificate provider instance.

    ClientTlsPolicyClientCertificateGrpcEndpoint, ClientTlsPolicyClientCertificateGrpcEndpointArgs

    TargetUri string
    The target URI of the gRPC endpoint. Only UDS path is supported, and should start with "unix:".
    TargetUri string
    The target URI of the gRPC endpoint. Only UDS path is supported, and should start with "unix:".
    targetUri String
    The target URI of the gRPC endpoint. Only UDS path is supported, and should start with "unix:".
    targetUri string
    The target URI of the gRPC endpoint. Only UDS path is supported, and should start with "unix:".
    target_uri str
    The target URI of the gRPC endpoint. Only UDS path is supported, and should start with "unix:".
    targetUri String
    The target URI of the gRPC endpoint. Only UDS path is supported, and should start with "unix:".

    ClientTlsPolicyServerValidationCa, ClientTlsPolicyServerValidationCaArgs

    CertificateProviderInstance ClientTlsPolicyServerValidationCaCertificateProviderInstance
    The certificate provider instance specification that will be passed to the data plane, which will be used to load necessary credential information. Structure is documented below.
    GrpcEndpoint ClientTlsPolicyServerValidationCaGrpcEndpoint
    gRPC specific configuration to access the gRPC server to obtain the cert and private key. Structure is documented below.
    CertificateProviderInstance ClientTlsPolicyServerValidationCaCertificateProviderInstance
    The certificate provider instance specification that will be passed to the data plane, which will be used to load necessary credential information. Structure is documented below.
    GrpcEndpoint ClientTlsPolicyServerValidationCaGrpcEndpoint
    gRPC specific configuration to access the gRPC server to obtain the cert and private key. Structure is documented below.
    certificateProviderInstance ClientTlsPolicyServerValidationCaCertificateProviderInstance
    The certificate provider instance specification that will be passed to the data plane, which will be used to load necessary credential information. Structure is documented below.
    grpcEndpoint ClientTlsPolicyServerValidationCaGrpcEndpoint
    gRPC specific configuration to access the gRPC server to obtain the cert and private key. Structure is documented below.
    certificateProviderInstance ClientTlsPolicyServerValidationCaCertificateProviderInstance
    The certificate provider instance specification that will be passed to the data plane, which will be used to load necessary credential information. Structure is documented below.
    grpcEndpoint ClientTlsPolicyServerValidationCaGrpcEndpoint
    gRPC specific configuration to access the gRPC server to obtain the cert and private key. Structure is documented below.
    certificate_provider_instance ClientTlsPolicyServerValidationCaCertificateProviderInstance
    The certificate provider instance specification that will be passed to the data plane, which will be used to load necessary credential information. Structure is documented below.
    grpc_endpoint ClientTlsPolicyServerValidationCaGrpcEndpoint
    gRPC specific configuration to access the gRPC server to obtain the cert and private key. Structure is documented below.
    certificateProviderInstance Property Map
    The certificate provider instance specification that will be passed to the data plane, which will be used to load necessary credential information. Structure is documented below.
    grpcEndpoint Property Map
    gRPC specific configuration to access the gRPC server to obtain the cert and private key. Structure is documented below.

    ClientTlsPolicyServerValidationCaCertificateProviderInstance, ClientTlsPolicyServerValidationCaCertificateProviderInstanceArgs

    PluginInstance string
    Plugin instance name, used to locate and load CertificateProvider instance configuration. Set to "google_cloud_private_spiffe" to use Certificate Authority Service certificate provider instance.
    PluginInstance string
    Plugin instance name, used to locate and load CertificateProvider instance configuration. Set to "google_cloud_private_spiffe" to use Certificate Authority Service certificate provider instance.
    pluginInstance String
    Plugin instance name, used to locate and load CertificateProvider instance configuration. Set to "google_cloud_private_spiffe" to use Certificate Authority Service certificate provider instance.
    pluginInstance string
    Plugin instance name, used to locate and load CertificateProvider instance configuration. Set to "google_cloud_private_spiffe" to use Certificate Authority Service certificate provider instance.
    plugin_instance str
    Plugin instance name, used to locate and load CertificateProvider instance configuration. Set to "google_cloud_private_spiffe" to use Certificate Authority Service certificate provider instance.
    pluginInstance String
    Plugin instance name, used to locate and load CertificateProvider instance configuration. Set to "google_cloud_private_spiffe" to use Certificate Authority Service certificate provider instance.

    ClientTlsPolicyServerValidationCaGrpcEndpoint, ClientTlsPolicyServerValidationCaGrpcEndpointArgs

    TargetUri string
    The target URI of the gRPC endpoint. Only UDS path is supported, and should start with "unix:".
    TargetUri string
    The target URI of the gRPC endpoint. Only UDS path is supported, and should start with "unix:".
    targetUri String
    The target URI of the gRPC endpoint. Only UDS path is supported, and should start with "unix:".
    targetUri string
    The target URI of the gRPC endpoint. Only UDS path is supported, and should start with "unix:".
    target_uri str
    The target URI of the gRPC endpoint. Only UDS path is supported, and should start with "unix:".
    targetUri String
    The target URI of the gRPC endpoint. Only UDS path is supported, and should start with "unix:".

    Import

    ClientTlsPolicy can be imported using any of these accepted formats:

    • projects/{{project}}/locations/{{location}}/clientTlsPolicies/{{name}}

    • {{project}}/{{location}}/{{name}}

    • {{location}}/{{name}}

    When using the pulumi import command, ClientTlsPolicy can be imported using one of the formats above. For example:

    $ pulumi import gcp:networksecurity/clientTlsPolicy:ClientTlsPolicy default projects/{{project}}/locations/{{location}}/clientTlsPolicies/{{name}}

    $ pulumi import gcp:networksecurity/clientTlsPolicy:ClientTlsPolicy default {{project}}/{{location}}/{{name}}

    $ pulumi import gcp:networksecurity/clientTlsPolicy:ClientTlsPolicy default {{location}}/{{name}}

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Google Cloud Classic v8.3.1 published on Wednesday, Sep 25, 2024 by Pulumi
    pulumi/pulumi-gcp