Struct: s3.EndpointParameters

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

Overview

EndpointParameters provides the parameters that influence how endpoints are resolved.

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

Accelerate *bool

When true, use S3 Accelerate. NOTE: Not all regions support S3 accelerate.

Defaults to false if no value is provided.

AWS::S3::Accelerate

Bucket *string

The S3 bucket used to send the request. This is an optional parameter that will be set automatically for operations that are scoped to an S3 bucket.

Parameter is required.

CopySource *string

The Copy Source used for Copy Object request. This is an optional parameter that will be set automatically for operations that are scoped to Copy Source.

Parameter is required.

DisableAccessPoints *bool

Internal parameter to disable Access Point Buckets

Parameter is required.

DisableMultiRegionAccessPoints *bool

Whether multi-region access points (MRAP) should be disabled.

Defaults to false if no value is provided.

AWS::S3::DisableMultiRegionAccessPoints

DisableS3ExpressSessionAuth *bool

Parameter to indicate whether S3Express session auth should be disabled

Parameter is required.

Endpoint *string

Override the endpoint used to send this request

Parameter is required.

SDK::Endpoint

ForcePathStyle *bool

When true, force a path-style endpoint to be used where the bucket name is part of the path.

Defaults to false if no value is provided.

AWS::S3::ForcePathStyle

Key *string

The S3 Key used to send the request. This is an optional parameter that will be set automatically for operations that are scoped to an S3 Key.

Parameter is required.

Prefix *string

The S3 Prefix used to send the request. This is an optional parameter that will be set automatically for operations that are scoped to an S3 Prefix.

Parameter is required.

Region *string

The AWS region used to dispatch the request.

Parameter is required.

AWS::Region

UseArnRegion *bool

When an Access Point ARN is provided and this flag is enabled, the SDK MUST use the ARN’s region when constructing the endpoint instead of the client’s configured region.

Parameter is required.

AWS::S3::UseArnRegion

UseDualStack *bool

When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.

Defaults to false if no value is provided.

AWS::UseDualStack

UseFIPS *bool

When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.

Defaults to false if no value is provided.

AWS::UseFIPS

UseGlobalEndpoint *bool

Whether the global endpoint should be used, rather then the regional endpoint for us-east-1.

Defaults to false if no value is provided.

AWS::S3::UseGlobalEndpoint

UseObjectLambdaEndpoint *bool

Internal parameter to use object lambda endpoint for an operation (eg: WriteGetObjectResponse)

Parameter is required.

UseS3ExpressControlEndpoint *bool

Internal parameter to indicate whether S3Express operation should use control plane, (ex. CreateBucket)

Parameter is required.

Method Details

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.



372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
 
// File 'service/s3/endpoints.go', line 372


func (p EndpointParameters) ValidateRequired() error {
	if p.Accelerate == nil {
		return fmt.Errorf("parameter Accelerate is required")
	}

	if p.DisableMultiRegionAccessPoints == nil {
		return fmt.Errorf("parameter DisableMultiRegionAccessPoints is required")
	}

	if p.ForcePathStyle == nil {
		return fmt.Errorf("parameter ForcePathStyle is required")
	}

	if p.UseDualStack == nil {
		return fmt.Errorf("parameter UseDualStack is required")
	}

	if p.UseFIPS == nil {
		return fmt.Errorf("parameter UseFIPS is required")
	}

	if p.UseGlobalEndpoint == nil {
		return fmt.Errorf("parameter UseGlobalEndpoint is required")
	}

	return nil
}

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.



402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
 
// File 'service/s3/endpoints.go', line 402


func (p EndpointParameters) WithDefaults() EndpointParameters {
	if p.Accelerate == nil {
		p.Accelerate = ptr.Bool(false)
	}

	if p.DisableMultiRegionAccessPoints == nil {
		p.DisableMultiRegionAccessPoints = ptr.Bool(false)
	}

	if p.ForcePathStyle == nil {
		p.ForcePathStyle = ptr.Bool(false)
	}

	if p.UseDualStack == nil {
		p.UseDualStack = ptr.Bool(false)
	}

	if p.UseFIPS == nil {
		p.UseFIPS = ptr.Bool(false)
	}

	if p.UseGlobalEndpoint == nil {
		p.UseGlobalEndpoint = ptr.Bool(false)
	}
	return p
}