Documentation
¶
Index ¶
- Variables
- type AwsRequestSigning
- func (*AwsRequestSigning) Descriptor() ([]byte, []int)deprecated
- func (x *AwsRequestSigning) GetHostRewrite() string
- func (x *AwsRequestSigning) GetRegion() string
- func (x *AwsRequestSigning) GetServiceName() string
- func (*AwsRequestSigning) ProtoMessage()
- func (x *AwsRequestSigning) ProtoReflect() protoreflect.Message
- func (x *AwsRequestSigning) Reset()
- func (x *AwsRequestSigning) String() string
- func (m *AwsRequestSigning) Validate() error
- func (m *AwsRequestSigning) ValidateAll() error
- type AwsRequestSigningMultiError
- type AwsRequestSigningValidationError
- func (e AwsRequestSigningValidationError) Cause() error
- func (e AwsRequestSigningValidationError) Error() string
- func (e AwsRequestSigningValidationError) ErrorName() string
- func (e AwsRequestSigningValidationError) Field() string
- func (e AwsRequestSigningValidationError) Key() bool
- func (e AwsRequestSigningValidationError) Reason() string
Constants ¶
This section is empty.
Variables ¶
var File_envoy_config_filter_http_aws_request_signing_v2alpha_aws_request_signing_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type AwsRequestSigning ¶
type AwsRequestSigning struct {
// The `service namespace
// <https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces>`_
// of the HTTP endpoint.
//
// Example: s3
ServiceName string `protobuf:"bytes,1,opt,name=service_name,json=serviceName,proto3" json:"service_name,omitempty"`
// The `region <https://docs.aws.amazon.com/general/latest/gr/rande.html>`_ hosting the HTTP
// endpoint.
//
// Example: us-west-2
Region string `protobuf:"bytes,2,opt,name=region,proto3" json:"region,omitempty"`
// Indicates that before signing headers, the host header will be swapped with
// this value. If not set or empty, the original host header value
// will be used and no rewrite will happen.
//
// Note: this rewrite affects both signing and host header forwarding. However, this
// option shouldn't be used with
// :ref:`HCM host rewrite <envoy_api_field_route.RouteAction.host_rewrite>` given that the
// value set here would be used for signing whereas the value set in the HCM would be used
// for host header forwarding which is not the desired outcome.
HostRewrite string `protobuf:"bytes,3,opt,name=host_rewrite,json=hostRewrite,proto3" json:"host_rewrite,omitempty"`
// contains filtered or unexported fields
}
Top level configuration for the AWS request signing filter.
func (*AwsRequestSigning) Descriptor
deprecated
func (*AwsRequestSigning) Descriptor() ([]byte, []int)
Deprecated: Use AwsRequestSigning.ProtoReflect.Descriptor instead.
func (*AwsRequestSigning) GetHostRewrite ¶ added in v0.9.5
func (x *AwsRequestSigning) GetHostRewrite() string
func (*AwsRequestSigning) GetRegion ¶
func (x *AwsRequestSigning) GetRegion() string
func (*AwsRequestSigning) GetServiceName ¶
func (x *AwsRequestSigning) GetServiceName() string
func (*AwsRequestSigning) ProtoMessage ¶
func (*AwsRequestSigning) ProtoMessage()
func (*AwsRequestSigning) ProtoReflect ¶ added in v0.9.6
func (x *AwsRequestSigning) ProtoReflect() protoreflect.Message
func (*AwsRequestSigning) Reset ¶
func (x *AwsRequestSigning) Reset()
func (*AwsRequestSigning) String ¶
func (x *AwsRequestSigning) String() string
func (*AwsRequestSigning) Validate ¶
func (m *AwsRequestSigning) Validate() error
Validate checks the field values on AwsRequestSigning with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.
func (*AwsRequestSigning) ValidateAll ¶ added in v0.10.0
func (m *AwsRequestSigning) ValidateAll() error
ValidateAll checks the field values on AwsRequestSigning with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in AwsRequestSigningMultiError, or nil if none found.
type AwsRequestSigningMultiError ¶ added in v0.10.0
type AwsRequestSigningMultiError []error
AwsRequestSigningMultiError is an error wrapping multiple validation errors returned by AwsRequestSigning.ValidateAll() if the designated constraints aren't met.
func (AwsRequestSigningMultiError) AllErrors ¶ added in v0.10.0
func (m AwsRequestSigningMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (AwsRequestSigningMultiError) Error ¶ added in v0.10.0
func (m AwsRequestSigningMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type AwsRequestSigningValidationError ¶
type AwsRequestSigningValidationError struct {
// contains filtered or unexported fields
}
AwsRequestSigningValidationError is the validation error returned by AwsRequestSigning.Validate if the designated constraints aren't met.
func (AwsRequestSigningValidationError) Cause ¶
func (e AwsRequestSigningValidationError) Cause() error
Cause function returns cause value.
func (AwsRequestSigningValidationError) Error ¶
func (e AwsRequestSigningValidationError) Error() string
Error satisfies the builtin error interface
func (AwsRequestSigningValidationError) ErrorName ¶
func (e AwsRequestSigningValidationError) ErrorName() string
ErrorName returns error name.
func (AwsRequestSigningValidationError) Field ¶
func (e AwsRequestSigningValidationError) Field() string
Field function returns field value.
func (AwsRequestSigningValidationError) Key ¶
func (e AwsRequestSigningValidationError) Key() bool
Key function returns key value.
func (AwsRequestSigningValidationError) Reason ¶
func (e AwsRequestSigningValidationError) Reason() string
Reason function returns reason value.
Source Files