github.com/pulumi/pulumi-aws/sdk/v6@v6.32.0/go/aws/config/config.go (about) 1 // Code generated by the Pulumi Terraform Bridge (tfgen) Tool DO NOT EDIT. 2 // *** WARNING: Do not edit by hand unless you're certain you know what you are doing! *** 3 4 package config 5 6 import ( 7 "github.com/pulumi/pulumi-aws/sdk/v6/go/aws/internal" 8 "github.com/pulumi/pulumi/sdk/v3/go/pulumi" 9 "github.com/pulumi/pulumi/sdk/v3/go/pulumi/config" 10 ) 11 12 var _ = internal.GetEnvOrDefault 13 14 // The access key for API operations. You can retrieve this from the 'Security & Credentials' section of the AWS console. 15 func GetAccessKey(ctx *pulumi.Context) string { 16 return config.Get(ctx, "aws:accessKey") 17 } 18 func GetAllowedAccountIds(ctx *pulumi.Context) string { 19 return config.Get(ctx, "aws:allowedAccountIds") 20 } 21 func GetAssumeRole(ctx *pulumi.Context) string { 22 return config.Get(ctx, "aws:assumeRole") 23 } 24 func GetAssumeRoleWithWebIdentity(ctx *pulumi.Context) string { 25 return config.Get(ctx, "aws:assumeRoleWithWebIdentity") 26 } 27 28 // File containing custom root and intermediate certificates. Can also be configured using the `AWS_CA_BUNDLE` environment 29 // variable. (Setting `caBundle` in the shared config file is not supported.) 30 func GetCustomCaBundle(ctx *pulumi.Context) string { 31 return config.Get(ctx, "aws:customCaBundle") 32 } 33 34 // Configuration block with settings to default resource tags across all resources. 35 func GetDefaultTags(ctx *pulumi.Context) string { 36 return config.Get(ctx, "aws:defaultTags") 37 } 38 39 // Address of the EC2 metadata service endpoint to use. Can also be configured using the 40 // `AWS_EC2_METADATA_SERVICE_ENDPOINT` environment variable. 41 func GetEc2MetadataServiceEndpoint(ctx *pulumi.Context) string { 42 return config.Get(ctx, "aws:ec2MetadataServiceEndpoint") 43 } 44 45 // Protocol to use with EC2 metadata service endpoint.Valid values are `IPv4` and `IPv6`. Can also be configured using the 46 // `AWS_EC2_METADATA_SERVICE_ENDPOINT_MODE` environment variable. 47 func GetEc2MetadataServiceEndpointMode(ctx *pulumi.Context) string { 48 return config.Get(ctx, "aws:ec2MetadataServiceEndpointMode") 49 } 50 func GetEndpoints(ctx *pulumi.Context) string { 51 return config.Get(ctx, "aws:endpoints") 52 } 53 func GetForbiddenAccountIds(ctx *pulumi.Context) string { 54 return config.Get(ctx, "aws:forbiddenAccountIds") 55 } 56 57 // URL of a proxy to use for HTTP requests when accessing the AWS API. Can also be set using the `HTTP_PROXY` or 58 // `httpProxy` environment variables. 59 func GetHttpProxy(ctx *pulumi.Context) string { 60 return config.Get(ctx, "aws:httpProxy") 61 } 62 63 // URL of a proxy to use for HTTPS requests when accessing the AWS API. Can also be set using the `HTTPS_PROXY` or 64 // `httpsProxy` environment variables. 65 func GetHttpsProxy(ctx *pulumi.Context) string { 66 return config.Get(ctx, "aws:httpsProxy") 67 } 68 69 // Configuration block with settings to ignore resource tags across all resources. 70 func GetIgnoreTags(ctx *pulumi.Context) string { 71 return config.Get(ctx, "aws:ignoreTags") 72 } 73 74 // Explicitly allow the provider to perform "insecure" SSL requests. If omitted, default value is `false` 75 func GetInsecure(ctx *pulumi.Context) bool { 76 return config.GetBool(ctx, "aws:insecure") 77 } 78 79 // The maximum number of times an AWS API request is being executed. If the API request still fails, an error is thrown. 80 func GetMaxRetries(ctx *pulumi.Context) int { 81 return config.GetInt(ctx, "aws:maxRetries") 82 } 83 84 // Comma-separated list of hosts that should not use HTTP or HTTPS proxies. Can also be set using the `NO_PROXY` or 85 // `noProxy` environment variables. 86 func GetNoProxy(ctx *pulumi.Context) string { 87 return config.Get(ctx, "aws:noProxy") 88 } 89 90 // The profile for API operations. If not set, the default profile created with `aws configure` will be used. 91 func GetProfile(ctx *pulumi.Context) string { 92 return config.Get(ctx, "aws:profile") 93 } 94 95 // The region where AWS operations will take place. Examples are us-east-1, us-west-2, etc. 96 func GetRegion(ctx *pulumi.Context) string { 97 v, err := config.Try(ctx, "aws:region") 98 if err == nil { 99 return v 100 } 101 var value string 102 if d := internal.GetEnvOrDefault(nil, nil, "AWS_REGION", "AWS_DEFAULT_REGION"); d != nil { 103 value = d.(string) 104 } 105 return value 106 } 107 108 // Specifies how retries are attempted. Valid values are `standard` and `adaptive`. Can also be configured using the 109 // `AWS_RETRY_MODE` environment variable. 110 func GetRetryMode(ctx *pulumi.Context) string { 111 return config.Get(ctx, "aws:retryMode") 112 } 113 114 // Specifies whether S3 API calls in the `us-east-1` region use the legacy global endpoint or a regional endpoint. Valid 115 // values are `legacy` or `regional`. Can also be configured using the `AWS_S3_US_EAST_1_REGIONAL_ENDPOINT` environment 116 // variable or the `s3UsEast1RegionalEndpoint` shared config file parameter 117 func GetS3UsEast1RegionalEndpoint(ctx *pulumi.Context) string { 118 return config.Get(ctx, "aws:s3UsEast1RegionalEndpoint") 119 } 120 121 // Set this to true to enable the request to use path-style addressing, i.e., https://s3.amazonaws.com/BUCKET/KEY. By 122 // default, the S3 client will use virtual hosted bucket addressing when possible (https://BUCKET.s3.amazonaws.com/KEY). 123 // Specific to the Amazon S3 service. 124 func GetS3UsePathStyle(ctx *pulumi.Context) bool { 125 return config.GetBool(ctx, "aws:s3UsePathStyle") 126 } 127 128 // The secret key for API operations. You can retrieve this from the 'Security & Credentials' section of the AWS console. 129 func GetSecretKey(ctx *pulumi.Context) string { 130 return config.Get(ctx, "aws:secretKey") 131 } 132 133 // List of paths to shared config files. If not set, defaults to [~/.aws/config]. 134 func GetSharedConfigFiles(ctx *pulumi.Context) string { 135 return config.Get(ctx, "aws:sharedConfigFiles") 136 } 137 138 // List of paths to shared credentials files. If not set, defaults to [~/.aws/credentials]. 139 func GetSharedCredentialsFiles(ctx *pulumi.Context) string { 140 return config.Get(ctx, "aws:sharedCredentialsFiles") 141 } 142 143 // Skip the credentials validation via STS API. Used for AWS API implementations that do not have STS 144 // available/implemented. 145 func GetSkipCredentialsValidation(ctx *pulumi.Context) bool { 146 v, err := config.TryBool(ctx, "aws:skipCredentialsValidation") 147 if err == nil { 148 return v 149 } 150 var value bool 151 value = false 152 return value 153 } 154 155 // Skip the AWS Metadata API check. Used for AWS API implementations that do not have a metadata api endpoint. 156 func GetSkipMetadataApiCheck(ctx *pulumi.Context) bool { 157 v, err := config.TryBool(ctx, "aws:skipMetadataApiCheck") 158 if err == nil { 159 return v 160 } 161 var value bool 162 value = true 163 return value 164 } 165 166 // Skip static validation of region name. Used by users of alternative AWS-like APIs or users w/ access to regions that are 167 // not public (yet). 168 func GetSkipRegionValidation(ctx *pulumi.Context) bool { 169 v, err := config.TryBool(ctx, "aws:skipRegionValidation") 170 if err == nil { 171 return v 172 } 173 var value bool 174 value = true 175 return value 176 } 177 178 // Skip requesting the account ID. Used for AWS API implementations that do not have IAM/STS API and/or metadata API. 179 func GetSkipRequestingAccountId(ctx *pulumi.Context) bool { 180 return config.GetBool(ctx, "aws:skipRequestingAccountId") 181 } 182 183 // The region where AWS STS operations will take place. Examples are us-east-1 and us-west-2. 184 func GetStsRegion(ctx *pulumi.Context) string { 185 return config.Get(ctx, "aws:stsRegion") 186 } 187 188 // session token. A session token is only required if you are using temporary security credentials. 189 func GetToken(ctx *pulumi.Context) string { 190 return config.Get(ctx, "aws:token") 191 } 192 193 // The capacity of the AWS SDK's token bucket rate limiter. 194 func GetTokenBucketRateLimiterCapacity(ctx *pulumi.Context) int { 195 return config.GetInt(ctx, "aws:tokenBucketRateLimiterCapacity") 196 } 197 198 // Resolve an endpoint with DualStack capability 199 func GetUseDualstackEndpoint(ctx *pulumi.Context) bool { 200 return config.GetBool(ctx, "aws:useDualstackEndpoint") 201 } 202 203 // Resolve an endpoint with FIPS capability 204 func GetUseFipsEndpoint(ctx *pulumi.Context) bool { 205 return config.GetBool(ctx, "aws:useFipsEndpoint") 206 }