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 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>
Copy
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]
Copy
func LookupTargetServer(ctx *Context, args *LookupTargetServerArgs, opts ...InvokeOption) (*LookupTargetServerResult, error)
func LookupTargetServerOutput(ctx *Context, args *LookupTargetServerOutputArgs, opts ...InvokeOption) LookupTargetServerResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetTargetServerResult> getTargetServer(GetTargetServerArgs args, InvokeOptions options)
public static Output<GetTargetServerResult> getTargetServer(GetTargetServerArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: google-native:apigee/v1:getTargetServer
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

EnvironmentId This property is required. string
OrganizationId This property is required. string
TargetserverId This property is required. string
EnvironmentId This property is required. string
OrganizationId This property is required. string
TargetserverId This property is required. string
environmentId This property is required. String
organizationId This property is required. String
targetserverId This property is required. String
environmentId This property is required. string
organizationId This property is required. string
targetserverId This property is required. string
environment_id This property is required. str
organization_id This property is required. str
targetserver_id This property is required. str
environmentId This property is required. String
organizationId This property is required. String
targetserverId This property is required. String

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 This property is required. string
The TLS Common Name string of the certificate.
WildcardMatch This property is required. bool
Indicates whether the cert should be matched against as a wildcard cert.
Value This property is required. string
The TLS Common Name string of the certificate.
WildcardMatch This property is required. bool
Indicates whether the cert should be matched against as a wildcard cert.
value This property is required. String
The TLS Common Name string of the certificate.
wildcardMatch This property is required. Boolean
Indicates whether the cert should be matched against as a wildcard cert.
value This property is required. string
The TLS Common Name string of the certificate.
wildcardMatch This property is required. boolean
Indicates whether the cert should be matched against as a wildcard cert.
value This property is required. str
The TLS Common Name string of the certificate.
wildcard_match This property is required. bool
Indicates whether the cert should be matched against as a wildcard cert.
value This property is required. String
The TLS Common Name string of the certificate.
wildcardMatch This property is required. Boolean
Indicates whether the cert should be matched against as a wildcard cert.

GoogleCloudApigeeV1TlsInfoResponse

Ciphers This property is required. 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 This property is required. bool
Optional. Enables two-way TLS.
CommonName This property is required. Pulumi.GoogleNative.Apigee.V1.Inputs.GoogleCloudApigeeV1TlsInfoCommonNameResponse
The TLS Common Name of the certificate.
Enabled This property is required. bool
Enables TLS. If false, neither one-way nor two-way TLS will be enabled.
IgnoreValidationErrors This property is required. 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 This property is required. string
Required if client_auth_enabled is true. The resource ID for the alias containing the private key and cert.
KeyStore This property is required. string
Required if client_auth_enabled is true. The resource ID of the keystore.
Protocols This property is required. List<string>
The TLS versioins to be used.
TrustStore This property is required. string
The resource ID of the truststore.
Ciphers This property is required. []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 This property is required. bool
Optional. Enables two-way TLS.
CommonName This property is required. GoogleCloudApigeeV1TlsInfoCommonNameResponse
The TLS Common Name of the certificate.
Enabled This property is required. bool
Enables TLS. If false, neither one-way nor two-way TLS will be enabled.
IgnoreValidationErrors This property is required. 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 This property is required. string
Required if client_auth_enabled is true. The resource ID for the alias containing the private key and cert.
KeyStore This property is required. string
Required if client_auth_enabled is true. The resource ID of the keystore.
Protocols This property is required. []string
The TLS versioins to be used.
TrustStore This property is required. string
The resource ID of the truststore.
ciphers This property is required. 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 This property is required. Boolean
Optional. Enables two-way TLS.
commonName This property is required. GoogleCloudApigeeV1TlsInfoCommonNameResponse
The TLS Common Name of the certificate.
enabled This property is required. Boolean
Enables TLS. If false, neither one-way nor two-way TLS will be enabled.
ignoreValidationErrors This property is required. 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 This property is required. String
Required if client_auth_enabled is true. The resource ID for the alias containing the private key and cert.
keyStore This property is required. String
Required if client_auth_enabled is true. The resource ID of the keystore.
protocols This property is required. List<String>
The TLS versioins to be used.
trustStore This property is required. String
The resource ID of the truststore.
ciphers This property is required. 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 This property is required. boolean
Optional. Enables two-way TLS.
commonName This property is required. GoogleCloudApigeeV1TlsInfoCommonNameResponse
The TLS Common Name of the certificate.
enabled This property is required. boolean
Enables TLS. If false, neither one-way nor two-way TLS will be enabled.
ignoreValidationErrors This property is required. 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 This property is required. string
Required if client_auth_enabled is true. The resource ID for the alias containing the private key and cert.
keyStore This property is required. string
Required if client_auth_enabled is true. The resource ID of the keystore.
protocols This property is required. string[]
The TLS versioins to be used.
trustStore This property is required. string
The resource ID of the truststore.
ciphers This property is required. 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 This property is required. bool
Optional. Enables two-way TLS.
common_name This property is required. GoogleCloudApigeeV1TlsInfoCommonNameResponse
The TLS Common Name of the certificate.
enabled This property is required. bool
Enables TLS. If false, neither one-way nor two-way TLS will be enabled.
ignore_validation_errors This property is required. 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 This property is required. str
Required if client_auth_enabled is true. The resource ID for the alias containing the private key and cert.
key_store This property is required. str
Required if client_auth_enabled is true. The resource ID of the keystore.
protocols This property is required. Sequence[str]
The TLS versioins to be used.
trust_store This property is required. str
The resource ID of the truststore.
ciphers This property is required. 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 This property is required. Boolean
Optional. Enables two-way TLS.
commonName This property is required. Property Map
The TLS Common Name of the certificate.
enabled This property is required. Boolean
Enables TLS. If false, neither one-way nor two-way TLS will be enabled.
ignoreValidationErrors This property is required. 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 This property is required. String
Required if client_auth_enabled is true. The resource ID for the alias containing the private key and cert.
keyStore This property is required. String
Required if client_auth_enabled is true. The resource ID of the keystore.
protocols This property is required. List<String>
The TLS versioins to be used.
trustStore This property is required. String
The resource ID of the truststore.

Package Details

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

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