Class: Aws::CodeBuild::Types::S3LogsConfig

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb

Overview

Note:

When making an API call, you may pass S3LogsConfig data as a hash:

{
  status: "ENABLED", # required, accepts ENABLED, DISABLED
  location: "String",
  encryption_disabled: false,
  bucket_owner_access: "NONE", # accepts NONE, READ_ONLY, FULL
}

Information about S3 logs for a build project.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bucket_owner_accessString

Specifies the bucket owner's access for objects that another account uploads to their Amazon S3 bucket. By default, only the account that uploads the objects to the bucket has access to these objects. This property allows you to give the bucket owner access to these objects.

To use this property, your CodeBuild service role must have the s3:PutBucketAcl permission. This permission allows CodeBuild to modify the access control list for the bucket.

This property can be one of the following values:

NONE

The bucket owner does not have access to the objects. This is the default.

READ_ONLY

The bucket owner has read-only access to the objects. The uploading account retains ownership of the objects.

FULL

The bucket owner has full access to the objects. Object ownership is determined by the following criteria:

  • If the bucket is configured with the Bucket owner preferred setting, the bucket owner owns the objects. The uploading account will have object access as specified by the bucket's policy.

  • Otherwise, the uploading account retains ownership of the objects.

For more information about Amazon S3 object ownership, see Controlling ownership of uploaded objects using S3 Object Ownership in the Amazon Simple Storage Service User Guide.

Returns:

  • (String)


5371
5372
5373
5374
5375
5376
5377
5378
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 5371

class S3LogsConfig < Struct.new(
  :status,
  :location,
  :encryption_disabled,
  :bucket_owner_access)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_disabledBoolean

Set to true if you do not want your S3 build log output encrypted. By default S3 build logs are encrypted.

Returns:

  • (Boolean)


5371
5372
5373
5374
5375
5376
5377
5378
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 5371

class S3LogsConfig < Struct.new(
  :status,
  :location,
  :encryption_disabled,
  :bucket_owner_access)
  SENSITIVE = []
  include Aws::Structure
end

#locationString

The ARN of an S3 bucket and the path prefix for S3 logs. If your Amazon S3 bucket name is my-bucket, and your path prefix is build-log, then acceptable formats are my-bucket/build-log or arn:aws:s3:::my-bucket/build-log.

Returns:

  • (String)


5371
5372
5373
5374
5375
5376
5377
5378
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 5371

class S3LogsConfig < Struct.new(
  :status,
  :location,
  :encryption_disabled,
  :bucket_owner_access)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

The current status of the S3 build logs. Valid values are:

  • ENABLED: S3 build logs are enabled for this build project.

  • DISABLED: S3 build logs are not enabled for this build project.

Returns:

  • (String)


5371
5372
5373
5374
5375
5376
5377
5378
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 5371

class S3LogsConfig < Struct.new(
  :status,
  :location,
  :encryption_disabled,
  :bucket_owner_access)
  SENSITIVE = []
  include Aws::Structure
end