1. Packages
  2. Google Cloud Native
  3. API Docs
  4. networksecurity
  5. networksecurity/v1
  6. getServerTlsPolicy

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.31.1 published on Thursday, Jul 20, 2023 by Pulumi

google-native.networksecurity/v1.getServerTlsPolicy

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.31.1 published on Thursday, Jul 20, 2023 by Pulumi

    Gets details of a single ServerTlsPolicy.

    Using getServerTlsPolicy

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getServerTlsPolicy(args: GetServerTlsPolicyArgs, opts?: InvokeOptions): Promise<GetServerTlsPolicyResult>
    function getServerTlsPolicyOutput(args: GetServerTlsPolicyOutputArgs, opts?: InvokeOptions): Output<GetServerTlsPolicyResult>
    def get_server_tls_policy(location: Optional[str] = None,
                              project: Optional[str] = None,
                              server_tls_policy_id: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetServerTlsPolicyResult
    def get_server_tls_policy_output(location: Optional[pulumi.Input[str]] = None,
                              project: Optional[pulumi.Input[str]] = None,
                              server_tls_policy_id: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetServerTlsPolicyResult]
    func LookupServerTlsPolicy(ctx *Context, args *LookupServerTlsPolicyArgs, opts ...InvokeOption) (*LookupServerTlsPolicyResult, error)
    func LookupServerTlsPolicyOutput(ctx *Context, args *LookupServerTlsPolicyOutputArgs, opts ...InvokeOption) LookupServerTlsPolicyResultOutput

    > Note: This function is named LookupServerTlsPolicy in the Go SDK.

    public static class GetServerTlsPolicy 
    {
        public static Task<GetServerTlsPolicyResult> InvokeAsync(GetServerTlsPolicyArgs args, InvokeOptions? opts = null)
        public static Output<GetServerTlsPolicyResult> Invoke(GetServerTlsPolicyInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetServerTlsPolicyResult> getServerTlsPolicy(GetServerTlsPolicyArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: google-native:networksecurity/v1:getServerTlsPolicy
      arguments:
        # arguments dictionary

    The following arguments are supported:

    getServerTlsPolicy Result

    The following output properties are available:

    AllowOpen bool

    This field applies only for Traffic Director policies. It is must be set to false for external HTTPS load balancer policies. Determines if server allows plaintext connections. If set to true, server allows plain text connections. By default, it is set to false. This setting is not exclusive of other encryption modes. For example, if allow_open and mtls_policy are set, server allows both plain text and mTLS connections. See documentation of other encryption modes to confirm compatibility. Consider using it if you wish to upgrade in place your deployment to TLS while having mixed TLS and non-TLS traffic reaching port :80.

    CreateTime string

    The timestamp when the resource was created.

    Description string

    Free-text description of the resource.

    Labels Dictionary<string, string>

    Set of label tags associated with the resource.

    MtlsPolicy Pulumi.GoogleNative.NetworkSecurity.V1.Outputs.MTLSPolicyResponse

    This field is required if the policy is used with external HTTPS load balancers. This field can be empty for Traffic Director. Defines a mechanism to provision peer validation certificates for peer to peer authentication (Mutual TLS - mTLS). If not specified, client certificate will not be requested. The connection is treated as TLS and not mTLS. If allow_open and mtls_policy are set, server allows both plain text and mTLS connections.

    Name string

    Name of the ServerTlsPolicy resource. It matches the pattern projects/*/locations/{location}/serverTlsPolicies/{server_tls_policy}

    ServerCertificate Pulumi.GoogleNative.NetworkSecurity.V1.Outputs.GoogleCloudNetworksecurityV1CertificateProviderResponse

    Optional if policy is to be used with Traffic Director. For external HTTPS load balancer must be empty. Defines a mechanism to provision server identity (public and private keys). Cannot be combined with allow_open as a permissive mode that allows both plain text and TLS is not supported.

    UpdateTime string

    The timestamp when the resource was updated.

    AllowOpen bool

    This field applies only for Traffic Director policies. It is must be set to false for external HTTPS load balancer policies. Determines if server allows plaintext connections. If set to true, server allows plain text connections. By default, it is set to false. This setting is not exclusive of other encryption modes. For example, if allow_open and mtls_policy are set, server allows both plain text and mTLS connections. See documentation of other encryption modes to confirm compatibility. Consider using it if you wish to upgrade in place your deployment to TLS while having mixed TLS and non-TLS traffic reaching port :80.

    CreateTime string

    The timestamp when the resource was created.

    Description string

    Free-text description of the resource.

    Labels map[string]string

    Set of label tags associated with the resource.

    MtlsPolicy MTLSPolicyResponse

    This field is required if the policy is used with external HTTPS load balancers. This field can be empty for Traffic Director. Defines a mechanism to provision peer validation certificates for peer to peer authentication (Mutual TLS - mTLS). If not specified, client certificate will not be requested. The connection is treated as TLS and not mTLS. If allow_open and mtls_policy are set, server allows both plain text and mTLS connections.

    Name string

    Name of the ServerTlsPolicy resource. It matches the pattern projects/*/locations/{location}/serverTlsPolicies/{server_tls_policy}

    ServerCertificate GoogleCloudNetworksecurityV1CertificateProviderResponse

    Optional if policy is to be used with Traffic Director. For external HTTPS load balancer must be empty. Defines a mechanism to provision server identity (public and private keys). Cannot be combined with allow_open as a permissive mode that allows both plain text and TLS is not supported.

    UpdateTime string

    The timestamp when the resource was updated.

    allowOpen Boolean

    This field applies only for Traffic Director policies. It is must be set to false for external HTTPS load balancer policies. Determines if server allows plaintext connections. If set to true, server allows plain text connections. By default, it is set to false. This setting is not exclusive of other encryption modes. For example, if allow_open and mtls_policy are set, server allows both plain text and mTLS connections. See documentation of other encryption modes to confirm compatibility. Consider using it if you wish to upgrade in place your deployment to TLS while having mixed TLS and non-TLS traffic reaching port :80.

    createTime String

    The timestamp when the resource was created.

    description String

    Free-text description of the resource.

    labels Map<String,String>

    Set of label tags associated with the resource.

    mtlsPolicy MTLSPolicyResponse

    This field is required if the policy is used with external HTTPS load balancers. This field can be empty for Traffic Director. Defines a mechanism to provision peer validation certificates for peer to peer authentication (Mutual TLS - mTLS). If not specified, client certificate will not be requested. The connection is treated as TLS and not mTLS. If allow_open and mtls_policy are set, server allows both plain text and mTLS connections.

    name String

    Name of the ServerTlsPolicy resource. It matches the pattern projects/*/locations/{location}/serverTlsPolicies/{server_tls_policy}

    serverCertificate GoogleCloudNetworksecurityV1CertificateProviderResponse

    Optional if policy is to be used with Traffic Director. For external HTTPS load balancer must be empty. Defines a mechanism to provision server identity (public and private keys). Cannot be combined with allow_open as a permissive mode that allows both plain text and TLS is not supported.

    updateTime String

    The timestamp when the resource was updated.

    allowOpen boolean

    This field applies only for Traffic Director policies. It is must be set to false for external HTTPS load balancer policies. Determines if server allows plaintext connections. If set to true, server allows plain text connections. By default, it is set to false. This setting is not exclusive of other encryption modes. For example, if allow_open and mtls_policy are set, server allows both plain text and mTLS connections. See documentation of other encryption modes to confirm compatibility. Consider using it if you wish to upgrade in place your deployment to TLS while having mixed TLS and non-TLS traffic reaching port :80.

    createTime string

    The timestamp when the resource was created.

    description string

    Free-text description of the resource.

    labels {[key: string]: string}

    Set of label tags associated with the resource.

    mtlsPolicy MTLSPolicyResponse

    This field is required if the policy is used with external HTTPS load balancers. This field can be empty for Traffic Director. Defines a mechanism to provision peer validation certificates for peer to peer authentication (Mutual TLS - mTLS). If not specified, client certificate will not be requested. The connection is treated as TLS and not mTLS. If allow_open and mtls_policy are set, server allows both plain text and mTLS connections.

    name string

    Name of the ServerTlsPolicy resource. It matches the pattern projects/*/locations/{location}/serverTlsPolicies/{server_tls_policy}

    serverCertificate GoogleCloudNetworksecurityV1CertificateProviderResponse

    Optional if policy is to be used with Traffic Director. For external HTTPS load balancer must be empty. Defines a mechanism to provision server identity (public and private keys). Cannot be combined with allow_open as a permissive mode that allows both plain text and TLS is not supported.

    updateTime string

    The timestamp when the resource was updated.

    allow_open bool

    This field applies only for Traffic Director policies. It is must be set to false for external HTTPS load balancer policies. Determines if server allows plaintext connections. If set to true, server allows plain text connections. By default, it is set to false. This setting is not exclusive of other encryption modes. For example, if allow_open and mtls_policy are set, server allows both plain text and mTLS connections. See documentation of other encryption modes to confirm compatibility. Consider using it if you wish to upgrade in place your deployment to TLS while having mixed TLS and non-TLS traffic reaching port :80.

    create_time str

    The timestamp when the resource was created.

    description str

    Free-text description of the resource.

    labels Mapping[str, str]

    Set of label tags associated with the resource.

    mtls_policy MTLSPolicyResponse

    This field is required if the policy is used with external HTTPS load balancers. This field can be empty for Traffic Director. Defines a mechanism to provision peer validation certificates for peer to peer authentication (Mutual TLS - mTLS). If not specified, client certificate will not be requested. The connection is treated as TLS and not mTLS. If allow_open and mtls_policy are set, server allows both plain text and mTLS connections.

    name str

    Name of the ServerTlsPolicy resource. It matches the pattern projects/*/locations/{location}/serverTlsPolicies/{server_tls_policy}

    server_certificate GoogleCloudNetworksecurityV1CertificateProviderResponse

    Optional if policy is to be used with Traffic Director. For external HTTPS load balancer must be empty. Defines a mechanism to provision server identity (public and private keys). Cannot be combined with allow_open as a permissive mode that allows both plain text and TLS is not supported.

    update_time str

    The timestamp when the resource was updated.

    allowOpen Boolean

    This field applies only for Traffic Director policies. It is must be set to false for external HTTPS load balancer policies. Determines if server allows plaintext connections. If set to true, server allows plain text connections. By default, it is set to false. This setting is not exclusive of other encryption modes. For example, if allow_open and mtls_policy are set, server allows both plain text and mTLS connections. See documentation of other encryption modes to confirm compatibility. Consider using it if you wish to upgrade in place your deployment to TLS while having mixed TLS and non-TLS traffic reaching port :80.

    createTime String

    The timestamp when the resource was created.

    description String

    Free-text description of the resource.

    labels Map<String>

    Set of label tags associated with the resource.

    mtlsPolicy Property Map

    This field is required if the policy is used with external HTTPS load balancers. This field can be empty for Traffic Director. Defines a mechanism to provision peer validation certificates for peer to peer authentication (Mutual TLS - mTLS). If not specified, client certificate will not be requested. The connection is treated as TLS and not mTLS. If allow_open and mtls_policy are set, server allows both plain text and mTLS connections.

    name String

    Name of the ServerTlsPolicy resource. It matches the pattern projects/*/locations/{location}/serverTlsPolicies/{server_tls_policy}

    serverCertificate Property Map

    Optional if policy is to be used with Traffic Director. For external HTTPS load balancer must be empty. Defines a mechanism to provision server identity (public and private keys). Cannot be combined with allow_open as a permissive mode that allows both plain text and TLS is not supported.

    updateTime String

    The timestamp when the resource was updated.

    Supporting Types

    CertificateProviderInstanceResponse

    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.

    GoogleCloudNetworksecurityV1CertificateProviderResponse

    CertificateProviderInstance Pulumi.GoogleNative.NetworkSecurity.V1.Inputs.CertificateProviderInstanceResponse

    The certificate provider instance specification that will be passed to the data plane, which will be used to load necessary credential information.

    GrpcEndpoint Pulumi.GoogleNative.NetworkSecurity.V1.Inputs.GoogleCloudNetworksecurityV1GrpcEndpointResponse

    gRPC specific configuration to access the gRPC server to obtain the cert and private key.

    CertificateProviderInstance CertificateProviderInstanceResponse

    The certificate provider instance specification that will be passed to the data plane, which will be used to load necessary credential information.

    GrpcEndpoint GoogleCloudNetworksecurityV1GrpcEndpointResponse

    gRPC specific configuration to access the gRPC server to obtain the cert and private key.

    certificateProviderInstance CertificateProviderInstanceResponse

    The certificate provider instance specification that will be passed to the data plane, which will be used to load necessary credential information.

    grpcEndpoint GoogleCloudNetworksecurityV1GrpcEndpointResponse

    gRPC specific configuration to access the gRPC server to obtain the cert and private key.

    certificateProviderInstance CertificateProviderInstanceResponse

    The certificate provider instance specification that will be passed to the data plane, which will be used to load necessary credential information.

    grpcEndpoint GoogleCloudNetworksecurityV1GrpcEndpointResponse

    gRPC specific configuration to access the gRPC server to obtain the cert and private key.

    certificate_provider_instance CertificateProviderInstanceResponse

    The certificate provider instance specification that will be passed to the data plane, which will be used to load necessary credential information.

    grpc_endpoint GoogleCloudNetworksecurityV1GrpcEndpointResponse

    gRPC specific configuration to access the gRPC server to obtain the cert and private key.

    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.

    grpcEndpoint Property Map

    gRPC specific configuration to access the gRPC server to obtain the cert and private key.

    GoogleCloudNetworksecurityV1GrpcEndpointResponse

    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:".

    MTLSPolicyResponse

    ClientValidationCa List<Pulumi.GoogleNative.NetworkSecurity.V1.Inputs.ValidationCAResponse>

    Required if the policy is to be used with Traffic Director. For external HTTPS load balancers it must be empty. Defines the mechanism to obtain the Certificate Authority certificate to validate the client certificate.

    ClientValidationMode string

    When the client presents an invalid certificate or no certificate to the load balancer, the client_validation_mode specifies how the client connection is handled. Required if the policy is to be used with the external HTTPS load balancing. For Traffic Director it must be empty.

    ClientValidationTrustConfig string

    Reference to the TrustConfig from certificatemanager.googleapis.com namespace. If specified, the chain validation will be performed against certificates configured in the given TrustConfig. Allowed only if the policy is to be used with external HTTPS load balancers.

    ClientValidationCa []ValidationCAResponse

    Required if the policy is to be used with Traffic Director. For external HTTPS load balancers it must be empty. Defines the mechanism to obtain the Certificate Authority certificate to validate the client certificate.

    ClientValidationMode string

    When the client presents an invalid certificate or no certificate to the load balancer, the client_validation_mode specifies how the client connection is handled. Required if the policy is to be used with the external HTTPS load balancing. For Traffic Director it must be empty.

    ClientValidationTrustConfig string

    Reference to the TrustConfig from certificatemanager.googleapis.com namespace. If specified, the chain validation will be performed against certificates configured in the given TrustConfig. Allowed only if the policy is to be used with external HTTPS load balancers.

    clientValidationCa List<ValidationCAResponse>

    Required if the policy is to be used with Traffic Director. For external HTTPS load balancers it must be empty. Defines the mechanism to obtain the Certificate Authority certificate to validate the client certificate.

    clientValidationMode String

    When the client presents an invalid certificate or no certificate to the load balancer, the client_validation_mode specifies how the client connection is handled. Required if the policy is to be used with the external HTTPS load balancing. For Traffic Director it must be empty.

    clientValidationTrustConfig String

    Reference to the TrustConfig from certificatemanager.googleapis.com namespace. If specified, the chain validation will be performed against certificates configured in the given TrustConfig. Allowed only if the policy is to be used with external HTTPS load balancers.

    clientValidationCa ValidationCAResponse[]

    Required if the policy is to be used with Traffic Director. For external HTTPS load balancers it must be empty. Defines the mechanism to obtain the Certificate Authority certificate to validate the client certificate.

    clientValidationMode string

    When the client presents an invalid certificate or no certificate to the load balancer, the client_validation_mode specifies how the client connection is handled. Required if the policy is to be used with the external HTTPS load balancing. For Traffic Director it must be empty.

    clientValidationTrustConfig string

    Reference to the TrustConfig from certificatemanager.googleapis.com namespace. If specified, the chain validation will be performed against certificates configured in the given TrustConfig. Allowed only if the policy is to be used with external HTTPS load balancers.

    client_validation_ca Sequence[ValidationCAResponse]

    Required if the policy is to be used with Traffic Director. For external HTTPS load balancers it must be empty. Defines the mechanism to obtain the Certificate Authority certificate to validate the client certificate.

    client_validation_mode str

    When the client presents an invalid certificate or no certificate to the load balancer, the client_validation_mode specifies how the client connection is handled. Required if the policy is to be used with the external HTTPS load balancing. For Traffic Director it must be empty.

    client_validation_trust_config str

    Reference to the TrustConfig from certificatemanager.googleapis.com namespace. If specified, the chain validation will be performed against certificates configured in the given TrustConfig. Allowed only if the policy is to be used with external HTTPS load balancers.

    clientValidationCa List<Property Map>

    Required if the policy is to be used with Traffic Director. For external HTTPS load balancers it must be empty. Defines the mechanism to obtain the Certificate Authority certificate to validate the client certificate.

    clientValidationMode String

    When the client presents an invalid certificate or no certificate to the load balancer, the client_validation_mode specifies how the client connection is handled. Required if the policy is to be used with the external HTTPS load balancing. For Traffic Director it must be empty.

    clientValidationTrustConfig String

    Reference to the TrustConfig from certificatemanager.googleapis.com namespace. If specified, the chain validation will be performed against certificates configured in the given TrustConfig. Allowed only if the policy is to be used with external HTTPS load balancers.

    ValidationCAResponse

    CertificateProviderInstance Pulumi.GoogleNative.NetworkSecurity.V1.Inputs.CertificateProviderInstanceResponse

    The certificate provider instance specification that will be passed to the data plane, which will be used to load necessary credential information.

    GrpcEndpoint Pulumi.GoogleNative.NetworkSecurity.V1.Inputs.GoogleCloudNetworksecurityV1GrpcEndpointResponse

    gRPC specific configuration to access the gRPC server to obtain the CA certificate.

    CertificateProviderInstance CertificateProviderInstanceResponse

    The certificate provider instance specification that will be passed to the data plane, which will be used to load necessary credential information.

    GrpcEndpoint GoogleCloudNetworksecurityV1GrpcEndpointResponse

    gRPC specific configuration to access the gRPC server to obtain the CA certificate.

    certificateProviderInstance CertificateProviderInstanceResponse

    The certificate provider instance specification that will be passed to the data plane, which will be used to load necessary credential information.

    grpcEndpoint GoogleCloudNetworksecurityV1GrpcEndpointResponse

    gRPC specific configuration to access the gRPC server to obtain the CA certificate.

    certificateProviderInstance CertificateProviderInstanceResponse

    The certificate provider instance specification that will be passed to the data plane, which will be used to load necessary credential information.

    grpcEndpoint GoogleCloudNetworksecurityV1GrpcEndpointResponse

    gRPC specific configuration to access the gRPC server to obtain the CA certificate.

    certificate_provider_instance CertificateProviderInstanceResponse

    The certificate provider instance specification that will be passed to the data plane, which will be used to load necessary credential information.

    grpc_endpoint GoogleCloudNetworksecurityV1GrpcEndpointResponse

    gRPC specific configuration to access the gRPC server to obtain the CA certificate.

    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.

    grpcEndpoint Property Map

    gRPC specific configuration to access the gRPC server to obtain the CA certificate.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.31.1 published on Thursday, Jul 20, 2023 by Pulumi