identity

Documentation

Index

• type IAgentIdentity
• type IAgentIdentityInner
• type ICredentialRefresherAgentIdentity
• type ICredentialRefresherProvider
• type IInnerIdentityGetter
• type IMetadataIdentity
• type Registrar

Types

type IAgentIdentity

type IAgentIdentity interface {
	InstanceID() (string, error)
	ShortInstanceID() (string, error)
	Region() (string, error)
	AvailabilityZone() (string, error)
	AvailabilityZoneId() (string, error)
	InstanceType() (string, error)
	Credentials() *credentials.Credentials
	IdentityType() string
	GetServiceEndpoint(string) string
}

IAgentIdentity defines the interface identity cacher exposes

type IAgentIdentityInner

type IAgentIdentityInner interface {
	InstanceID() (string, error)
	Region() (string, error)
	AvailabilityZone() (string, error)
	AvailabilityZoneId() (string, error)
	InstanceType() (string, error)
	IsIdentityEnvironment() bool
	Credentials() *credentials.Credentials
	IdentityType() string
}

IAgentIdentityInner defines the interface each identity needs to expose

type ICredentialRefresherAgentIdentity

type ICredentialRefresherAgentIdentity interface {
	CredentialProvider() credentialproviders.IRemoteProvider
}

ICredentialRefresherAgentIdentity defines the interface for identities that require custom credential refresh (e.g. onprem, ec2)

type ICredentialRefresherProvider

type ICredentialRefresherProvider interface {
	ShareProfile() string
	ShareFile() string
	SharesCredentials() bool
}

ICredentialRefresherProvider defines the interface for credential providers that require custom credential refresh

type IInnerIdentityGetter

type IInnerIdentityGetter interface {
	GetInner() IAgentIdentityInner
}

type IMetadataIdentity

type IMetadataIdentity interface {
	VpcPrimaryCIDRBlock() (map[string][]string, error)
}

IMetadataIdentity defines the interface for identities that will query metadata for VPC CIDR block information (ec2, ecs)

type Registrar

type Registrar interface {
	Register(context.Context) error
}

Registrar identity registers the agent on startup