awsv3

package
v1.33.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 22, 2025 License: Apache-2.0 Imports: 19 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var File_envoy_extensions_common_aws_v3_credential_provider_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type AssumeRoleWithWebIdentityCredentialProvider 

type AssumeRoleWithWebIdentityCredentialProvider struct {

	// Data source for a web identity token that is provided by the identity provider to assume the role.
	// When using this data source, even if a “watched_directory“ is provided, the token file will only be re-read when the credentials
	// returned from AssumeRoleWithWebIdentity expire.
	WebIdentityTokenDataSource *v3.DataSource `` /* 145-byte string literal not displayed */
	// The ARN of the role to assume.
	RoleArn string `protobuf:"bytes,2,opt,name=role_arn,json=roleArn,proto3" json:"role_arn,omitempty"`
	// Optional role session name to use in AssumeRoleWithWebIdentity API call.
	RoleSessionName string `protobuf:"bytes,3,opt,name=role_session_name,json=roleSessionName,proto3" json:"role_session_name,omitempty"`
	// contains filtered or unexported fields
}

Configuration to use `AssumeRoleWithWebIdentity <https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRoleWithWebIdentity.html>`_ to retrieve AWS credentials.

func (*AssumeRoleWithWebIdentityCredentialProvider) Descriptor deprecated 

func (*AssumeRoleWithWebIdentityCredentialProvider) Descriptor() ([]byte, []int)

Deprecated: Use AssumeRoleWithWebIdentityCredentialProvider.ProtoReflect.Descriptor instead.

func (*AssumeRoleWithWebIdentityCredentialProvider) GetRoleArn 

func (x *AssumeRoleWithWebIdentityCredentialProvider) GetRoleArn() string

func (*AssumeRoleWithWebIdentityCredentialProvider) GetRoleSessionName 

func (x *AssumeRoleWithWebIdentityCredentialProvider) GetRoleSessionName() string

func (*AssumeRoleWithWebIdentityCredentialProvider) GetWebIdentityTokenDataSource 

func (x *AssumeRoleWithWebIdentityCredentialProvider) GetWebIdentityTokenDataSource() *v3.DataSource

func (*AssumeRoleWithWebIdentityCredentialProvider) ProtoMessage 

func (*AssumeRoleWithWebIdentityCredentialProvider) ProtoMessage()

func (*AssumeRoleWithWebIdentityCredentialProvider) ProtoReflect 

func (x *AssumeRoleWithWebIdentityCredentialProvider) ProtoReflect() protoreflect.Message

func (*AssumeRoleWithWebIdentityCredentialProvider) Reset 

func (x *AssumeRoleWithWebIdentityCredentialProvider) Reset()

func (*AssumeRoleWithWebIdentityCredentialProvider) String 

func (x *AssumeRoleWithWebIdentityCredentialProvider) String() string

func (*AssumeRoleWithWebIdentityCredentialProvider) Validate 

func (m *AssumeRoleWithWebIdentityCredentialProvider) Validate() error

Validate checks the field values on AssumeRoleWithWebIdentityCredentialProvider 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 (*AssumeRoleWithWebIdentityCredentialProvider) ValidateAll 

func (m *AssumeRoleWithWebIdentityCredentialProvider) ValidateAll() error

ValidateAll checks the field values on AssumeRoleWithWebIdentityCredentialProvider 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 AssumeRoleWithWebIdentityCredentialProviderMultiError, or nil if none found.

type AssumeRoleWithWebIdentityCredentialProviderMultiError 

type AssumeRoleWithWebIdentityCredentialProviderMultiError []error

AssumeRoleWithWebIdentityCredentialProviderMultiError is an error wrapping multiple validation errors returned by AssumeRoleWithWebIdentityCredentialProvider.ValidateAll() if the designated constraints aren't met.

func (AssumeRoleWithWebIdentityCredentialProviderMultiError) AllErrors 

func (m AssumeRoleWithWebIdentityCredentialProviderMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (AssumeRoleWithWebIdentityCredentialProviderMultiError) Error 

func (m AssumeRoleWithWebIdentityCredentialProviderMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type AssumeRoleWithWebIdentityCredentialProviderValidationError 

type AssumeRoleWithWebIdentityCredentialProviderValidationError struct {
	// contains filtered or unexported fields
}

AssumeRoleWithWebIdentityCredentialProviderValidationError is the validation error returned by AssumeRoleWithWebIdentityCredentialProvider.Validate if the designated constraints aren't met.

func (AssumeRoleWithWebIdentityCredentialProviderValidationError) Cause 

func (e AssumeRoleWithWebIdentityCredentialProviderValidationError) Cause() error

Cause function returns cause value.

func (AssumeRoleWithWebIdentityCredentialProviderValidationError) Error 

func (e AssumeRoleWithWebIdentityCredentialProviderValidationError) Error() string

Error satisfies the builtin error interface

func (AssumeRoleWithWebIdentityCredentialProviderValidationError) ErrorName 

func (e AssumeRoleWithWebIdentityCredentialProviderValidationError) ErrorName() string

ErrorName returns error name.

func (AssumeRoleWithWebIdentityCredentialProviderValidationError) Field 

func (e AssumeRoleWithWebIdentityCredentialProviderValidationError) Field() string

Field function returns field value.

func (AssumeRoleWithWebIdentityCredentialProviderValidationError) Key 

func (e AssumeRoleWithWebIdentityCredentialProviderValidationError) Key() bool

Key function returns key value.

func (AssumeRoleWithWebIdentityCredentialProviderValidationError) Reason 

func (e AssumeRoleWithWebIdentityCredentialProviderValidationError) Reason() string

Reason function returns reason value.

type AwsCredentialProvider 

type AwsCredentialProvider struct {

	// The option to use `AssumeRoleWithWebIdentity <https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRoleWithWebIdentity.html>`_.
	AssumeRoleWithWebIdentityProvider *AssumeRoleWithWebIdentityCredentialProvider `` /* 168-byte string literal not displayed */
	// The option to use an inline credential. If inline credential is provided, no chain will be created and only the inline credential will be used.
	InlineCredential *InlineCredentialProvider `protobuf:"bytes,2,opt,name=inline_credential,json=inlineCredential,proto3" json:"inline_credential,omitempty"`
	// The option to specify parameters for credential retrieval from an envoy data source, such as a file in AWS credential format.
	CredentialsFileProvider *CredentialsFileCredentialProvider `` /* 132-byte string literal not displayed */
	// Create a custom credential provider chain instead of the default credential provider chain.
	// If set to TRUE, the credential provider chain that is created contains only those set in this credential provider message.
	// If set to FALSE, the settings provided here will act as modifiers to the default credential provider chain.
	// Defaults to FALSE.
	//
	// This has no effect if inline_credential is provided.
	CustomCredentialProviderChain bool `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

Configuration for AWS credential provider. This is optional and the credentials are normally retrieved from the environment or AWS configuration files by following the default credential provider chain. However, this configuration can be used to override the default behavior.

func (*AwsCredentialProvider) Descriptor deprecated 

func (*AwsCredentialProvider) Descriptor() ([]byte, []int)

Deprecated: Use AwsCredentialProvider.ProtoReflect.Descriptor instead.

func (*AwsCredentialProvider) GetAssumeRoleWithWebIdentityProvider 

func (x *AwsCredentialProvider) GetAssumeRoleWithWebIdentityProvider() *AssumeRoleWithWebIdentityCredentialProvider

func (*AwsCredentialProvider) GetCredentialsFileProvider 

func (x *AwsCredentialProvider) GetCredentialsFileProvider() *CredentialsFileCredentialProvider

func (*AwsCredentialProvider) GetCustomCredentialProviderChain 

func (x *AwsCredentialProvider) GetCustomCredentialProviderChain() bool

func (*AwsCredentialProvider) GetInlineCredential 

func (x *AwsCredentialProvider) GetInlineCredential() *InlineCredentialProvider

func (*AwsCredentialProvider) ProtoMessage 

func (*AwsCredentialProvider) ProtoMessage()

func (*AwsCredentialProvider) ProtoReflect 

func (x *AwsCredentialProvider) ProtoReflect() protoreflect.Message

func (*AwsCredentialProvider) Reset 

func (x *AwsCredentialProvider) Reset()

func (*AwsCredentialProvider) String 

func (x *AwsCredentialProvider) String() string

func (*AwsCredentialProvider) Validate 

func (m *AwsCredentialProvider) Validate() error

Validate checks the field values on AwsCredentialProvider 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 (*AwsCredentialProvider) ValidateAll 

func (m *AwsCredentialProvider) ValidateAll() error

ValidateAll checks the field values on AwsCredentialProvider 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 AwsCredentialProviderMultiError, or nil if none found.

type AwsCredentialProviderMultiError 

type AwsCredentialProviderMultiError []error

AwsCredentialProviderMultiError is an error wrapping multiple validation errors returned by AwsCredentialProvider.ValidateAll() if the designated constraints aren't met.

func (AwsCredentialProviderMultiError) AllErrors 

func (m AwsCredentialProviderMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (AwsCredentialProviderMultiError) Error 

func (m AwsCredentialProviderMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type AwsCredentialProviderValidationError 

type AwsCredentialProviderValidationError struct {
	// contains filtered or unexported fields
}

AwsCredentialProviderValidationError is the validation error returned by AwsCredentialProvider.Validate if the designated constraints aren't met.

func (AwsCredentialProviderValidationError) Cause 

func (e AwsCredentialProviderValidationError) Cause() error

Cause function returns cause value.

func (AwsCredentialProviderValidationError) Error 

func (e AwsCredentialProviderValidationError) Error() string

Error satisfies the builtin error interface

func (AwsCredentialProviderValidationError) ErrorName 

func (e AwsCredentialProviderValidationError) ErrorName() string

ErrorName returns error name.

func (AwsCredentialProviderValidationError) Field 

func (e AwsCredentialProviderValidationError) Field() string

Field function returns field value.

func (AwsCredentialProviderValidationError) Key 

func (e AwsCredentialProviderValidationError) Key() bool

Key function returns key value.

func (AwsCredentialProviderValidationError) Reason 

func (e AwsCredentialProviderValidationError) Reason() string

Reason function returns reason value.

type CredentialsFileCredentialProvider 

type CredentialsFileCredentialProvider struct {

	// Data source from which to retrieve AWS credentials
	// When using this data source, if a “watched_directory“ is provided, the credential file will be re-read when a file move is detected.
	// See :ref:`watched_directory <envoy_v3_api_msg_config.core.v3.DataSource>` for more information about the “watched_directory“ field.
	CredentialsDataSource *v3.DataSource `` /* 126-byte string literal not displayed */
	// The profile within the credentials_file data source. If not provided, the default profile will be used.
	Profile string `protobuf:"bytes,2,opt,name=profile,proto3" json:"profile,omitempty"`
	// contains filtered or unexported fields
}

func (*CredentialsFileCredentialProvider) Descriptor deprecated 

func (*CredentialsFileCredentialProvider) Descriptor() ([]byte, []int)

Deprecated: Use CredentialsFileCredentialProvider.ProtoReflect.Descriptor instead.

func (*CredentialsFileCredentialProvider) GetCredentialsDataSource 

func (x *CredentialsFileCredentialProvider) GetCredentialsDataSource() *v3.DataSource

func (*CredentialsFileCredentialProvider) GetProfile 

func (x *CredentialsFileCredentialProvider) GetProfile() string

func (*CredentialsFileCredentialProvider) ProtoMessage 

func (*CredentialsFileCredentialProvider) ProtoMessage()

func (*CredentialsFileCredentialProvider) ProtoReflect 

func (x *CredentialsFileCredentialProvider) ProtoReflect() protoreflect.Message

func (*CredentialsFileCredentialProvider) Reset 

func (x *CredentialsFileCredentialProvider) Reset()

func (*CredentialsFileCredentialProvider) String 

func (x *CredentialsFileCredentialProvider) String() string

func (*CredentialsFileCredentialProvider) Validate 

func (m *CredentialsFileCredentialProvider) Validate() error

Validate checks the field values on CredentialsFileCredentialProvider 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 (*CredentialsFileCredentialProvider) ValidateAll 

func (m *CredentialsFileCredentialProvider) ValidateAll() error

ValidateAll checks the field values on CredentialsFileCredentialProvider 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 CredentialsFileCredentialProviderMultiError, or nil if none found.

type CredentialsFileCredentialProviderMultiError 

type CredentialsFileCredentialProviderMultiError []error

CredentialsFileCredentialProviderMultiError is an error wrapping multiple validation errors returned by CredentialsFileCredentialProvider.ValidateAll() if the designated constraints aren't met.

func (CredentialsFileCredentialProviderMultiError) AllErrors 

func (m CredentialsFileCredentialProviderMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (CredentialsFileCredentialProviderMultiError) Error 

func (m CredentialsFileCredentialProviderMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type CredentialsFileCredentialProviderValidationError 

type CredentialsFileCredentialProviderValidationError struct {
	// contains filtered or unexported fields
}

CredentialsFileCredentialProviderValidationError is the validation error returned by CredentialsFileCredentialProvider.Validate if the designated constraints aren't met.

func (CredentialsFileCredentialProviderValidationError) Cause 

func (e CredentialsFileCredentialProviderValidationError) Cause() error

Cause function returns cause value.

func (CredentialsFileCredentialProviderValidationError) Error 

func (e CredentialsFileCredentialProviderValidationError) Error() string

Error satisfies the builtin error interface

func (CredentialsFileCredentialProviderValidationError) ErrorName 

func (e CredentialsFileCredentialProviderValidationError) ErrorName() string

ErrorName returns error name.

func (CredentialsFileCredentialProviderValidationError) Field 

func (e CredentialsFileCredentialProviderValidationError) Field() string

Field function returns field value.

func (CredentialsFileCredentialProviderValidationError) Key 

func (e CredentialsFileCredentialProviderValidationError) Key() bool

Key function returns key value.

func (CredentialsFileCredentialProviderValidationError) Reason 

func (e CredentialsFileCredentialProviderValidationError) Reason() string

Reason function returns reason value.

type InlineCredentialProvider 

type InlineCredentialProvider struct {

	// The AWS access key ID.
	AccessKeyId string `protobuf:"bytes,1,opt,name=access_key_id,json=accessKeyId,proto3" json:"access_key_id,omitempty"`
	// The AWS secret access key.
	SecretAccessKey string `protobuf:"bytes,2,opt,name=secret_access_key,json=secretAccessKey,proto3" json:"secret_access_key,omitempty"`
	// The AWS session token. This is optional.
	SessionToken string `protobuf:"bytes,3,opt,name=session_token,json=sessionToken,proto3" json:"session_token,omitempty"`
	// contains filtered or unexported fields
}

Configuration to use an inline AWS credential. This is an equivalent to setting the well-known environment variables “AWS_ACCESS_KEY_ID“, “AWS_SECRET_ACCESS_KEY“, and the optional “AWS_SESSION_TOKEN“.

func (*InlineCredentialProvider) Descriptor deprecated 

func (*InlineCredentialProvider) Descriptor() ([]byte, []int)

Deprecated: Use InlineCredentialProvider.ProtoReflect.Descriptor instead.

func (*InlineCredentialProvider) GetAccessKeyId 

func (x *InlineCredentialProvider) GetAccessKeyId() string

func (*InlineCredentialProvider) GetSecretAccessKey 

func (x *InlineCredentialProvider) GetSecretAccessKey() string

func (*InlineCredentialProvider) GetSessionToken 

func (x *InlineCredentialProvider) GetSessionToken() string

func (*InlineCredentialProvider) ProtoMessage 

func (*InlineCredentialProvider) ProtoMessage()

func (*InlineCredentialProvider) ProtoReflect 

func (x *InlineCredentialProvider) ProtoReflect() protoreflect.Message

func (*InlineCredentialProvider) Reset 

func (x *InlineCredentialProvider) Reset()

func (*InlineCredentialProvider) String 

func (x *InlineCredentialProvider) String() string

func (*InlineCredentialProvider) Validate 

func (m *InlineCredentialProvider) Validate() error

Validate checks the field values on InlineCredentialProvider 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 (*InlineCredentialProvider) ValidateAll 

func (m *InlineCredentialProvider) ValidateAll() error

ValidateAll checks the field values on InlineCredentialProvider 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 InlineCredentialProviderMultiError, or nil if none found.

type InlineCredentialProviderMultiError 

type InlineCredentialProviderMultiError []error

InlineCredentialProviderMultiError is an error wrapping multiple validation errors returned by InlineCredentialProvider.ValidateAll() if the designated constraints aren't met.

func (InlineCredentialProviderMultiError) AllErrors 

func (m InlineCredentialProviderMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (InlineCredentialProviderMultiError) Error 

func (m InlineCredentialProviderMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type InlineCredentialProviderValidationError 

type InlineCredentialProviderValidationError struct {
	// contains filtered or unexported fields
}

InlineCredentialProviderValidationError is the validation error returned by InlineCredentialProvider.Validate if the designated constraints aren't met.

func (InlineCredentialProviderValidationError) Cause 

func (e InlineCredentialProviderValidationError) Cause() error

Cause function returns cause value.

func (InlineCredentialProviderValidationError) Error 

func (e InlineCredentialProviderValidationError) Error() string

Error satisfies the builtin error interface

func (InlineCredentialProviderValidationError) ErrorName 

func (e InlineCredentialProviderValidationError) ErrorName() string

ErrorName returns error name.

func (InlineCredentialProviderValidationError) Field 

func (e InlineCredentialProviderValidationError) Field() string

Field function returns field value.

func (InlineCredentialProviderValidationError) Key 

func (e InlineCredentialProviderValidationError) Key() bool

Key function returns key value.

func (InlineCredentialProviderValidationError) Reason 

func (e InlineCredentialProviderValidationError) Reason() string

Reason function returns reason value.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.