Struct: s3.ReplicationConfiguration

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

Overview

A container for replication rules. You can add up to 1,000 rules. The maximum size of a replication configuration is 2 MB.

Implemented Interfaces

s3crypto.Cipher, s3manager.ReadSeekerWriteTo, request.Validator, s3manager.WriterReadFrom

Structure Field Summary

• Role *string

  The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that Amazon S3 assumes when replicating objects.

• Rules []*ReplicationRule

  A container for one or more replication rules.

• _ struct{}

Service Operations

• GoString() string operation

  GoString returns the string representation.

• SetRole(string) *ReplicationConfiguration operation

  SetRole sets the Role field's value.

• SetRules([]*ReplicationRule) *ReplicationConfiguration operation

  SetRules sets the Rules field's value.

• String() string operation

  String returns the string representation.

• Validate() error operation

  Validate inspects the fields of the type to determine if they are valid.

Structure Field Details

Role *string `type:"string"`

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that Amazon S3 assumes when replicating objects. For more information, see How to Set Up Replication (docs.aws.amazon.com/AmazonS3/latest/dev/replication-how-setup.html) in the Amazon S3 User Guide.

Rules []*ReplicationRule `locationName:"Rule" type:"list" flattened:"true" required:"true"`

A container for one or more replication rules. A replication configuration must have at least one rule and can contain a maximum of 1,000 rules.

Rules is a required field

_ struct{} `type:"structure"`

Method Details

func (s ReplicationConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as “sensitive” in the API will not be included in the string output. The member name will be present, but the value will be replaced with “sensitive”.

// File 'service/s3/api.go', line 21159

func (s ReplicationConfiguration) GoString() string {
	return s.String()
}

func (s *ReplicationConfiguration) SetRole(v string) *ReplicationConfiguration

SetRole sets the Role field's value.

// File 'service/s3/api.go', line 21187

func (s *ReplicationConfiguration) SetRole(v string) *ReplicationConfiguration {
	s.Role = &v
	return s
}

func (s *ReplicationConfiguration) SetRules(v []*ReplicationRule) *ReplicationConfiguration

SetRules sets the Rules field's value.

// File 'service/s3/api.go', line 21193

func (s *ReplicationConfiguration) SetRules(v []*ReplicationRule) *ReplicationConfiguration {
	s.Rules = v
	return s
}

func (s ReplicationConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as “sensitive” in the API will not be included in the string output. The member name will be present, but the value will be replaced with “sensitive”.

// File 'service/s3/api.go', line 21150

func (s ReplicationConfiguration) String() string {
	return awsutil.Prettify(s)
}

func (s *ReplicationConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

// File 'service/s3/api.go', line 21164

func (s *ReplicationConfiguration) Validate() error {
	invalidParams := request.ErrInvalidParams{Context: "ReplicationConfiguration"}
	if s.Rules == nil {
		invalidParams.Add(request.NewErrParamRequired("Rules"))
	}
	if s.Rules != nil {
		for i, v := range s.Rules {
			if v == nil {
				continue
			}
			if err := v.Validate(); err != nil {
				invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Rules", i), err.(request.ErrInvalidParams))
			}
		}
	}

	if invalidParams.Len() > 0 {
		return invalidParams
	}
	return nil
}