Docs Packages
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. networkconnectivity
  5. networkconnectivity/v1
  6. getServiceConnectionPolicy

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.networkconnectivity/v1.getServiceConnectionPolicy

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 ServiceConnectionPolicy.

    Using getServiceConnectionPolicy

    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 getServiceConnectionPolicy(args: GetServiceConnectionPolicyArgs, opts?: InvokeOptions): Promise<GetServiceConnectionPolicyResult>
function getServiceConnectionPolicyOutput(args: GetServiceConnectionPolicyOutputArgs, opts?: InvokeOptions): Output<GetServiceConnectionPolicyResult>
    def get_service_connection_policy(location: Optional[str] = None,
                                  project: Optional[str] = None,
                                  service_connection_policy_id: Optional[str] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetServiceConnectionPolicyResult
def get_service_connection_policy_output(location: Optional[pulumi.Input[str]] = None,
                                  project: Optional[pulumi.Input[str]] = None,
                                  service_connection_policy_id: Optional[pulumi.Input[str]] = None,
                                  opts: Optional[InvokeOptions] = None) -> Output[GetServiceConnectionPolicyResult]
    func LookupServiceConnectionPolicy(ctx *Context, args *LookupServiceConnectionPolicyArgs, opts ...InvokeOption) (*LookupServiceConnectionPolicyResult, error)
func LookupServiceConnectionPolicyOutput(ctx *Context, args *LookupServiceConnectionPolicyOutputArgs, opts ...InvokeOption) LookupServiceConnectionPolicyResultOutput

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

    public static class GetServiceConnectionPolicy 
{
    public static Task<GetServiceConnectionPolicyResult> InvokeAsync(GetServiceConnectionPolicyArgs args, InvokeOptions? opts = null)
    public static Output<GetServiceConnectionPolicyResult> Invoke(GetServiceConnectionPolicyInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetServiceConnectionPolicyResult> getServiceConnectionPolicy(GetServiceConnectionPolicyArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: google-native:networkconnectivity/v1:getServiceConnectionPolicy
  arguments:
    # arguments dictionary

    The following arguments are supported:

    getServiceConnectionPolicy Result

    The following output properties are available:

    CreateTime string
    Time when the ServiceConnectionMap was created.
    Description string
    A description of this resource.
    Etag string
    Optional. The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
    Infrastructure string
    The type of underlying resources used to create the connection.
    Labels Dictionary<string, string>
    User-defined labels.
    Name string
    Immutable. The name of a ServiceConnectionPolicy. Format: projects/{project}/locations/{location}/serviceConnectionPolicies/{service_connection_policy} See: https://google.aip.dev/122#fields-representing-resource-names
    Network string
    The resource path of the consumer network. Example: - projects/{projectNumOrId}/global/networks/{resourceId}.
    PscConfig Pulumi.GoogleNative.NetworkConnectivity.V1.Outputs.PscConfigResponse
    Configuration used for Private Service Connect connections. Used when Infrastructure is PSC.
    PscConnections List<Pulumi.GoogleNative.NetworkConnectivity.V1.Outputs.PscConnectionResponse>
    [Output only] Information about each Private Service Connect connection.
    ServiceClass string
    The service class identifier for which this ServiceConnectionPolicy is for. The service class identifier is a unique, symbolic representation of a ServiceClass. It is provided by the Service Producer. Google services have a prefix of gcp. For example, gcp-cloud-sql. 3rd party services do not. For example, test-service-a3dfcx.
    UpdateTime string
    Time when the ServiceConnectionMap was updated.
    CreateTime string
    Time when the ServiceConnectionMap was created.
    Description string
    A description of this resource.
    Etag string
    Optional. The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
    Infrastructure string
    The type of underlying resources used to create the connection.
    Labels map[string]string
    User-defined labels.
    Name string
    Immutable. The name of a ServiceConnectionPolicy. Format: projects/{project}/locations/{location}/serviceConnectionPolicies/{service_connection_policy} See: https://google.aip.dev/122#fields-representing-resource-names
    Network string
    The resource path of the consumer network. Example: - projects/{projectNumOrId}/global/networks/{resourceId}.
    PscConfig PscConfigResponse
    Configuration used for Private Service Connect connections. Used when Infrastructure is PSC.
    PscConnections []PscConnectionResponse
    [Output only] Information about each Private Service Connect connection.
    ServiceClass string
    The service class identifier for which this ServiceConnectionPolicy is for. The service class identifier is a unique, symbolic representation of a ServiceClass. It is provided by the Service Producer. Google services have a prefix of gcp. For example, gcp-cloud-sql. 3rd party services do not. For example, test-service-a3dfcx.
    UpdateTime string
    Time when the ServiceConnectionMap was updated.
    createTime String
    Time when the ServiceConnectionMap was created.
    description String
    A description of this resource.
    etag String
    Optional. The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
    infrastructure String
    The type of underlying resources used to create the connection.
    labels Map<String,String>
    User-defined labels.
    name String
    Immutable. The name of a ServiceConnectionPolicy. Format: projects/{project}/locations/{location}/serviceConnectionPolicies/{service_connection_policy} See: https://google.aip.dev/122#fields-representing-resource-names
    network String
    The resource path of the consumer network. Example: - projects/{projectNumOrId}/global/networks/{resourceId}.
    pscConfig PscConfigResponse
    Configuration used for Private Service Connect connections. Used when Infrastructure is PSC.
    pscConnections List<PscConnectionResponse>
    [Output only] Information about each Private Service Connect connection.
    serviceClass String
    The service class identifier for which this ServiceConnectionPolicy is for. The service class identifier is a unique, symbolic representation of a ServiceClass. It is provided by the Service Producer. Google services have a prefix of gcp. For example, gcp-cloud-sql. 3rd party services do not. For example, test-service-a3dfcx.
    updateTime String
    Time when the ServiceConnectionMap was updated.
    createTime string
    Time when the ServiceConnectionMap was created.
    description string
    A description of this resource.
    etag string
    Optional. The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
    infrastructure string
    The type of underlying resources used to create the connection.
    labels {[key: string]: string}
    User-defined labels.
    name string
    Immutable. The name of a ServiceConnectionPolicy. Format: projects/{project}/locations/{location}/serviceConnectionPolicies/{service_connection_policy} See: https://google.aip.dev/122#fields-representing-resource-names
    network string
    The resource path of the consumer network. Example: - projects/{projectNumOrId}/global/networks/{resourceId}.
    pscConfig PscConfigResponse
    Configuration used for Private Service Connect connections. Used when Infrastructure is PSC.
    pscConnections PscConnectionResponse[]
    [Output only] Information about each Private Service Connect connection.
    serviceClass string
    The service class identifier for which this ServiceConnectionPolicy is for. The service class identifier is a unique, symbolic representation of a ServiceClass. It is provided by the Service Producer. Google services have a prefix of gcp. For example, gcp-cloud-sql. 3rd party services do not. For example, test-service-a3dfcx.
    updateTime string
    Time when the ServiceConnectionMap was updated.
    create_time str
    Time when the ServiceConnectionMap was created.
    description str
    A description of this resource.
    etag str
    Optional. The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
    infrastructure str
    The type of underlying resources used to create the connection.
    labels Mapping[str, str]
    User-defined labels.
    name str
    Immutable. The name of a ServiceConnectionPolicy. Format: projects/{project}/locations/{location}/serviceConnectionPolicies/{service_connection_policy} See: https://google.aip.dev/122#fields-representing-resource-names
    network str
    The resource path of the consumer network. Example: - projects/{projectNumOrId}/global/networks/{resourceId}.
    psc_config PscConfigResponse
    Configuration used for Private Service Connect connections. Used when Infrastructure is PSC.
    psc_connections Sequence[PscConnectionResponse]
    [Output only] Information about each Private Service Connect connection.
    service_class str
    The service class identifier for which this ServiceConnectionPolicy is for. The service class identifier is a unique, symbolic representation of a ServiceClass. It is provided by the Service Producer. Google services have a prefix of gcp. For example, gcp-cloud-sql. 3rd party services do not. For example, test-service-a3dfcx.
    update_time str
    Time when the ServiceConnectionMap was updated.
    createTime String
    Time when the ServiceConnectionMap was created.
    description String
    A description of this resource.
    etag String
    Optional. The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
    infrastructure String
    The type of underlying resources used to create the connection.
    labels Map<String>
    User-defined labels.
    name String
    Immutable. The name of a ServiceConnectionPolicy. Format: projects/{project}/locations/{location}/serviceConnectionPolicies/{service_connection_policy} See: https://google.aip.dev/122#fields-representing-resource-names
    network String
    The resource path of the consumer network. Example: - projects/{projectNumOrId}/global/networks/{resourceId}.
    pscConfig Property Map
    Configuration used for Private Service Connect connections. Used when Infrastructure is PSC.
    pscConnections List<Property Map>
    [Output only] Information about each Private Service Connect connection.
    serviceClass String
    The service class identifier for which this ServiceConnectionPolicy is for. The service class identifier is a unique, symbolic representation of a ServiceClass. It is provided by the Service Producer. Google services have a prefix of gcp. For example, gcp-cloud-sql. 3rd party services do not. For example, test-service-a3dfcx.
    updateTime String
    Time when the ServiceConnectionMap was updated.

    Supporting Types

    GoogleRpcErrorInfoResponse

    Domain string
    The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
    Metadata Dictionary<string, string>
    Additional structured details about this error. Keys should match /[a-zA-Z0-9-_]/ and be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
    Reason string
    The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of A-Z+[A-Z0-9], which represents UPPER_SNAKE_CASE.
    Domain string
    The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
    Metadata map[string]string
    Additional structured details about this error. Keys should match /[a-zA-Z0-9-_]/ and be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
    Reason string
    The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of A-Z+[A-Z0-9], which represents UPPER_SNAKE_CASE.
    domain String
    The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
    metadata Map<String,String>
    Additional structured details about this error. Keys should match /[a-zA-Z0-9-_]/ and be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
    reason String
    The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of A-Z+[A-Z0-9], which represents UPPER_SNAKE_CASE.
    domain string
    The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
    metadata {[key: string]: string}
    Additional structured details about this error. Keys should match /[a-zA-Z0-9-_]/ and be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
    reason string
    The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of A-Z+[A-Z0-9], which represents UPPER_SNAKE_CASE.
    domain str
    The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
    metadata Mapping[str, str]
    Additional structured details about this error. Keys should match /[a-zA-Z0-9-_]/ and be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
    reason str
    The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of A-Z+[A-Z0-9], which represents UPPER_SNAKE_CASE.
    domain String
    The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
    metadata Map<String>
    Additional structured details about this error. Keys should match /[a-zA-Z0-9-_]/ and be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
    reason String
    The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of A-Z+[A-Z0-9], which represents UPPER_SNAKE_CASE.

    GoogleRpcStatusResponse

    Code int
    The status code, which should be an enum value of google.rpc.Code.
    Details List<ImmutableDictionary<string, string>>
    A list of messages that carry the error details. There is a common set of message types for APIs to use.
    Message string
    A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
    Code int
    The status code, which should be an enum value of google.rpc.Code.
    Details []map[string]string
    A list of messages that carry the error details. There is a common set of message types for APIs to use.
    Message string
    A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
    code Integer
    The status code, which should be an enum value of google.rpc.Code.
    details List<Map<String,String>>
    A list of messages that carry the error details. There is a common set of message types for APIs to use.
    message String
    A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
    code number
    The status code, which should be an enum value of google.rpc.Code.
    details {[key: string]: string}[]
    A list of messages that carry the error details. There is a common set of message types for APIs to use.
    message string
    A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
    code int
    The status code, which should be an enum value of google.rpc.Code.
    details Sequence[Mapping[str, str]]
    A list of messages that carry the error details. There is a common set of message types for APIs to use.
    message str
    A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
    code Number
    The status code, which should be an enum value of google.rpc.Code.
    details List<Map<String>>
    A list of messages that carry the error details. There is a common set of message types for APIs to use.
    message String
    A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

    PscConfigResponse

    Limit string
    Optional. Max number of PSC connections for this policy.
    Subnetworks List<string>
    The resource paths of subnetworks to use for IP address management. Example: projects/{projectNumOrId}/regions/{region}/subnetworks/{resourceId}.
    Limit string
    Optional. Max number of PSC connections for this policy.
    Subnetworks []string
    The resource paths of subnetworks to use for IP address management. Example: projects/{projectNumOrId}/regions/{region}/subnetworks/{resourceId}.
    limit String
    Optional. Max number of PSC connections for this policy.
    subnetworks List<String>
    The resource paths of subnetworks to use for IP address management. Example: projects/{projectNumOrId}/regions/{region}/subnetworks/{resourceId}.
    limit string
    Optional. Max number of PSC connections for this policy.
    subnetworks string[]
    The resource paths of subnetworks to use for IP address management. Example: projects/{projectNumOrId}/regions/{region}/subnetworks/{resourceId}.
    limit str
    Optional. Max number of PSC connections for this policy.
    subnetworks Sequence[str]
    The resource paths of subnetworks to use for IP address management. Example: projects/{projectNumOrId}/regions/{region}/subnetworks/{resourceId}.
    limit String
    Optional. Max number of PSC connections for this policy.
    subnetworks List<String>
    The resource paths of subnetworks to use for IP address management. Example: projects/{projectNumOrId}/regions/{region}/subnetworks/{resourceId}.

    PscConnectionResponse

    ConsumerAddress string
    The resource reference of the consumer address.
    ConsumerForwardingRule string
    The resource reference of the PSC Forwarding Rule within the consumer VPC.
    ConsumerTargetProject string
    The project where the PSC connection is created.
    Error Pulumi.GoogleNative.NetworkConnectivity.V1.Inputs.GoogleRpcStatusResponse
    The most recent error during operating this connection.
    ErrorInfo Pulumi.GoogleNative.NetworkConnectivity.V1.Inputs.GoogleRpcErrorInfoResponse
    The error info for the latest error during operating this connection.
    ErrorType string
    The error type indicates whether the error is consumer facing, producer facing or system internal.
    GceOperation string
    The last Compute Engine operation to setup PSC connection.
    PscConnectionId string
    The PSC connection id of the PSC forwarding rule.
    State string
    State of the PSC Connection
    ConsumerAddress string
    The resource reference of the consumer address.
    ConsumerForwardingRule string
    The resource reference of the PSC Forwarding Rule within the consumer VPC.
    ConsumerTargetProject string
    The project where the PSC connection is created.
    Error GoogleRpcStatusResponse
    The most recent error during operating this connection.
    ErrorInfo GoogleRpcErrorInfoResponse
    The error info for the latest error during operating this connection.
    ErrorType string
    The error type indicates whether the error is consumer facing, producer facing or system internal.
    GceOperation string
    The last Compute Engine operation to setup PSC connection.
    PscConnectionId string
    The PSC connection id of the PSC forwarding rule.
    State string
    State of the PSC Connection
    consumerAddress String
    The resource reference of the consumer address.
    consumerForwardingRule String
    The resource reference of the PSC Forwarding Rule within the consumer VPC.
    consumerTargetProject String
    The project where the PSC connection is created.
    error GoogleRpcStatusResponse
    The most recent error during operating this connection.
    errorInfo GoogleRpcErrorInfoResponse
    The error info for the latest error during operating this connection.
    errorType String
    The error type indicates whether the error is consumer facing, producer facing or system internal.
    gceOperation String
    The last Compute Engine operation to setup PSC connection.
    pscConnectionId String
    The PSC connection id of the PSC forwarding rule.
    state String
    State of the PSC Connection
    consumerAddress string
    The resource reference of the consumer address.
    consumerForwardingRule string
    The resource reference of the PSC Forwarding Rule within the consumer VPC.
    consumerTargetProject string
    The project where the PSC connection is created.
    error GoogleRpcStatusResponse
    The most recent error during operating this connection.
    errorInfo GoogleRpcErrorInfoResponse
    The error info for the latest error during operating this connection.
    errorType string
    The error type indicates whether the error is consumer facing, producer facing or system internal.
    gceOperation string
    The last Compute Engine operation to setup PSC connection.
    pscConnectionId string
    The PSC connection id of the PSC forwarding rule.
    state string
    State of the PSC Connection
    consumer_address str
    The resource reference of the consumer address.
    consumer_forwarding_rule str
    The resource reference of the PSC Forwarding Rule within the consumer VPC.
    consumer_target_project str
    The project where the PSC connection is created.
    error GoogleRpcStatusResponse
    The most recent error during operating this connection.
    error_info GoogleRpcErrorInfoResponse
    The error info for the latest error during operating this connection.
    error_type str
    The error type indicates whether the error is consumer facing, producer facing or system internal.
    gce_operation str
    The last Compute Engine operation to setup PSC connection.
    psc_connection_id str
    The PSC connection id of the PSC forwarding rule.
    state str
    State of the PSC Connection
    consumerAddress String
    The resource reference of the consumer address.
    consumerForwardingRule String
    The resource reference of the PSC Forwarding Rule within the consumer VPC.
    consumerTargetProject String
    The project where the PSC connection is created.
    error Property Map
    The most recent error during operating this connection.
    errorInfo Property Map
    The error info for the latest error during operating this connection.
    errorType String
    The error type indicates whether the error is consumer facing, producer facing or system internal.
    gceOperation String
    The last Compute Engine operation to setup PSC connection.
    pscConnectionId String
    The PSC connection id of the PSC forwarding rule.
    state String
    State of the PSC Connection

    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