AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Configuration for accessing AmazonS3 service
Namespace: Amazon.S3
Assembly: AWSSDK.S3.dll
Version: 3.x.y.z
public class AmazonS3Config : ClientConfig IClientConfig
The AmazonS3Config type exposes the following members
Name | Description | |
---|---|---|
AmazonS3Config() |
Default constructor |
Name | Type | Description | |
---|---|---|---|
AccountIdEndpointMode | Amazon.Runtime.AccountIdEndpointMode | Inherited from Amazon.Runtime.ClientConfig. | |
AllowAutoRedirect | System.Boolean | Inherited from Amazon.Runtime.ClientConfig. | |
AuthenticationRegion | System.String | Inherited from Amazon.Runtime.ClientConfig. | |
AuthenticationServiceName | System.String | Inherited from Amazon.Runtime.ClientConfig. | |
AWSTokenProvider | Amazon.Runtime.IAWSTokenProvider | Inherited from Amazon.Runtime.ClientConfig. | |
BufferSize | System.Int32 | Inherited from Amazon.Runtime.ClientConfig. | |
ClientAppId | System.String | Inherited from Amazon.Runtime.ClientConfig. | |
ClockOffset | System.TimeSpan | Inherited from Amazon.Runtime.ClientConfig. | |
ConnectionLimit | System.Int32 | Inherited from Amazon.Runtime.ClientConfig. | |
CorrectedUtcNow | System.DateTime | Inherited from Amazon.Runtime.ClientConfig. | |
DefaultConfigurationMode | Amazon.Runtime.DefaultConfigurationMode | Inherited from Amazon.Runtime.ClientConfig. | |
DisableHostPrefixInjection | System.Boolean | Inherited from Amazon.Runtime.ClientConfig. | |
DisableLogging | System.Boolean | Inherited from Amazon.Runtime.ClientConfig. | |
DisableMultiregionAccessPoints | System.Boolean |
If set to true, prevents calls to multi-region access points. If not explicitly set here it will fallback first to the value of AWS_S3_DISABLE_MULTIREGION_ACCESS_POINTS environment variable, then to s3_disable_multiregion_access_points in the shared configuration file. Once a valid value is found in the environment variable or configuration file it will be cached for this AmazonS3Config instance. |
|
DisableRequestCompression | System.Boolean | Inherited from Amazon.Runtime.ClientConfig. | |
DisableS3ExpressSessionAuth | System.Boolean |
If set to true the use of S3Express auth disabled. |
|
EndpointDiscoveryCacheLimit | System.Int32 | Inherited from Amazon.Runtime.ClientConfig. | |
EndpointDiscoveryEnabled | System.Boolean | Inherited from Amazon.Runtime.ClientConfig. | |
EndpointProvider | Amazon.Runtime.Endpoints.IEndpointProvider | Inherited from Amazon.Runtime.ClientConfig. | |
FastFailRequests | System.Boolean | Inherited from Amazon.Runtime.ClientConfig. | |
ForcePathStyle | System.Boolean |
When true, requests will always use path style addressing. |
|
IgnoreConfiguredEndpointUrls | System.Boolean | Inherited from Amazon.Runtime.ClientConfig. | |
IsMaxErrorRetrySet | System.Boolean | Inherited from Amazon.Runtime.ClientConfig. | |
LogMetrics | System.Boolean | Inherited from Amazon.Runtime.ClientConfig. | |
LogResponse | System.Boolean | Inherited from Amazon.Runtime.ClientConfig. | |
MaxErrorRetry | System.Int32 | Inherited from Amazon.Runtime.ClientConfig. | |
MaxIdleTime | System.Int32 | Inherited from Amazon.Runtime.ClientConfig. | |
Profile | Amazon.Profile | Inherited from Amazon.Runtime.ClientConfig. | |
ProgressUpdateInterval | System.Int64 | Inherited from Amazon.Runtime.ClientConfig. | |
ProxyBypassList | System.Collections.Generic.List<System.String> | Inherited from Amazon.Runtime.ClientConfig. | |
ProxyBypassOnLocal | System.Boolean | Inherited from Amazon.Runtime.ClientConfig. | |
ProxyCredentials | System.Net.ICredentials | Inherited from Amazon.Runtime.ClientConfig. | |
ProxyHost | System.String | Inherited from Amazon.Runtime.ClientConfig. | |
ProxyPort | System.Int32 | Inherited from Amazon.Runtime.ClientConfig. | |
ReadEntireResponse | System.Boolean | Inherited from Amazon.Runtime.ClientConfig. | |
ReadWriteTimeout | System.Nullable<System.TimeSpan> | Inherited from Amazon.Runtime.ClientConfig. | |
RegionEndpoint | Amazon.RegionEndpoint | Inherited from Amazon.Runtime.ClientConfig. | |
RegionEndpointServiceName | System.String |
The constant used to lookup in the region hash the endpoint. |
|
RequestMinCompressionSizeBytes | System.Int64 | Inherited from Amazon.Runtime.ClientConfig. | |
ResignRetries | System.Boolean | Inherited from Amazon.Runtime.ClientConfig. | |
RetryMode | Amazon.Runtime.RequestRetryMode | Inherited from Amazon.Runtime.ClientConfig. | |
S3ExpressCredentialProvider | Amazon.S3.IS3ExpressCredentialProvider |
Gets and sets S3Express credential provider property. This property is used to provide credentials for requests that uses S3Express authentication. During client initialization it is set to default S3Express credential provider, but can be changed to use custom user supplied S3Express credential provider. |
|
ServiceId | System.String |
The ServiceId, which is the unique identifier for a service. |
|
ServiceId | System.String | Inherited from Amazon.Runtime.ClientConfig. | |
ServiceURL | System.String | Inherited from Amazon.Runtime.ClientConfig. | |
ServiceVersion | System.String |
Gets the ServiceVersion property. |
|
SignatureMethod | Amazon.Runtime.SigningAlgorithm | Inherited from Amazon.Runtime.ClientConfig. | |
SignatureVersion | System.String | Inherited from Amazon.Runtime.ClientConfig. | |
TcpKeepAlive | Amazon.Runtime.TcpKeepAlive | Inherited from Amazon.Runtime.ClientConfig. | |
TelemetryProvider | Amazon.Runtime.Telemetry.TelemetryProvider | Inherited from Amazon.Runtime.ClientConfig. | |
ThrottleRetries | System.Boolean | Inherited from Amazon.Runtime.ClientConfig. | |
Timeout | System.Nullable<System.TimeSpan> | Inherited from Amazon.Runtime.ClientConfig. | |
UseAccelerateEndpoint | System.Boolean |
Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name should be DNS compliant names and should not contain periods (.). The following APIs are not supported and are sent to the regular region endpoint, even if this option is enabled:
|
|
UseAlternateUserAgentHeader | System.Boolean | Inherited from Amazon.Runtime.ClientConfig. | |
UseArnRegion | System.Boolean |
If set to true and the service package supports it the region identified in the arn for a resource will be used when making the service request. |
|
USEast1RegionalEndpointValue | System.Nullable<Amazon.Runtime.S3UsEast1RegionalEndpointValue> |
USEast1RegionalEndpointValue determines whether or not to send the us-east-1 s3 requests to the regional endpoint or to the legacy global endpoint. This flags takes precedence over the AWS_S3_US_EAST_1_REGIONAL_ENDPOINT environment variable and the credential file. |
|
UseDualstackEndpoint | System.Boolean | Inherited from Amazon.Runtime.ClientConfig. | |
UseFIPSEndpoint | System.Boolean | Inherited from Amazon.Runtime.ClientConfig. | |
UseHttp | System.Boolean | Inherited from Amazon.Runtime.ClientConfig. | |
UseNagleAlgorithm | System.Boolean | Inherited from Amazon.Runtime.ClientConfig. | |
UserAgent | System.String |
Gets the value of UserAgent property. |
Name | Description | |
---|---|---|
DetermineDnsSuffix() | Inherited from Amazon.Runtime.ClientConfig. | |
DetermineServiceURL() |
Given this client configuration, returns the service url |
|
GetHttpProxy() | Inherited from Amazon.Runtime.ClientConfig. | |
GetHttpsProxy() | Inherited from Amazon.Runtime.ClientConfig. | |
GetWebProxy() | Inherited from Amazon.Runtime.ClientConfig. | |
SetUseNagleIfAvailable(bool) | Inherited from Amazon.Runtime.ClientConfig. | |
SetWebProxy(WebProxy) | Inherited from Amazon.Runtime.ClientConfig. | |
Validate() |
Validate that the config object is properly configured. |
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5