1. Packages
  2. Google Cloud Native
  3. API Docs
  4. apigee
  5. apigee/v1
  6. getTargetServer

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

google-native.apigee/v1.getTargetServer

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

    Gets a TargetServer resource.

    Using getTargetServer

    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 getTargetServer(args: GetTargetServerArgs, opts?: InvokeOptions): Promise<GetTargetServerResult>
    function getTargetServerOutput(args: GetTargetServerOutputArgs, opts?: InvokeOptions): Output<GetTargetServerResult>
    def get_target_server(environment_id: Optional[str] = None,
                          organization_id: Optional[str] = None,
                          targetserver_id: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetTargetServerResult
    def get_target_server_output(environment_id: Optional[pulumi.Input[str]] = None,
                          organization_id: Optional[pulumi.Input[str]] = None,
                          targetserver_id: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetTargetServerResult]
    func LookupTargetServer(ctx *Context, args *LookupTargetServerArgs, opts ...InvokeOption) (*LookupTargetServerResult, error)
    func LookupTargetServerOutput(ctx *Context, args *LookupTargetServerOutputArgs, opts ...InvokeOption) LookupTargetServerResultOutput

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

    public static class GetTargetServer 
    {
        public static Task<GetTargetServerResult> InvokeAsync(GetTargetServerArgs args, InvokeOptions? opts = null)
        public static Output<GetTargetServerResult> Invoke(GetTargetServerInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetTargetServerResult> getTargetServer(GetTargetServerArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: google-native:apigee/v1:getTargetServer
      arguments:
        # arguments dictionary

    The following arguments are supported:

    getTargetServer Result

    The following output properties are available:

    Description string
    Optional. A human-readable description of this TargetServer.
    Host string
    The host name this target connects to. Value must be a valid hostname as described by RFC-1123.
    IsEnabled bool
    Optional. Enabling/disabling a TargetServer is useful when TargetServers are used in load balancing configurations, and one or more TargetServers need to taken out of rotation periodically. Defaults to true.
    Name string
    The resource id of this target server. Values must match the regular expression
    Port int
    The port number this target connects to on the given host. Value must be between 1 and 65535, inclusive.
    Protocol string
    Immutable. The protocol used by this TargetServer.
    SSLInfo Pulumi.GoogleNative.Apigee.V1.Outputs.GoogleCloudApigeeV1TlsInfoResponse
    Optional. Specifies TLS configuration info for this TargetServer. The JSON name is sSLInfo for legacy/backwards compatibility reasons -- Edge originally supported SSL, and the name is still used for TLS configuration.
    Description string
    Optional. A human-readable description of this TargetServer.
    Host string
    The host name this target connects to. Value must be a valid hostname as described by RFC-1123.
    IsEnabled bool
    Optional. Enabling/disabling a TargetServer is useful when TargetServers are used in load balancing configurations, and one or more TargetServers need to taken out of rotation periodically. Defaults to true.
    Name string
    The resource id of this target server. Values must match the regular expression
    Port int
    The port number this target connects to on the given host. Value must be between 1 and 65535, inclusive.
    Protocol string
    Immutable. The protocol used by this TargetServer.
    SSLInfo GoogleCloudApigeeV1TlsInfoResponse
    Optional. Specifies TLS configuration info for this TargetServer. The JSON name is sSLInfo for legacy/backwards compatibility reasons -- Edge originally supported SSL, and the name is still used for TLS configuration.
    description String
    Optional. A human-readable description of this TargetServer.
    host String
    The host name this target connects to. Value must be a valid hostname as described by RFC-1123.
    isEnabled Boolean
    Optional. Enabling/disabling a TargetServer is useful when TargetServers are used in load balancing configurations, and one or more TargetServers need to taken out of rotation periodically. Defaults to true.
    name String
    The resource id of this target server. Values must match the regular expression
    port Integer
    The port number this target connects to on the given host. Value must be between 1 and 65535, inclusive.
    protocol String
    Immutable. The protocol used by this TargetServer.
    sSLInfo GoogleCloudApigeeV1TlsInfoResponse
    Optional. Specifies TLS configuration info for this TargetServer. The JSON name is sSLInfo for legacy/backwards compatibility reasons -- Edge originally supported SSL, and the name is still used for TLS configuration.
    description string
    Optional. A human-readable description of this TargetServer.
    host string
    The host name this target connects to. Value must be a valid hostname as described by RFC-1123.
    isEnabled boolean
    Optional. Enabling/disabling a TargetServer is useful when TargetServers are used in load balancing configurations, and one or more TargetServers need to taken out of rotation periodically. Defaults to true.
    name string
    The resource id of this target server. Values must match the regular expression
    port number
    The port number this target connects to on the given host. Value must be between 1 and 65535, inclusive.
    protocol string
    Immutable. The protocol used by this TargetServer.
    sSLInfo GoogleCloudApigeeV1TlsInfoResponse
    Optional. Specifies TLS configuration info for this TargetServer. The JSON name is sSLInfo for legacy/backwards compatibility reasons -- Edge originally supported SSL, and the name is still used for TLS configuration.
    description str
    Optional. A human-readable description of this TargetServer.
    host str
    The host name this target connects to. Value must be a valid hostname as described by RFC-1123.
    is_enabled bool
    Optional. Enabling/disabling a TargetServer is useful when TargetServers are used in load balancing configurations, and one or more TargetServers need to taken out of rotation periodically. Defaults to true.
    name str
    The resource id of this target server. Values must match the regular expression
    port int
    The port number this target connects to on the given host. Value must be between 1 and 65535, inclusive.
    protocol str
    Immutable. The protocol used by this TargetServer.
    s_sl_info GoogleCloudApigeeV1TlsInfoResponse
    Optional. Specifies TLS configuration info for this TargetServer. The JSON name is sSLInfo for legacy/backwards compatibility reasons -- Edge originally supported SSL, and the name is still used for TLS configuration.
    description String
    Optional. A human-readable description of this TargetServer.
    host String
    The host name this target connects to. Value must be a valid hostname as described by RFC-1123.
    isEnabled Boolean
    Optional. Enabling/disabling a TargetServer is useful when TargetServers are used in load balancing configurations, and one or more TargetServers need to taken out of rotation periodically. Defaults to true.
    name String
    The resource id of this target server. Values must match the regular expression
    port Number
    The port number this target connects to on the given host. Value must be between 1 and 65535, inclusive.
    protocol String
    Immutable. The protocol used by this TargetServer.
    sSLInfo Property Map
    Optional. Specifies TLS configuration info for this TargetServer. The JSON name is sSLInfo for legacy/backwards compatibility reasons -- Edge originally supported SSL, and the name is still used for TLS configuration.

    Supporting Types

    GoogleCloudApigeeV1TlsInfoCommonNameResponse

    Value string
    The TLS Common Name string of the certificate.
    WildcardMatch bool
    Indicates whether the cert should be matched against as a wildcard cert.
    Value string
    The TLS Common Name string of the certificate.
    WildcardMatch bool
    Indicates whether the cert should be matched against as a wildcard cert.
    value String
    The TLS Common Name string of the certificate.
    wildcardMatch Boolean
    Indicates whether the cert should be matched against as a wildcard cert.
    value string
    The TLS Common Name string of the certificate.
    wildcardMatch boolean
    Indicates whether the cert should be matched against as a wildcard cert.
    value str
    The TLS Common Name string of the certificate.
    wildcard_match bool
    Indicates whether the cert should be matched against as a wildcard cert.
    value String
    The TLS Common Name string of the certificate.
    wildcardMatch Boolean
    Indicates whether the cert should be matched against as a wildcard cert.

    GoogleCloudApigeeV1TlsInfoResponse

    Ciphers List<string>
    The SSL/TLS cipher suites to be used. For programmable proxies, it must be one of the cipher suite names listed in: http://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#ciphersuites. For configurable proxies, it must follow the configuration specified in: https://commondatastorage.googleapis.com/chromium-boringssl-docs/ssl.h.html#Cipher-suite-configuration. This setting has no effect for configurable proxies when negotiating TLS 1.3.
    ClientAuthEnabled bool
    Optional. Enables two-way TLS.
    CommonName Pulumi.GoogleNative.Apigee.V1.Inputs.GoogleCloudApigeeV1TlsInfoCommonNameResponse
    The TLS Common Name of the certificate.
    Enabled bool
    Enables TLS. If false, neither one-way nor two-way TLS will be enabled.
    IgnoreValidationErrors bool
    If true, Edge ignores TLS certificate errors. Valid when configuring TLS for target servers and target endpoints, and when configuring virtual hosts that use 2-way TLS. When used with a target endpoint/target server, if the backend system uses SNI and returns a cert with a subject Distinguished Name (DN) that does not match the hostname, there is no way to ignore the error and the connection fails.
    KeyAlias string
    Required if client_auth_enabled is true. The resource ID for the alias containing the private key and cert.
    KeyStore string
    Required if client_auth_enabled is true. The resource ID of the keystore.
    Protocols List<string>
    The TLS versioins to be used.
    TrustStore string
    The resource ID of the truststore.
    Ciphers []string
    The SSL/TLS cipher suites to be used. For programmable proxies, it must be one of the cipher suite names listed in: http://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#ciphersuites. For configurable proxies, it must follow the configuration specified in: https://commondatastorage.googleapis.com/chromium-boringssl-docs/ssl.h.html#Cipher-suite-configuration. This setting has no effect for configurable proxies when negotiating TLS 1.3.
    ClientAuthEnabled bool
    Optional. Enables two-way TLS.
    CommonName GoogleCloudApigeeV1TlsInfoCommonNameResponse
    The TLS Common Name of the certificate.
    Enabled bool
    Enables TLS. If false, neither one-way nor two-way TLS will be enabled.
    IgnoreValidationErrors bool
    If true, Edge ignores TLS certificate errors. Valid when configuring TLS for target servers and target endpoints, and when configuring virtual hosts that use 2-way TLS. When used with a target endpoint/target server, if the backend system uses SNI and returns a cert with a subject Distinguished Name (DN) that does not match the hostname, there is no way to ignore the error and the connection fails.
    KeyAlias string
    Required if client_auth_enabled is true. The resource ID for the alias containing the private key and cert.
    KeyStore string
    Required if client_auth_enabled is true. The resource ID of the keystore.
    Protocols []string
    The TLS versioins to be used.
    TrustStore string
    The resource ID of the truststore.
    ciphers List<String>
    The SSL/TLS cipher suites to be used. For programmable proxies, it must be one of the cipher suite names listed in: http://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#ciphersuites. For configurable proxies, it must follow the configuration specified in: https://commondatastorage.googleapis.com/chromium-boringssl-docs/ssl.h.html#Cipher-suite-configuration. This setting has no effect for configurable proxies when negotiating TLS 1.3.
    clientAuthEnabled Boolean
    Optional. Enables two-way TLS.
    commonName GoogleCloudApigeeV1TlsInfoCommonNameResponse
    The TLS Common Name of the certificate.
    enabled Boolean
    Enables TLS. If false, neither one-way nor two-way TLS will be enabled.
    ignoreValidationErrors Boolean
    If true, Edge ignores TLS certificate errors. Valid when configuring TLS for target servers and target endpoints, and when configuring virtual hosts that use 2-way TLS. When used with a target endpoint/target server, if the backend system uses SNI and returns a cert with a subject Distinguished Name (DN) that does not match the hostname, there is no way to ignore the error and the connection fails.
    keyAlias String
    Required if client_auth_enabled is true. The resource ID for the alias containing the private key and cert.
    keyStore String
    Required if client_auth_enabled is true. The resource ID of the keystore.
    protocols List<String>
    The TLS versioins to be used.
    trustStore String
    The resource ID of the truststore.
    ciphers string[]
    The SSL/TLS cipher suites to be used. For programmable proxies, it must be one of the cipher suite names listed in: http://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#ciphersuites. For configurable proxies, it must follow the configuration specified in: https://commondatastorage.googleapis.com/chromium-boringssl-docs/ssl.h.html#Cipher-suite-configuration. This setting has no effect for configurable proxies when negotiating TLS 1.3.
    clientAuthEnabled boolean
    Optional. Enables two-way TLS.
    commonName GoogleCloudApigeeV1TlsInfoCommonNameResponse
    The TLS Common Name of the certificate.
    enabled boolean
    Enables TLS. If false, neither one-way nor two-way TLS will be enabled.
    ignoreValidationErrors boolean
    If true, Edge ignores TLS certificate errors. Valid when configuring TLS for target servers and target endpoints, and when configuring virtual hosts that use 2-way TLS. When used with a target endpoint/target server, if the backend system uses SNI and returns a cert with a subject Distinguished Name (DN) that does not match the hostname, there is no way to ignore the error and the connection fails.
    keyAlias string
    Required if client_auth_enabled is true. The resource ID for the alias containing the private key and cert.
    keyStore string
    Required if client_auth_enabled is true. The resource ID of the keystore.
    protocols string[]
    The TLS versioins to be used.
    trustStore string
    The resource ID of the truststore.
    ciphers Sequence[str]
    The SSL/TLS cipher suites to be used. For programmable proxies, it must be one of the cipher suite names listed in: http://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#ciphersuites. For configurable proxies, it must follow the configuration specified in: https://commondatastorage.googleapis.com/chromium-boringssl-docs/ssl.h.html#Cipher-suite-configuration. This setting has no effect for configurable proxies when negotiating TLS 1.3.
    client_auth_enabled bool
    Optional. Enables two-way TLS.
    common_name GoogleCloudApigeeV1TlsInfoCommonNameResponse
    The TLS Common Name of the certificate.
    enabled bool
    Enables TLS. If false, neither one-way nor two-way TLS will be enabled.
    ignore_validation_errors bool
    If true, Edge ignores TLS certificate errors. Valid when configuring TLS for target servers and target endpoints, and when configuring virtual hosts that use 2-way TLS. When used with a target endpoint/target server, if the backend system uses SNI and returns a cert with a subject Distinguished Name (DN) that does not match the hostname, there is no way to ignore the error and the connection fails.
    key_alias str
    Required if client_auth_enabled is true. The resource ID for the alias containing the private key and cert.
    key_store str
    Required if client_auth_enabled is true. The resource ID of the keystore.
    protocols Sequence[str]
    The TLS versioins to be used.
    trust_store str
    The resource ID of the truststore.
    ciphers List<String>
    The SSL/TLS cipher suites to be used. For programmable proxies, it must be one of the cipher suite names listed in: http://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#ciphersuites. For configurable proxies, it must follow the configuration specified in: https://commondatastorage.googleapis.com/chromium-boringssl-docs/ssl.h.html#Cipher-suite-configuration. This setting has no effect for configurable proxies when negotiating TLS 1.3.
    clientAuthEnabled Boolean
    Optional. Enables two-way TLS.
    commonName Property Map
    The TLS Common Name of the certificate.
    enabled Boolean
    Enables TLS. If false, neither one-way nor two-way TLS will be enabled.
    ignoreValidationErrors Boolean
    If true, Edge ignores TLS certificate errors. Valid when configuring TLS for target servers and target endpoints, and when configuring virtual hosts that use 2-way TLS. When used with a target endpoint/target server, if the backend system uses SNI and returns a cert with a subject Distinguished Name (DN) that does not match the hostname, there is no way to ignore the error and the connection fails.
    keyAlias String
    Required if client_auth_enabled is true. The resource ID for the alias containing the private key and cert.
    keyStore String
    Required if client_auth_enabled is true. The resource ID of the keystore.
    protocols List<String>
    The TLS versioins to be used.
    trustStore String
    The resource ID of the truststore.

    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