Amazon Simple Storage Service

AWS::S3::Bucket

The following example demonstrates how to ingest your AWS S3 buckets to Port.

S3 Bucket Supported Actions

The table below summarizes the available actions for ingesting Amazon S3 Bucket resources in Port:

Action	Description	Type	Required AWS Permission
ListBucketsAction	Discover all S3 buckets across your AWS account. Reference	Default	s3:ListAllMyBuckets
GetBucketTaggingAction	Bring in bucket tags for catalog filtering and grouping. Reference	Default	s3:GetBucketTagging
GetBucketLocationAction	Retrieve the bucket's region. Reference	Optional	s3:GetBucketLocation
GetBucketEncryptionAction	Retrieve server-side encryption configuration for the bucket. Reference	Optional	s3:GetBucketEncryption
GetBucketPublicAccessBlockAction	Retrieve public access block configuration. Reference	Optional	s3:GetBucketPublicAccessBlock
GetBucketOwnershipControlsAction	Retrieve bucket ownership controls. Reference	Optional	s3:GetBucketOwnershipControls

Optional properties note

Properties of optional actions will not appear in the response unless you explicitly include the action that provides them in your configuration.

You can use the following Port blueprint definitions and integration configuration:

S3 Bucket Blueprint (Click to expand)

{
  "identifier": "s3Bucket",
  "description": "This blueprint represents an AWS S3 bucket in our software catalog",
  "title": "S3 bucket",
  "icon": "AWS",
  "schema": {
    "properties": {
      "arn": {
        "type": "string",
        "title": "ARN"
      },
      "region": {
        "type": "string",
        "title": "Region"
      },
      "creationDate": {
        "type": "string",
        "format": "date-time",
        "title": "Creation date"
      },
      "tags": {
        "type": "array",
        "title": "Tags",
        "items": {
          "type": "object",
          "properties": {
            "Key": {
              "type": "string"
            },
            "Value": {
              "type": "string"
            }
          }
        }
      }
    },
    "required": []
  },
  "mirrorProperties": {},
  "calculationProperties": {},
  "aggregationProperties": {},
  "relations": {
    "account": {
      "title": "Account",
      "target": "awsAccount",
      "required": true,
      "many": false
    }
  }
}

S3 Bucket Mapping Configuration (Click to expand)

resources:
  - kind: AWS::S3::Bucket
    selector:
      query: 'true'
      includeActions:
        # Optional: Include up to 3 additional actions for more properties
        # Choose based on which properties you need most
        # - GetBucketEncryptionAction
        # - GetBucketPublicAccessBlockAction
        # - GetBucketOwnershipControlsAction
    port:
      entity:
        mappings:
          identifier: .Properties.Arn
          title: .Properties.BucketName
          blueprint: '"s3Bucket"'
          properties:
            arn: .Properties.Arn
            region: .Properties.LocationConstraint
            creationDate: .Properties.CreationDate
            tags: .Properties.Tags
          relations:
            account: .__ExtraContext.AccountId

For more details about S3 bucket properties, refer to the AWS S3 API documentation.