Application Load Balancer API, REST: LoadBalancer.UpdateSniMatch

Field

Description

loadBalancerId

string

Required field. ID of the application load balancer to update the SNI handler in.

The maximum string length in characters is 50.

Field

Description

listenerName

string

Required field. Name of the listener to update the SNI handler in.

name

string

Required field. Name of the SNI handler to update.

updateMask

string (field-mask)

A comma-separated names off ALL fields to be updated.
Only the specified fields will be changed. The others will be left untouched.
If the field is specified in updateMask and no value for that field was sent in the request,
the field's value will be reset to the default. The default value for most fields is null or 0.

If updateMask is not sent in the request, all fields' values will be updated.
Fields specified in the request will be updated to provided values.
The rest of the fields will be reset to the default.

serverNames[]

string

New server names that are matched by the SNI handler.
Existing set of server names is completely replaced by the provided set, so if you just want
to add or remove a server name:

1. Get the current set of server names with a LoadBalancerService.Get request.
2. Add or remove a server name in this set.
3. Send the new set in this field.

The string length in characters for each value must be 1-255. Each value must match the regular expression ([*].)?[-.a-z0-9]+. The number of elements must be greater than 0.

handler

TlsHandler

Required field. New settings for handling requests with Server Name Indication (SNI) matching one of serverNames values.

Field

Description

streamHandler

StreamHandler

Stream (TCP) handler.

Includes only one of the fields streamHandler, httpHandler.

Settings for handling requests.

httpHandler

HttpHandler

HTTP handler.

Includes only one of the fields streamHandler, httpHandler.

Settings for handling requests.

certificateIds[]

string

ID's of the TLS server certificates from Certificate Manager.
RSA and ECDSA certificates are supported, and only the first certificate of each type is used.

The string length in characters for each value must be greater than 1. The maximum number of elements is 1.

clientCertificatesVerification

ClientCertificatesVerification

Client certificates verification settings.

Field

Description

backendGroupId

string

Required field. ID of the backend group processing requests. For details about the concept, see
documentation.
The backend group type, specified via BackendGroup.backend, must be stream.
To get the list of all available backend groups, make a BackendGroupService.List request.

idleTimeout

string (duration)

The idle timeout is duration during which no data is transmitted or received on either the upstream or downstream connection.
If not configured, the default idle timeout is 1 hour. Setting it to 0 disables the timeout.

Field

Description

httpRouterId

string

ID of the HTTP router processing requests. For details about the concept, see
documentation.
To get the list of all available HTTP routers, make a HttpRouterService.List request.

rewriteRequestId

boolean

When unset, will preserve the incoming x-request-id header, otherwise would rewrite it with a new value.

http2Options

Http2Options

HTTP/2 settings.
If specified, incoming HTTP/2 requests are supported by the listener.

Includes only one of the fields http2Options, allowHttp10.

Protocol settings.
For HTTPS (HTTP over TLS) connections, settings are applied to the protocol
negotiated using TLS ALPN extension.

allowHttp10

boolean

Enables support for incoming HTTP/1.0 and HTTP/1.1 requests and disables it for HTTP/2 requests.

Includes only one of the fields http2Options, allowHttp10.

Protocol settings.
For HTTPS (HTTP over TLS) connections, settings are applied to the protocol
negotiated using TLS ALPN extension.

preserveHttp1HeaderCasing

boolean

When enabled, preserves the original casing of HTTP/1.1 header names (e.g. "CONTENT-Type" -> "CONTENT-Type").
Has no effect on HTTP/2 connections where headers are always lowercase per RFC 7540.

Field

Description

maxConcurrentStreams

string (int64)

Maximum number of concurrent HTTP/2 streams in a connection.

Field

Description

requireClientCertificate

boolean

If true, ALB will reject connections without a valid client certificate.

bytes

string

Trusted certificate authority certificates bundle (PEM text).

Includes only one of the fields bytes.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

createdAt

string (date-time)

Creation timestamp.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

createdBy

string

ID of the user or service account who initiated the operation.

modifiedAt

string (date-time)

The time when the Operation resource was last modified.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

done

boolean

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

object

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

object

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

Field

Description

code

integer (int32)

Error code. An enum value of google.rpc.Code.

message

string

An error message.

details[]

object

A list of messages that carry the error details.