Struct: s3.Options

import "../ibm-cos-sdk-go-v2/service/s3"

Implemented Interfaces

types.AnalyticsFilter, v4.HTTPPresigner, s3.HTTPPresignerV4, types.MetricsFilter, s3.PresignPost, arn.S3ObjectLambdaARN, types.SelectObjectContentEventStream

Structure Field Summary collapse

Method Summary collapse

Structure Field Details

AppID string

The optional application specific identifier appended to the User-Agent header.

AuthSchemeResolver AuthSchemeResolver

The auth scheme resolver which determines how to authenticate for each operation.

AuthSchemes []smithyhttp.AuthScheme

The list of auth schemes supported by the client.

BaseEndpoint *string

This endpoint will be given as input to an EndpointResolverV2. It is used for providing a custom base endpoint that is subject to modifications by the processing EndpointResolverV2.

ClientLogMode aws.ClientLogMode

Configures the events that will be sent to the configured logger.

ContinueHeaderThresholdBytes int64

The threshold ContentLength in bytes for HTTP PUT request to receive 100-continue header. Setting to -1 will disable adding the Expect header to requests; setting to 0 will set the threshold to default 2MB

Credentials aws.CredentialsProvider

The credentials object to use when signing requests.

DefaultsMode aws.DefaultsMode

The configuration DefaultsMode that the SDK should use when constructing the clients initial default settings.

DisableLogOutputChecksumValidationSkipped bool

Disables logging when the client skips output checksum validation due to lack of algorithm support.

DisableMultiRegionAccessPoints bool

Allows you to disable S3 Multi-Region access points feature.

DisableS3ExpressSessionAuth *bool

Disables this client’s usage of Session Auth for S3Express buckets and reverts to using conventional SigV4 for those.

EndpointOptions EndpointResolverOptions

The endpoint options to be used when attempting to resolve an endpoint.

EndpointResolver EndpointResolver

The service endpoint resolver.

Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.

To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

EndpointResolverV2 EndpointResolverV2

Resolves the endpoint used for a particular service operation. This should be used over the deprecated EndpointResolver.

ExpressCredentials ExpressCredentialsProvider

The credentials provider for S3Express requests.

HTTPClient HTTPClient

The HTTP client to invoke API calls with. Defaults to client’s default HTTP implementation if nil.

HTTPSignerV4 HTTPSignerV4

Signature Version 4 (SigV4) Signer

Logger logging.Logger

The logger writer interface to write logging messages to.

MeterProvider metrics.MeterProvider

The client meter provider.

Region string

The region to send requests to. (Required)

RequestChecksumCalculation aws.RequestChecksumCalculation

Indicates how user opt-in/out request checksum calculation

ResponseChecksumValidation aws.ResponseChecksumValidation

Indicates how user opt-in/out response checksum validation

RetryMaxAttempts int

RetryMaxAttempts specifies the maximum number attempts an API client will call an operation that fails with a retryable error. A value of 0 is ignored, and will not be used to configure the API client created default retryer, or modify per operation call’s retry max attempts.

If specified in an operation call’s functional options with a value that is different than the constructed client’s Options, the Client’s Retryer will be wrapped to use the operation’s specific RetryMaxAttempts value.

RetryMode aws.RetryMode

RetryMode specifies the retry mode the API client will be created with, if Retryer option is not also specified.

When creating a new API Clients this member will only be used if the Retryer Options member is nil. This value will be ignored if Retryer is not nil.

Currently does not support per operation call overrides, may in the future.

Retryer aws.Retryer

Retryer guides how HTTP requests should be retried in case of recoverable failures. When nil the API client will use a default retryer. The kind of default retry created by the API client can be changed with the RetryMode option.

RuntimeEnvironment aws.RuntimeEnvironment

The RuntimeEnvironment configuration, only populated if the DefaultsMode is set to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You should not populate this structure programmatically, or rely on the values here within your applications.

TracerProvider tracing.TracerProvider

The client tracer provider.

UseARNRegion bool

Allows you to enable arn region support for the service.

UseAccelerate bool

Allows you to enable S3 Accelerate feature. All operations compatible with S3 Accelerate will use the accelerate endpoint for requests. Requests not compatible will fall back to normal S3 requests. The bucket must be enabled for accelerate to be used with S3 client with accelerate enabled. If the bucket is not enabled for accelerate an error will be returned. The bucket name must be DNS compatible to work with accelerate.

UseDualstack bool

Allows you to enable dual-stack endpoint support for the service.

Deprecated: Set dual-stack by setting UseDualStackEndpoint on EndpointResolverOptions. When EndpointResolverOptions’ UseDualStackEndpoint field is set it overrides this field value.

UsePathStyle bool

Allows you to enable the client to use path-style addressing, i.e., s3.amazonaws.com/BUCKET/KEY . By default, the S3 client will use virtual hosted bucket addressing when possible( BUCKET.s3.amazonaws.com/KEY ).

Method Details

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.



184
185
186
187
188
189
190
 
// File 'service/s3/options.go', line 184


func (o Options) Copy() Options {
	to := o
	to.APIOptions = make([]func(*middleware.Stack) error, len(o.APIOptions))
	copy(to.APIOptions, o.APIOptions)

	return to
}

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver 



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
// File 'service/s3/options.go', line 192


func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver {
	if schemeID == "aws.auth#sigv4" {
		return getSigV4IdentityResolver(o)
	}
	if schemeID == "com.amazonaws.s3#sigv4express" {
		return getExpressIdentityResolver(o)
	}
	if schemeID == "aws.auth#sigv4a" {
		return getSigV4AIdentityResolver(o)
	}
	if schemeID == "smithy.api#noAuth" {
		return &smithyauth.AnonymousIdentityResolver{}
	}
	return nil
}