Documentation ¶
Index ¶
- Variables
- type AWSAccount
- func (*AWSAccount) Descriptor() ([]byte, []int)deprecated
- func (x *AWSAccount) GetAccountNumber() string
- func (x *AWSAccount) GetAlias() string
- func (x *AWSAccount) GetIamRole() string
- func (x *AWSAccount) GetRegions() []string
- func (*AWSAccount) ProtoMessage()
- func (x *AWSAccount) ProtoReflect() protoreflect.Message
- func (x *AWSAccount) Reset()
- func (x *AWSAccount) String() string
- func (m *AWSAccount) Validate() error
- func (m *AWSAccount) ValidateAll() error
- type AWSAccountMultiError
- type AWSAccountValidationError
- type ClientConfig
- func (*ClientConfig) Descriptor() ([]byte, []int)deprecated
- func (x *ClientConfig) GetRetries() int32
- func (*ClientConfig) ProtoMessage()
- func (x *ClientConfig) ProtoReflect() protoreflect.Message
- func (x *ClientConfig) Reset()
- func (x *ClientConfig) String() string
- func (m *ClientConfig) Validate() error
- func (m *ClientConfig) ValidateAll() error
- type ClientConfigMultiError
- type ClientConfigValidationError
- func (e ClientConfigValidationError) Cause() error
- func (e ClientConfigValidationError) Error() string
- func (e ClientConfigValidationError) ErrorName() string
- func (e ClientConfigValidationError) Field() string
- func (e ClientConfigValidationError) Key() bool
- func (e ClientConfigValidationError) Reason() string
- type Config
- func (*Config) Descriptor() ([]byte, []int)deprecated
- func (x *Config) GetAdditionalAccounts() []*AWSAccount
- func (x *Config) GetAwsConfigProfileName() string
- func (x *Config) GetClientConfig() *ClientConfig
- func (x *Config) GetPrimaryAccountAliasDisplayName() string
- func (x *Config) GetRegions() []string
- func (*Config) ProtoMessage()
- func (x *Config) ProtoReflect() protoreflect.Message
- func (x *Config) Reset()
- func (x *Config) String() string
- func (m *Config) Validate() error
- func (m *Config) ValidateAll() error
- type ConfigMultiError
- type ConfigValidationError
Constants ¶
This section is empty.
Variables ¶
var File_config_service_aws_v1_aws_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type AWSAccount ¶
type AWSAccount struct { // The account alias for this account Alias string `protobuf:"bytes,1,opt,name=alias,proto3" json:"alias,omitempty"` // The account number for the aws account AccountNumber string `protobuf:"bytes,2,opt,name=account_number,json=accountNumber,proto3" json:"account_number,omitempty"` // The IAM role to use when performing operations against this account // NOTE: The role that Clutch assumes by default must have proper permissions // to assume the role below IamRole string `protobuf:"bytes,3,opt,name=iam_role,json=iamRole,proto3" json:"iam_role,omitempty"` // The list of regions you would like to operate in Regions []string `protobuf:"bytes,4,rep,name=regions,proto3" json:"regions,omitempty"` // contains filtered or unexported fields }
func (*AWSAccount) Descriptor
deprecated
func (*AWSAccount) Descriptor() ([]byte, []int)
Deprecated: Use AWSAccount.ProtoReflect.Descriptor instead.
func (*AWSAccount) GetAccountNumber ¶
func (x *AWSAccount) GetAccountNumber() string
func (*AWSAccount) GetAlias ¶
func (x *AWSAccount) GetAlias() string
func (*AWSAccount) GetIamRole ¶
func (x *AWSAccount) GetIamRole() string
func (*AWSAccount) GetRegions ¶
func (x *AWSAccount) GetRegions() []string
func (*AWSAccount) ProtoMessage ¶
func (*AWSAccount) ProtoMessage()
func (*AWSAccount) ProtoReflect ¶
func (x *AWSAccount) ProtoReflect() protoreflect.Message
func (*AWSAccount) Reset ¶
func (x *AWSAccount) Reset()
func (*AWSAccount) String ¶
func (x *AWSAccount) String() string
func (*AWSAccount) Validate ¶
func (m *AWSAccount) Validate() error
Validate checks the field values on AWSAccount 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 (*AWSAccount) ValidateAll ¶
func (m *AWSAccount) ValidateAll() error
ValidateAll checks the field values on AWSAccount 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 AWSAccountMultiError, or nil if none found.
type AWSAccountMultiError ¶
type AWSAccountMultiError []error
AWSAccountMultiError is an error wrapping multiple validation errors returned by AWSAccount.ValidateAll() if the designated constraints aren't met.
func (AWSAccountMultiError) AllErrors ¶
func (m AWSAccountMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (AWSAccountMultiError) Error ¶
func (m AWSAccountMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type AWSAccountValidationError ¶
type AWSAccountValidationError struct {
// contains filtered or unexported fields
}
AWSAccountValidationError is the validation error returned by AWSAccount.Validate if the designated constraints aren't met.
func (AWSAccountValidationError) Cause ¶
func (e AWSAccountValidationError) Cause() error
Cause function returns cause value.
func (AWSAccountValidationError) Error ¶
func (e AWSAccountValidationError) Error() string
Error satisfies the builtin error interface
func (AWSAccountValidationError) ErrorName ¶
func (e AWSAccountValidationError) ErrorName() string
ErrorName returns error name.
func (AWSAccountValidationError) Field ¶
func (e AWSAccountValidationError) Field() string
Field function returns field value.
func (AWSAccountValidationError) Key ¶
func (e AWSAccountValidationError) Key() bool
Key function returns key value.
func (AWSAccountValidationError) Reason ¶
func (e AWSAccountValidationError) Reason() string
Reason function returns reason value.
type ClientConfig ¶
type ClientConfig struct { // If not set explicity, retries default to 0 Retries int32 `protobuf:"varint,1,opt,name=retries,proto3" json:"retries,omitempty"` // contains filtered or unexported fields }
func (*ClientConfig) Descriptor
deprecated
func (*ClientConfig) Descriptor() ([]byte, []int)
Deprecated: Use ClientConfig.ProtoReflect.Descriptor instead.
func (*ClientConfig) GetRetries ¶
func (x *ClientConfig) GetRetries() int32
func (*ClientConfig) ProtoMessage ¶
func (*ClientConfig) ProtoMessage()
func (*ClientConfig) ProtoReflect ¶
func (x *ClientConfig) ProtoReflect() protoreflect.Message
func (*ClientConfig) Reset ¶
func (x *ClientConfig) Reset()
func (*ClientConfig) String ¶
func (x *ClientConfig) String() string
func (*ClientConfig) Validate ¶
func (m *ClientConfig) Validate() error
Validate checks the field values on ClientConfig 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 (*ClientConfig) ValidateAll ¶
func (m *ClientConfig) ValidateAll() error
ValidateAll checks the field values on ClientConfig 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 ClientConfigMultiError, or nil if none found.
type ClientConfigMultiError ¶
type ClientConfigMultiError []error
ClientConfigMultiError is an error wrapping multiple validation errors returned by ClientConfig.ValidateAll() if the designated constraints aren't met.
func (ClientConfigMultiError) AllErrors ¶
func (m ClientConfigMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (ClientConfigMultiError) Error ¶
func (m ClientConfigMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type ClientConfigValidationError ¶
type ClientConfigValidationError struct {
// contains filtered or unexported fields
}
ClientConfigValidationError is the validation error returned by ClientConfig.Validate if the designated constraints aren't met.
func (ClientConfigValidationError) Cause ¶
func (e ClientConfigValidationError) Cause() error
Cause function returns cause value.
func (ClientConfigValidationError) Error ¶
func (e ClientConfigValidationError) Error() string
Error satisfies the builtin error interface
func (ClientConfigValidationError) ErrorName ¶
func (e ClientConfigValidationError) ErrorName() string
ErrorName returns error name.
func (ClientConfigValidationError) Field ¶
func (e ClientConfigValidationError) Field() string
Field function returns field value.
func (ClientConfigValidationError) Key ¶
func (e ClientConfigValidationError) Key() bool
Key function returns key value.
func (ClientConfigValidationError) Reason ¶
func (e ClientConfigValidationError) Reason() string
Reason function returns reason value.
type Config ¶
type Config struct { Regions []string `protobuf:"bytes,1,rep,name=regions,proto3" json:"regions,omitempty"` ClientConfig *ClientConfig `protobuf:"bytes,2,opt,name=client_config,json=clientConfig,proto3" json:"client_config,omitempty"` // The current account alias display name, if this is not set the default will be "default" // The account alias display name will be used when resolving resources. // EG: if this is set to "production" a resource would be referenced like so // "production/us-east-1/my-asg" PrimaryAccountAliasDisplayName string `` /* 157-byte string literal not displayed */ // If you are using an aws configuration file, this overrides the default profile that is loaded. // TODO: This is currently not implemented, but was created to prevent confusion between // primary_account_alias_display_name AwsConfigProfileName string `protobuf:"bytes,5,opt,name=aws_config_profile_name,json=awsConfigProfileName,proto3" json:"aws_config_profile_name,omitempty"` // A list of additional accounts you would like clutch to be able to operate in AdditionalAccounts []*AWSAccount `protobuf:"bytes,6,rep,name=additional_accounts,json=additionalAccounts,proto3" json:"additional_accounts,omitempty"` // contains filtered or unexported fields }
func (*Config) Descriptor
deprecated
func (*Config) GetAdditionalAccounts ¶
func (x *Config) GetAdditionalAccounts() []*AWSAccount
func (*Config) GetAwsConfigProfileName ¶
func (*Config) GetClientConfig ¶
func (x *Config) GetClientConfig() *ClientConfig
func (*Config) GetPrimaryAccountAliasDisplayName ¶
func (*Config) GetRegions ¶
func (*Config) ProtoMessage ¶
func (*Config) ProtoMessage()
func (*Config) ProtoReflect ¶
func (x *Config) ProtoReflect() protoreflect.Message
func (*Config) Validate ¶
Validate checks the field values on Config 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 (*Config) ValidateAll ¶
ValidateAll checks the field values on Config 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 ConfigMultiError, or nil if none found.
type ConfigMultiError ¶
type ConfigMultiError []error
ConfigMultiError is an error wrapping multiple validation errors returned by Config.ValidateAll() if the designated constraints aren't met.
func (ConfigMultiError) AllErrors ¶
func (m ConfigMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (ConfigMultiError) Error ¶
func (m ConfigMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type ConfigValidationError ¶
type ConfigValidationError struct {
// contains filtered or unexported fields
}
ConfigValidationError is the validation error returned by Config.Validate if the designated constraints aren't met.
func (ConfigValidationError) Cause ¶
func (e ConfigValidationError) Cause() error
Cause function returns cause value.
func (ConfigValidationError) Error ¶
func (e ConfigValidationError) Error() string
Error satisfies the builtin error interface
func (ConfigValidationError) ErrorName ¶
func (e ConfigValidationError) ErrorName() string
ErrorName returns error name.
func (ConfigValidationError) Field ¶
func (e ConfigValidationError) Field() string
Field function returns field value.
func (ConfigValidationError) Key ¶
func (e ConfigValidationError) Key() bool
Key function returns key value.
func (ConfigValidationError) Reason ¶
func (e ConfigValidationError) Reason() string
Reason function returns reason value.