Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. networkservices
  5. networkservices/v1
  6. getEndpointPolicy

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

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.networkservices/v1.getEndpointPolicy

Explore with Pulumi AI

google-native logo

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

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

    Gets details of a single EndpointPolicy.

    Using getEndpointPolicy

    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 getEndpointPolicy(args: GetEndpointPolicyArgs, opts?: InvokeOptions): Promise<GetEndpointPolicyResult>
function getEndpointPolicyOutput(args: GetEndpointPolicyOutputArgs, opts?: InvokeOptions): Output<GetEndpointPolicyResult>
    def get_endpoint_policy(endpoint_policy_id: Optional[str] = None,
                        location: Optional[str] = None,
                        project: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetEndpointPolicyResult
def get_endpoint_policy_output(endpoint_policy_id: Optional[pulumi.Input[str]] = None,
                        location: Optional[pulumi.Input[str]] = None,
                        project: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetEndpointPolicyResult]
    func LookupEndpointPolicy(ctx *Context, args *LookupEndpointPolicyArgs, opts ...InvokeOption) (*LookupEndpointPolicyResult, error)
func LookupEndpointPolicyOutput(ctx *Context, args *LookupEndpointPolicyOutputArgs, opts ...InvokeOption) LookupEndpointPolicyResultOutput

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

    public static class GetEndpointPolicy 
{
    public static Task<GetEndpointPolicyResult> InvokeAsync(GetEndpointPolicyArgs args, InvokeOptions? opts = null)
    public static Output<GetEndpointPolicyResult> Invoke(GetEndpointPolicyInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetEndpointPolicyResult> getEndpointPolicy(GetEndpointPolicyArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: google-native:networkservices/v1:getEndpointPolicy
  arguments:
    # arguments dictionary

    The following arguments are supported:

    EndpointPolicyId string
    Location string
    Project string
    EndpointPolicyId string
    Location string
    Project string
    endpointPolicyId String
    location String
    project String
    endpointPolicyId string
    location string
    project string
    endpointPolicyId String
    location String
    project String

    getEndpointPolicy Result

    The following output properties are available:

    AuthorizationPolicy string
    Optional. This field specifies the URL of AuthorizationPolicy resource that applies authorization policies to the inbound traffic at the matched endpoints. Refer to Authorization. If this field is not specified, authorization is disabled(no authz checks) for this endpoint.
    ClientTlsPolicy string
    Optional. A URL referring to a ClientTlsPolicy resource. ClientTlsPolicy can be set to specify the authentication for traffic from the proxy to the actual endpoints. More specifically, it is applied to the outgoing traffic from the proxy to the endpoint. This is typically used for sidecar model where the proxy identifies itself as endpoint to the control plane, with the connection between sidecar and endpoint requiring authentication. If this field is not set, authentication is disabled(open). Applicable only when EndpointPolicyType is SIDECAR_PROXY.
    CreateTime string
    The timestamp when the resource was created.
    Description string
    Optional. A free-text description of the resource. Max length 1024 characters.
    EndpointMatcher Pulumi.GoogleNative.NetworkServices.V1.Outputs.EndpointMatcherResponse
    A matcher that selects endpoints to which the policies should be applied.
    Labels Dictionary<string, string>
    Optional. Set of label tags associated with the EndpointPolicy resource.
    Name string
    Name of the EndpointPolicy resource. It matches pattern projects/{project}/locations/global/endpointPolicies/{endpoint_policy}.
    ServerTlsPolicy string
    Optional. A URL referring to ServerTlsPolicy resource. ServerTlsPolicy is used to determine the authentication policy to be applied to terminate the inbound traffic at the identified backends. If this field is not set, authentication is disabled(open) for this endpoint.
    TrafficPortSelector Pulumi.GoogleNative.NetworkServices.V1.Outputs.TrafficPortSelectorResponse
    Optional. Port selector for the (matched) endpoints. If no port selector is provided, the matched config is applied to all ports.
    Type string
    The type of endpoint policy. This is primarily used to validate the configuration.
    UpdateTime string
    The timestamp when the resource was updated.
    AuthorizationPolicy string
    Optional. This field specifies the URL of AuthorizationPolicy resource that applies authorization policies to the inbound traffic at the matched endpoints. Refer to Authorization. If this field is not specified, authorization is disabled(no authz checks) for this endpoint.
    ClientTlsPolicy string
    Optional. A URL referring to a ClientTlsPolicy resource. ClientTlsPolicy can be set to specify the authentication for traffic from the proxy to the actual endpoints. More specifically, it is applied to the outgoing traffic from the proxy to the endpoint. This is typically used for sidecar model where the proxy identifies itself as endpoint to the control plane, with the connection between sidecar and endpoint requiring authentication. If this field is not set, authentication is disabled(open). Applicable only when EndpointPolicyType is SIDECAR_PROXY.
    CreateTime string
    The timestamp when the resource was created.
    Description string
    Optional. A free-text description of the resource. Max length 1024 characters.
    EndpointMatcher EndpointMatcherResponse
    A matcher that selects endpoints to which the policies should be applied.
    Labels map[string]string
    Optional. Set of label tags associated with the EndpointPolicy resource.
    Name string
    Name of the EndpointPolicy resource. It matches pattern projects/{project}/locations/global/endpointPolicies/{endpoint_policy}.
    ServerTlsPolicy string
    Optional. A URL referring to ServerTlsPolicy resource. ServerTlsPolicy is used to determine the authentication policy to be applied to terminate the inbound traffic at the identified backends. If this field is not set, authentication is disabled(open) for this endpoint.
    TrafficPortSelector TrafficPortSelectorResponse
    Optional. Port selector for the (matched) endpoints. If no port selector is provided, the matched config is applied to all ports.
    Type string
    The type of endpoint policy. This is primarily used to validate the configuration.
    UpdateTime string
    The timestamp when the resource was updated.
    authorizationPolicy String
    Optional. This field specifies the URL of AuthorizationPolicy resource that applies authorization policies to the inbound traffic at the matched endpoints. Refer to Authorization. If this field is not specified, authorization is disabled(no authz checks) for this endpoint.
    clientTlsPolicy String
    Optional. A URL referring to a ClientTlsPolicy resource. ClientTlsPolicy can be set to specify the authentication for traffic from the proxy to the actual endpoints. More specifically, it is applied to the outgoing traffic from the proxy to the endpoint. This is typically used for sidecar model where the proxy identifies itself as endpoint to the control plane, with the connection between sidecar and endpoint requiring authentication. If this field is not set, authentication is disabled(open). Applicable only when EndpointPolicyType is SIDECAR_PROXY.
    createTime String
    The timestamp when the resource was created.
    description String
    Optional. A free-text description of the resource. Max length 1024 characters.
    endpointMatcher EndpointMatcherResponse
    A matcher that selects endpoints to which the policies should be applied.
    labels Map<String,String>
    Optional. Set of label tags associated with the EndpointPolicy resource.
    name String
    Name of the EndpointPolicy resource. It matches pattern projects/{project}/locations/global/endpointPolicies/{endpoint_policy}.
    serverTlsPolicy String
    Optional. A URL referring to ServerTlsPolicy resource. ServerTlsPolicy is used to determine the authentication policy to be applied to terminate the inbound traffic at the identified backends. If this field is not set, authentication is disabled(open) for this endpoint.
    trafficPortSelector TrafficPortSelectorResponse
    Optional. Port selector for the (matched) endpoints. If no port selector is provided, the matched config is applied to all ports.
    type String
    The type of endpoint policy. This is primarily used to validate the configuration.
    updateTime String
    The timestamp when the resource was updated.
    authorizationPolicy string
    Optional. This field specifies the URL of AuthorizationPolicy resource that applies authorization policies to the inbound traffic at the matched endpoints. Refer to Authorization. If this field is not specified, authorization is disabled(no authz checks) for this endpoint.
    clientTlsPolicy string
    Optional. A URL referring to a ClientTlsPolicy resource. ClientTlsPolicy can be set to specify the authentication for traffic from the proxy to the actual endpoints. More specifically, it is applied to the outgoing traffic from the proxy to the endpoint. This is typically used for sidecar model where the proxy identifies itself as endpoint to the control plane, with the connection between sidecar and endpoint requiring authentication. If this field is not set, authentication is disabled(open). Applicable only when EndpointPolicyType is SIDECAR_PROXY.
    createTime string
    The timestamp when the resource was created.
    description string
    Optional. A free-text description of the resource. Max length 1024 characters.
    endpointMatcher EndpointMatcherResponse
    A matcher that selects endpoints to which the policies should be applied.
    labels {[key: string]: string}
    Optional. Set of label tags associated with the EndpointPolicy resource.
    name string
    Name of the EndpointPolicy resource. It matches pattern projects/{project}/locations/global/endpointPolicies/{endpoint_policy}.
    serverTlsPolicy string
    Optional. A URL referring to ServerTlsPolicy resource. ServerTlsPolicy is used to determine the authentication policy to be applied to terminate the inbound traffic at the identified backends. If this field is not set, authentication is disabled(open) for this endpoint.
    trafficPortSelector TrafficPortSelectorResponse
    Optional. Port selector for the (matched) endpoints. If no port selector is provided, the matched config is applied to all ports.
    type string
    The type of endpoint policy. This is primarily used to validate the configuration.
    updateTime string
    The timestamp when the resource was updated.
    authorization_policy str
    Optional. This field specifies the URL of AuthorizationPolicy resource that applies authorization policies to the inbound traffic at the matched endpoints. Refer to Authorization. If this field is not specified, authorization is disabled(no authz checks) for this endpoint.
    client_tls_policy str
    Optional. A URL referring to a ClientTlsPolicy resource. ClientTlsPolicy can be set to specify the authentication for traffic from the proxy to the actual endpoints. More specifically, it is applied to the outgoing traffic from the proxy to the endpoint. This is typically used for sidecar model where the proxy identifies itself as endpoint to the control plane, with the connection between sidecar and endpoint requiring authentication. If this field is not set, authentication is disabled(open). Applicable only when EndpointPolicyType is SIDECAR_PROXY.
    create_time str
    The timestamp when the resource was created.
    description str
    Optional. A free-text description of the resource. Max length 1024 characters.
    endpoint_matcher EndpointMatcherResponse
    A matcher that selects endpoints to which the policies should be applied.
    labels Mapping[str, str]
    Optional. Set of label tags associated with the EndpointPolicy resource.
    name str
    Name of the EndpointPolicy resource. It matches pattern projects/{project}/locations/global/endpointPolicies/{endpoint_policy}.
    server_tls_policy str
    Optional. A URL referring to ServerTlsPolicy resource. ServerTlsPolicy is used to determine the authentication policy to be applied to terminate the inbound traffic at the identified backends. If this field is not set, authentication is disabled(open) for this endpoint.
    traffic_port_selector TrafficPortSelectorResponse
    Optional. Port selector for the (matched) endpoints. If no port selector is provided, the matched config is applied to all ports.
    type str
    The type of endpoint policy. This is primarily used to validate the configuration.
    update_time str
    The timestamp when the resource was updated.
    authorizationPolicy String
    Optional. This field specifies the URL of AuthorizationPolicy resource that applies authorization policies to the inbound traffic at the matched endpoints. Refer to Authorization. If this field is not specified, authorization is disabled(no authz checks) for this endpoint.
    clientTlsPolicy String
    Optional. A URL referring to a ClientTlsPolicy resource. ClientTlsPolicy can be set to specify the authentication for traffic from the proxy to the actual endpoints. More specifically, it is applied to the outgoing traffic from the proxy to the endpoint. This is typically used for sidecar model where the proxy identifies itself as endpoint to the control plane, with the connection between sidecar and endpoint requiring authentication. If this field is not set, authentication is disabled(open). Applicable only when EndpointPolicyType is SIDECAR_PROXY.
    createTime String
    The timestamp when the resource was created.
    description String
    Optional. A free-text description of the resource. Max length 1024 characters.
    endpointMatcher Property Map
    A matcher that selects endpoints to which the policies should be applied.
    labels Map<String>
    Optional. Set of label tags associated with the EndpointPolicy resource.
    name String
    Name of the EndpointPolicy resource. It matches pattern projects/{project}/locations/global/endpointPolicies/{endpoint_policy}.
    serverTlsPolicy String
    Optional. A URL referring to ServerTlsPolicy resource. ServerTlsPolicy is used to determine the authentication policy to be applied to terminate the inbound traffic at the identified backends. If this field is not set, authentication is disabled(open) for this endpoint.
    trafficPortSelector Property Map
    Optional. Port selector for the (matched) endpoints. If no port selector is provided, the matched config is applied to all ports.
    type String
    The type of endpoint policy. This is primarily used to validate the configuration.
    updateTime String
    The timestamp when the resource was updated.

    Supporting Types

    EndpointMatcherMetadataLabelMatcherMetadataLabelsResponse

    LabelName string
    Label name presented as key in xDS Node Metadata.
    LabelValue string
    Label value presented as value corresponding to the above key, in xDS Node Metadata.
    LabelName string
    Label name presented as key in xDS Node Metadata.
    LabelValue string
    Label value presented as value corresponding to the above key, in xDS Node Metadata.
    labelName String
    Label name presented as key in xDS Node Metadata.
    labelValue String
    Label value presented as value corresponding to the above key, in xDS Node Metadata.
    labelName string
    Label name presented as key in xDS Node Metadata.
    labelValue string
    Label value presented as value corresponding to the above key, in xDS Node Metadata.
    label_name str
    Label name presented as key in xDS Node Metadata.
    label_value str
    Label value presented as value corresponding to the above key, in xDS Node Metadata.
    labelName String
    Label name presented as key in xDS Node Metadata.
    labelValue String
    Label value presented as value corresponding to the above key, in xDS Node Metadata.

    EndpointMatcherMetadataLabelMatcherResponse

    MetadataLabelMatchCriteria string
    Specifies how matching should be done. Supported values are: MATCH_ANY: At least one of the Labels specified in the matcher should match the metadata presented by xDS client. MATCH_ALL: The metadata presented by the xDS client should contain all of the labels specified here. The selection is determined based on the best match. For example, suppose there are three EndpointPolicy resources P1, P2 and P3 and if P1 has a the matcher as MATCH_ANY , P2 has MATCH_ALL , and P3 has MATCH_ALL . If a client with label connects, the config from P1 will be selected. If a client with label connects, the config from P2 will be selected. If a client with label connects, the config from P3 will be selected. If there is more than one best match, (for example, if a config P4 with selector exists and if a client with label connects), an error will be thrown.
    MetadataLabels List<Pulumi.GoogleNative.NetworkServices.V1.Inputs.EndpointMatcherMetadataLabelMatcherMetadataLabelsResponse>
    The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria This list can have at most 64 entries. The list can be empty if the match criteria is MATCH_ANY, to specify a wildcard match (i.e this matches any client).
    MetadataLabelMatchCriteria string
    Specifies how matching should be done. Supported values are: MATCH_ANY: At least one of the Labels specified in the matcher should match the metadata presented by xDS client. MATCH_ALL: The metadata presented by the xDS client should contain all of the labels specified here. The selection is determined based on the best match. For example, suppose there are three EndpointPolicy resources P1, P2 and P3 and if P1 has a the matcher as MATCH_ANY , P2 has MATCH_ALL , and P3 has MATCH_ALL . If a client with label connects, the config from P1 will be selected. If a client with label connects, the config from P2 will be selected. If a client with label connects, the config from P3 will be selected. If there is more than one best match, (for example, if a config P4 with selector exists and if a client with label connects), an error will be thrown.
    MetadataLabels []EndpointMatcherMetadataLabelMatcherMetadataLabelsResponse
    The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria This list can have at most 64 entries. The list can be empty if the match criteria is MATCH_ANY, to specify a wildcard match (i.e this matches any client).
    metadataLabelMatchCriteria String
    Specifies how matching should be done. Supported values are: MATCH_ANY: At least one of the Labels specified in the matcher should match the metadata presented by xDS client. MATCH_ALL: The metadata presented by the xDS client should contain all of the labels specified here. The selection is determined based on the best match. For example, suppose there are three EndpointPolicy resources P1, P2 and P3 and if P1 has a the matcher as MATCH_ANY , P2 has MATCH_ALL , and P3 has MATCH_ALL . If a client with label connects, the config from P1 will be selected. If a client with label connects, the config from P2 will be selected. If a client with label connects, the config from P3 will be selected. If there is more than one best match, (for example, if a config P4 with selector exists and if a client with label connects), an error will be thrown.
    metadataLabels List<EndpointMatcherMetadataLabelMatcherMetadataLabelsResponse>
    The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria This list can have at most 64 entries. The list can be empty if the match criteria is MATCH_ANY, to specify a wildcard match (i.e this matches any client).
    metadataLabelMatchCriteria string
    Specifies how matching should be done. Supported values are: MATCH_ANY: At least one of the Labels specified in the matcher should match the metadata presented by xDS client. MATCH_ALL: The metadata presented by the xDS client should contain all of the labels specified here. The selection is determined based on the best match. For example, suppose there are three EndpointPolicy resources P1, P2 and P3 and if P1 has a the matcher as MATCH_ANY , P2 has MATCH_ALL , and P3 has MATCH_ALL . If a client with label connects, the config from P1 will be selected. If a client with label connects, the config from P2 will be selected. If a client with label connects, the config from P3 will be selected. If there is more than one best match, (for example, if a config P4 with selector exists and if a client with label connects), an error will be thrown.
    metadataLabels EndpointMatcherMetadataLabelMatcherMetadataLabelsResponse[]
    The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria This list can have at most 64 entries. The list can be empty if the match criteria is MATCH_ANY, to specify a wildcard match (i.e this matches any client).
    metadata_label_match_criteria str
    Specifies how matching should be done. Supported values are: MATCH_ANY: At least one of the Labels specified in the matcher should match the metadata presented by xDS client. MATCH_ALL: The metadata presented by the xDS client should contain all of the labels specified here. The selection is determined based on the best match. For example, suppose there are three EndpointPolicy resources P1, P2 and P3 and if P1 has a the matcher as MATCH_ANY , P2 has MATCH_ALL , and P3 has MATCH_ALL . If a client with label connects, the config from P1 will be selected. If a client with label connects, the config from P2 will be selected. If a client with label connects, the config from P3 will be selected. If there is more than one best match, (for example, if a config P4 with selector exists and if a client with label connects), an error will be thrown.
    metadata_labels Sequence[EndpointMatcherMetadataLabelMatcherMetadataLabelsResponse]
    The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria This list can have at most 64 entries. The list can be empty if the match criteria is MATCH_ANY, to specify a wildcard match (i.e this matches any client).
    metadataLabelMatchCriteria String
    Specifies how matching should be done. Supported values are: MATCH_ANY: At least one of the Labels specified in the matcher should match the metadata presented by xDS client. MATCH_ALL: The metadata presented by the xDS client should contain all of the labels specified here. The selection is determined based on the best match. For example, suppose there are three EndpointPolicy resources P1, P2 and P3 and if P1 has a the matcher as MATCH_ANY , P2 has MATCH_ALL , and P3 has MATCH_ALL . If a client with label connects, the config from P1 will be selected. If a client with label connects, the config from P2 will be selected. If a client with label connects, the config from P3 will be selected. If there is more than one best match, (for example, if a config P4 with selector exists and if a client with label connects), an error will be thrown.
    metadataLabels List<Property Map>
    The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria This list can have at most 64 entries. The list can be empty if the match criteria is MATCH_ANY, to specify a wildcard match (i.e this matches any client).

    EndpointMatcherResponse

    MetadataLabelMatcher EndpointMatcherMetadataLabelMatcherResponse
    The matcher is based on node metadata presented by xDS clients.
    metadataLabelMatcher EndpointMatcherMetadataLabelMatcherResponse
    The matcher is based on node metadata presented by xDS clients.
    metadataLabelMatcher EndpointMatcherMetadataLabelMatcherResponse
    The matcher is based on node metadata presented by xDS clients.
    metadata_label_matcher EndpointMatcherMetadataLabelMatcherResponse
    The matcher is based on node metadata presented by xDS clients.
    metadataLabelMatcher Property Map
    The matcher is based on node metadata presented by xDS clients.

    TrafficPortSelectorResponse

    Ports List<string>
    Optional. A list of ports. Can be port numbers or port range (example, [80-90] specifies all ports from 80 to 90, including 80 and 90) or named ports or * to specify all ports. If the list is empty, all ports are selected.
    Ports []string
    Optional. A list of ports. Can be port numbers or port range (example, [80-90] specifies all ports from 80 to 90, including 80 and 90) or named ports or * to specify all ports. If the list is empty, all ports are selected.
    ports List<String>
    Optional. A list of ports. Can be port numbers or port range (example, [80-90] specifies all ports from 80 to 90, including 80 and 90) or named ports or * to specify all ports. If the list is empty, all ports are selected.
    ports string[]
    Optional. A list of ports. Can be port numbers or port range (example, [80-90] specifies all ports from 80 to 90, including 80 and 90) or named ports or * to specify all ports. If the list is empty, all ports are selected.
    ports Sequence[str]
    Optional. A list of ports. Can be port numbers or port range (example, [80-90] specifies all ports from 80 to 90, including 80 and 90) or named ports or * to specify all ports. If the list is empty, all ports are selected.
    ports List<String>
    Optional. A list of ports. Can be port numbers or port range (example, [80-90] specifies all ports from 80 to 90, including 80 and 90) or named ports or * to specify all ports. If the list is empty, all ports are selected.

    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.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
    pulumi/pulumi-google-native