Struct: s3.LoggingEnabled

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

Overview

Describes where logs are stored and the prefix that Amazon S3 assigns to all log object keys for a bucket. For more information, see PUT Bucket logging (docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTlogging.html) in the Amazon Simple Storage Service API Reference.

Implemented Interfaces

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

Structure Field Summary

• TargetBucket *string

  Specifies the bucket where you want Amazon S3 to store server access logs.

• TargetGrants []*TargetGrant

  Container for granting information.

• TargetPrefix *string

  A prefix for all log object keys.

• _ struct{}

Service Operations

• GoString() string operation

  GoString returns the string representation.

• SetTargetBucket(string) *LoggingEnabled operation

  SetTargetBucket sets the TargetBucket field’s value.

• SetTargetGrants([]*TargetGrant) *LoggingEnabled operation

  SetTargetGrants sets the TargetGrants field’s value.

• SetTargetPrefix(string) *LoggingEnabled operation

  SetTargetPrefix sets the TargetPrefix 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

TargetBucket *string `type:"string" required:"true"`

Specifies the bucket where you want Amazon S3 to store server access logs. You can have your logs delivered to any bucket that you own, including the same bucket that is being logged. You can also configure multiple buckets to deliver their logs to the same target bucket. In this case, you should choose a different TargetPrefix for each source bucket so that the delivered log files can be distinguished by key.

TargetBucket is a required field

TargetGrants []*TargetGrant `locationNameList:"Grant" type:"list"`

Container for granting information.

TargetPrefix *string `type:"string" required:"true"`

A prefix for all log object keys. If you store log files from multiple Amazon S3 buckets in a single bucket, you can use a prefix to distinguish which log files came from which bucket.

TargetPrefix is a required field

_ struct{} `type:"structure"`

Method Details

func (s LoggingEnabled) 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 18277

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

func (s *LoggingEnabled) SetTargetBucket(v string) *LoggingEnabled

SetTargetBucket sets the TargetBucket field’s value.

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

func (s *LoggingEnabled) SetTargetBucket(v string) *LoggingEnabled {
	s.TargetBucket = &v
	return s
}

func (s *LoggingEnabled) SetTargetGrants(v []*TargetGrant) *LoggingEnabled

SetTargetGrants sets the TargetGrants field’s value.

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

func (s *LoggingEnabled) SetTargetGrants(v []*TargetGrant) *LoggingEnabled {
	s.TargetGrants = v
	return s
}

func (s *LoggingEnabled) SetTargetPrefix(v string) *LoggingEnabled

SetTargetPrefix sets the TargetPrefix field’s value.

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

func (s *LoggingEnabled) SetTargetPrefix(v string) *LoggingEnabled {
	s.TargetPrefix = &v
	return s
}

func (s LoggingEnabled) 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 18268

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

func (s *LoggingEnabled) Validate() error

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

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

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

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