util

Documentation

Index

• Constants
• Variables
• func ConvertAutoScalingTagsToMap(tags []autoscaling.TagDescription) map[string]string
• func ConvertEC2TagsToMap(tags []*ec2.Tag) map[string]string
• func ConvertIAMTagsToMap(tags []iam.Tag) map[string]string
• func ConvertNetworkFirewallTagsToMap(tags []networkfirewalltypes.Tag) map[string]string
• func ConvertRDSTypeTagsToMap(tags []rdstypes.Tag) map[string]string
• func ConvertS3TypesTagsToMap(tags []s3types.Tag) map[string]string
• func ConvertStringPtrTagsToMap(tags map[string]*string) map[string]string
• func ConvertTypesTagsToMap(tags []types.Tag) map[string]string
• func Difference(a, b []*string) []*string
• func FormatTimestamp(timestamp time.Time) string
• func GetBoolFromContext(ctx context.Context, key string) (bool, error)
• func GetCurrentAccountId(session *session.Session) (string, error)
• func GetEC2ResourceNameTagValue[T *ec2.Tag | types.Tag](tags []T) *string
• func GetOrCreateFirstSeen(ctx context.Context, client interface{}, identifier *string, ...) (*time.Time, error)
• func IsFirstSeenTag(key *string) bool
• func ParseTimestamp(timestamp *string) (*time.Time, error)
• func RemoveNewlines(s string) string
• func Split(identifiers []string, limit int) [][]string
• func TransformAWSError(err error) error
• func Truncate(s string, maxLen int) string
• func UniqueID() string
• type ResourceExecutionTimeout
  • func (err ResourceExecutionTimeout) Error() string

Constants

const AWSAccessDeniedException string = "AccessDeniedException"

const AWsUnauthorizedError string = "UnauthorizedOperation"

const (
	AccountIdKey = "accountId"
)

const AwsDryRunSuccess string = "Request would have succeeded, but DryRun flag is set."

const (
	ExcludeFirstSeenTagKey = "exclude-first-seen-tag"
)

const (
	// FirstSeenTagKey A tag used to set custom AWS Tags to resources that do not support `created at` timestamp> - EIP & ECS Clusters.
	// This is used in relation to the `--older-than <duration>` filtering that `cloud-nuke` allows.
	// Due to its destructive nature, `cloud-nuke` has been configured not to delete AWS resources without known creation time,
	// and instead tag them with the `firstSeenTagKey`.
	// The next time `cloud-nuke aws --older-than <duration>` is run, it will use the tag to determine if the AWS resource should be deleted or not.
	FirstSeenTagKey = "cloud-nuke-first-seen"
)

Variables

var ErrContextExecutionTimeout = errors.New("error:EXECUTION_TIMEOUT")

var ErrDeleteProtectionEnabled = errors.New("error:DeleteProtectionEnabled")

var ErrDifferentOwner = errors.New("error:DIFFERENT_OWNER")

var ErrInSufficientPermission = errors.New("error:INSUFFICIENT_PERMISSION")

var ErrInterfaceIDNotFound = errors.New("error:InterfaceIdNotFound")

var ErrInvalidPermisionNotFound = errors.New("error:InvalidPermission.NotFound")

var ErrResourceNotFoundException = errors.New("error:ErrResourceNotFoundException")

Functions

func ConvertAutoScalingTagsToMap

func ConvertAutoScalingTagsToMap(tags []autoscaling.TagDescription) map[string]string

func ConvertEC2TagsToMap

func ConvertEC2TagsToMap(tags []*ec2.Tag) map[string]string

func ConvertIAMTagsToMap

func ConvertIAMTagsToMap(tags []iam.Tag) map[string]string

func ConvertNetworkFirewallTagsToMap

func ConvertNetworkFirewallTagsToMap(tags []networkfirewalltypes.Tag) map[string]string

func ConvertRDSTypeTagsToMap

func ConvertRDSTypeTagsToMap(tags []rdstypes.Tag) map[string]string

func ConvertS3TypesTagsToMap

func ConvertS3TypesTagsToMap(tags []s3types.Tag) map[string]string

func ConvertStringPtrTagsToMap

func ConvertStringPtrTagsToMap(tags map[string]*string) map[string]string

func ConvertTypesTagsToMap

func ConvertTypesTagsToMap(tags []types.Tag) map[string]string

func Difference

func Difference(a, b []*string) []*string

Difference returns the elements in `a` that aren't in `b`.

func FormatTimestamp

func FormatTimestamp(timestamp time.Time) string

func GetBoolFromContext

func GetBoolFromContext(ctx context.Context, key string) (bool, error)

func GetCurrentAccountId

func GetCurrentAccountId(session *session.Session) (string, error)

func GetEC2ResourceNameTagValue

func GetEC2ResourceNameTagValue[T *ec2.Tag | types.Tag](tags []T) *string

func GetOrCreateFirstSeen

func GetOrCreateFirstSeen(ctx context.Context, client interface{}, identifier *string, tags map[string]string) (*time.Time, error)

func IsFirstSeenTag

func IsFirstSeenTag(key *string) bool

func ParseTimestamp

func ParseTimestamp(timestamp *string) (*time.Time, error)

func RemoveNewlines

func RemoveNewlines(s string) string

RemoveNewlines will delete all the newlines in a given string, which is useful for making error messages "sit" more nicely within their specified table cells in the terminal

func Split

func Split(identifiers []string, limit int) [][]string

func TransformAWSError

func TransformAWSError(err error) error

TransformAWSError this function is used to handle AWS errors and mapping them to a custom error message This could be part of a larger error-handling strategy that interacts with AWS services, providing a more human-readable error message for certain conditions ref : https://docs.aws.amazon.com/AWSEC2/latest/APIReference/errors-overview.html

func Truncate

func Truncate(s string, maxLen int) string

Truncate accepts a string and a max length. If the max length is less than the string's current length, then only the first maxLen characters of the string are returned

func UniqueID

func UniqueID() string

Returns a unique (ish) id we can attach to resources and tfstate files so they don't conflict with each other Uses base 62 to generate a 6 character string that's unlikely to collide with the handful of tests we run in parallel. Based on code here: http://stackoverflow.com/a/9543797/483528

Types

type ResourceExecutionTimeout

type ResourceExecutionTimeout struct {
	Timeout time.Duration
}

func (ResourceExecutionTimeout) Error

func (err ResourceExecutionTimeout) Error() string