Package: defaults

import "../ibm-cos-sdk-go-v2/aws/defaults"

Overview

Package defaults provides recommended configuration values for AWS SDKs and CLIs.

Type Summary collapse

Function Summary collapse

Function Details

func GetModeConfiguration(mode aws.DefaultsMode) (Configuration, error)

GetModeConfiguration returns the default Configuration descriptor for the given mode.

Supports the following modes: cross-region, in-region, mobile, standard



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
// File 'aws/defaults/defaults.go', line 13


func GetModeConfiguration(mode aws.DefaultsMode) (Configuration, error) {
	var mv aws.DefaultsMode
	mv.SetFromString(string(mode))

	switch mv {
	case aws.DefaultsModeCrossRegion:
		settings := Configuration{
			ConnectTimeout:        aws.Duration(3100 * time.Millisecond),
			RetryMode:             aws.RetryMode("standard"),
			TLSNegotiationTimeout: aws.Duration(3100 * time.Millisecond),
		}
		return settings, nil
	case aws.DefaultsModeInRegion:
		settings := Configuration{
			ConnectTimeout:        aws.Duration(1100 * time.Millisecond),
			RetryMode:             aws.RetryMode("standard"),
			TLSNegotiationTimeout: aws.Duration(1100 * time.Millisecond),
		}
		return settings, nil
	case aws.DefaultsModeMobile:
		settings := Configuration{
			ConnectTimeout:        aws.Duration(30000 * time.Millisecond),
			RetryMode:             aws.RetryMode("standard"),
			TLSNegotiationTimeout: aws.Duration(30000 * time.Millisecond),
		}
		return settings, nil
	case aws.DefaultsModeStandard:
		settings := Configuration{
			ConnectTimeout:        aws.Duration(3100 * time.Millisecond),
			RetryMode:             aws.RetryMode("standard"),
			TLSNegotiationTimeout: aws.Duration(3100 * time.Millisecond),
		}
		return settings, nil
	default:
		return Configuration{}, fmt.Errorf("unsupported defaults mode: %v", mode)
	}
}

func ResolveDefaultsModeAuto(region string, environment aws.RuntimeEnvironment) aws.DefaultsMode

ResolveDefaultsModeAuto is used to determine the effective aws.DefaultsMode when the mode is set to aws.DefaultsModeAuto.



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
 
// File 'aws/defaults/auto.go', line 14


func ResolveDefaultsModeAuto(region string, environment aws.RuntimeEnvironment) aws.DefaultsMode {
	goos := getGOOS()
	if goos == "android" || goos == "ios" {
		return aws.DefaultsModeMobile
	}

	var currentRegion string
	if len(environment.EnvironmentIdentifier) > 0 {
		currentRegion = environment.Region
	}

	if len(currentRegion) == 0 && len(environment.EC2InstanceMetadataRegion) > 0 {
		currentRegion = environment.EC2InstanceMetadataRegion
	}

	if len(region) > 0 && len(currentRegion) > 0 {
		if strings.EqualFold(region, currentRegion) {
			return aws.DefaultsModeInRegion
		}
		return aws.DefaultsModeCrossRegion
	}

	return aws.DefaultsModeStandard
}