aws_helper

Documentation

Index

• func AssumeIamRole(iamRoleArn string) (*sts.Credentials, error)
• func CreateAwsSession(config *AwsSessionConfig, terragruntOptions *options.TerragruntOptions) (*session.Session, error)
• func GetAWSAccountID(terragruntOptions *options.TerragruntOptions) (string, error)
• func GetAWSCallerIdentity(terragruntOptions *options.TerragruntOptions) (sts.GetCallerIdentityOutput, error)
• func GetAWSIdentityArn(terragruntOptions *options.TerragruntOptions) (string, error)
• func GetAWSUserID(terragruntOptions *options.TerragruntOptions) (string, error)
• type AwsSessionConfig

Functions

func AssumeIamRole

func AssumeIamRole(iamRoleArn string) (*sts.Credentials, error)

Make API calls to AWS to assume the IAM role specified and return the temporary AWS credentials to use that role

func CreateAwsSession

func CreateAwsSession(config *AwsSessionConfig, terragruntOptions *options.TerragruntOptions) (*session.Session, error)

Returns an AWS session object for the given config region (required), profile name (optional), and IAM role to assume (optional), ensuring that the credentials are available

func GetAWSAccountID

func GetAWSAccountID(terragruntOptions *options.TerragruntOptions) (string, error)

Get the AWS account ID of the current session configuration

func GetAWSCallerIdentity

func GetAWSCallerIdentity(terragruntOptions *options.TerragruntOptions) (sts.GetCallerIdentityOutput, error)

Return the AWS caller identity associated with the current set of credentials

func GetAWSIdentityArn

func GetAWSIdentityArn(terragruntOptions *options.TerragruntOptions) (string, error)

Get the ARN of the AWS identity associated with the current set of credentials

func GetAWSUserID

func GetAWSUserID(terragruntOptions *options.TerragruntOptions) (string, error)

Get the AWS user ID of the current session configuration

Types

type AwsSessionConfig

type AwsSessionConfig struct {
	Region                  string
	CustomS3Endpoint        string
	Profile                 string
	RoleArn                 string
	CredsFilename           string
	S3ForcePathStyle        bool
	DisableComputeChecksums bool
	ExternalID              string
	SessionName             string
}

A representation of the configuration options for an AWS Session