Skip to main content

S3WebsiteSchema

The S3WebsiteSchema class is the schema for the S3Website resource, which represents the AWS Simple Storage Service (S3) Website resource. This resource can create a s3 website in AWS using the AWS JavaScript SDK V3 API. See official sdk docs.

@group

Resources/S3Website

@overrideProperty

parents - This resource has no parents.

@overrideProperty

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

Hierarchy

  • BaseResourceSchema
    • S3WebsiteSchema

Index

Properties

Properties

inheritedparents

parents: IResourceReference[]

properties

properties: { awsAccountId: string; awsRegionId: string; Bucket: string; ErrorDocument: string; IndexDocument: string } = ...

Input properties.

  • properties.awsAccountId - The AWS account id.
  • properties.awsRegionId - The AWS region id.
  • properties.Bucket - The name of the bucket.
  • properties.ErrorDocument - Path of the error document, e.g. error.html.
  • properties.IndexDocument - Path of the index document, e.g. index.html.

Type declaration

  • awsAccountId: string
  • awsRegionId: string
  • Bucket: string
  • ErrorDocument: string
  • IndexDocument: string

inheritedresourceId

resourceId: string

response

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

Saved response.

  • response.Arn - The ARN of the bucket.
  • response.awsRegionId - The AWS region id.

Type declaration

  • optionalArn?: string
  • optionalawsRegionId?: string

inheritedtags

tags: {}

Type declaration

  • [key string]: string
Page Options