S3StorageSchema

The S3StorageSchema class is the schema for the S3Storage resource, which represents the AWS Simple Storage Service (S3) Bucket resource. This resource can create an S3 bucket in AWS using the AWS JavaScript SDK V3 API. See official sdk docs.

@group

Resources/S3Storage

@overrideProperty

parents - This resource has parents.

@overrideProperty

resourceId - The resource id is of format bucket-<bucket-name>

Hierarchy

• BaseResourceSchema
  • S3StorageSchema

Index

Properties

• parents
• properties
• resourceId
• response
• tags

Properties

inheritedparents

parents: IResourceReference[]

Inherited from BaseResourceSchema.parents

properties

properties: { awsAccountId: string; awsRegionId: string; Bucket: string; permissions: S3StoragePermissionSchema[] } = ...

Overrides BaseResourceSchema.properties

Input properties.

• properties.awsAccountId - The AWS account id.
• properties.awsRegionId - The AWS region id.
• properties.Bucket - The name of the bucket.
• properties.permissions - The permissions for the bucket. See S3StoragePermissionSchema for options.

---

Type declaration

• awsAccountId: string

• awsRegionId: string

• Bucket: string

• permissions: S3StoragePermissionSchema[]

inheritedresourceId

resourceId: string

Inherited from BaseResourceSchema.resourceId

response

response: { Arn?: string } = ...

Overrides BaseResourceSchema.response

Saved response.

• response.Arn - The ARN of the bucket.

---

Type declaration

• optionalArn?: string

inheritedtags

tags: {}

Inherited from BaseResourceSchema.tags

Type declaration

• [key string]: string