cloud

Documentation

Index

• Constants
• Variables
• func AwsNewSession(option Option) (*session.Session, *aws.Config, error)
• func AwsNewSessionWithOption(option AWSOption) (*session.Session, *aws.Config, error)
• type AWSOption
  • func (option AWSOption) Check() error
• type AliCloudCredentialType
• type CommonCloudOption
• type CommonOption
  • func (option CommonOption) CheckAWS() error
  • func (option CommonOption) CheckAliCloudStorage() error
  • func (option CommonOption) CheckClusterRedis() error
  • func (option CommonOption) CheckStandaloneRedis() error
  • func (option CommonOption) CheckTencentCloud() error
  • func (option CommonOption) GetAssumeRegion() string
  • func (option CommonOption) GetAssumeRoleArn() string
  • func (option CommonOption) GetProvider() Provider
  • func (option CommonOption) GetRegion() string
  • func (option CommonOption) GetSecretID() string
  • func (option CommonOption) GetSecretKey() string
• type Option
• type Provider

Constants

const (
	AliCloudEnvAccessKeyID     = "ALIBABA_CLOUD_ACCESS_KEY_ID"
	AliCloudEnvAccessKeySecret = "ALIBABA_CLOUD_ACCESS_KEY_SECRET"
	AliCloudEnvRoleArn         = "ALIBABA_CLOUD_ROLE_ARN"
	AliCloudEnvOIDCProviderArn = "ALIBABA_CLOUD_OIDC_PROVIDER_ARN"
	AliCloudEnvOIDCTokenFile   = "ALIBABA_CLOUD_OIDC_TOKEN_FILE"
	AliCloudEnvRoleSessionName = "ALIBABA_CLOUD_ROLE_SESSION_NAME"
)

Variables

var (
	ErrUnsupportedCloudProvider   = errors.New("unsupported provider")
	ErrProviderNotTencentCloud    = errors.New("provider is not tencentcloud")
	ErrProviderNotAWS             = errors.New("provider is not aws")
	ErrProviderNotStandaloneRedis = errors.New("provider is not standalone redis")
	ErrProviderNotClusterRedis    = errors.New("provider is not cluster redis")
	ErrProviderNotAliCloudStorage = errors.New("provider is not aliyun oss")
	ErrEmptySecretID              = errors.New("secret_id is empty")
	ErrEmptySecretKey             = errors.New("secret_key is empty")
	ErrEmptyRegion                = errors.New("region is empty")
)

Functions

func AwsNewSession

func AwsNewSession(option Option) (*session.Session, *aws.Config, error)

AwsNewSession

func AwsNewSessionWithOption

func AwsNewSessionWithOption(option AWSOption) (*session.Session, *aws.Config, error)

Types

type AWSOption

type AWSOption CommonCloudOption

func (AWSOption) Check

func (option AWSOption) Check() error

type AliCloudCredentialType

type AliCloudCredentialType string

const (
	AliCloudAccessKeyCredentialType   AliCloudCredentialType = "access_key"
	AliCloudECSRamRoleCredentialType  AliCloudCredentialType = "ecs_ram_role"
	AliCloudOIDCRoleARNCredentialType AliCloudCredentialType = "oidc_role_arn"
)

type CommonCloudOption

type CommonCloudOption struct {
	SecretID      string `json:"secret_id" yaml:"secret_id"`
	SecretKey     string `json:"secret_key" yaml:"secret_key"`
	AssumeRoleArn string `json:"assume_role_arn" yaml:"assume_role_arn"`
	Region        string `json:"region" yaml:"region"`
	AssumeRegion  string `json:"assume_region" yaml:"assume_region"`
}

type CommonOption

type CommonOption struct {
	Provider      Provider `json:"provider" yaml:"provider"`
	SecretID      string   `json:"secret_id" yaml:"secret_id"`
	SecretKey     string   `json:"secret_key" yaml:"secret_key"`
	AssumeRoleArn string   `json:"assume_role_arn" yaml:"assume_role_arn"`
	Region        string   `json:"region" yaml:"region"`
	AssumeRegion  string   `json:"assume_region" yaml:"assume_region"`
}

func (CommonOption) CheckAWS

func (option CommonOption) CheckAWS() error

func (CommonOption) CheckAliCloudStorage

func (option CommonOption) CheckAliCloudStorage() error

func (CommonOption) CheckClusterRedis

func (option CommonOption) CheckClusterRedis() error

func (CommonOption) CheckStandaloneRedis

func (option CommonOption) CheckStandaloneRedis() error

func (CommonOption) CheckTencentCloud

func (option CommonOption) CheckTencentCloud() error

func (CommonOption) GetAssumeRegion

func (option CommonOption) GetAssumeRegion() string

GetAssumeRegion 多数情况 region 和 assume region 是同一个region,全球区可能出现不一致的场景

func (CommonOption) GetAssumeRoleArn

func (option CommonOption) GetAssumeRoleArn() string

func (CommonOption) GetProvider

func (option CommonOption) GetProvider() Provider

func (CommonOption) GetRegion

func (option CommonOption) GetRegion() string

func (CommonOption) GetSecretID

func (option CommonOption) GetSecretID() string

func (CommonOption) GetSecretKey

func (option CommonOption) GetSecretKey() string

type Option

type Option interface {
	GetProvider() Provider
	GetSecretID() string
	GetSecretKey() string
	GetAssumeRoleArn() string
	GetRegion() string
	GetAssumeRegion() string
	CheckAWS() error
	CheckTencentCloud() error
	CheckStandaloneRedis() error
	CheckClusterRedis() error
	CheckAliCloudStorage() error
}

type Provider

type Provider string

const (
	AWSProvider          Provider = "aws"
	TencentCloudProvider Provider = "tencentcloud"
	AliCloudProvider     Provider = "alicloud"

	StandaloneRedisProvider   Provider = "standalone_redis"
	ClusterRedisProvider      Provider = "cluster_redis"
	StandaloneRedisProviderV7 Provider = "standalone_redis_v7"
	ClusterRedisProviderV7    Provider = "cluster_redis_v7"

	// AliCloudStorageProvider is deprecated, use AliCloudProvider instead.
	AliCloudStorageProvider Provider = "alicloud_storage"
)