This package is deprecated.
Viewing docs for AWS Static Website v0.4.0
published on Wednesday, Apr 19, 2023 by Pulumi
published on Wednesday, Apr 19, 2023 by Pulumi
AWS Static Website (Deprecated)
I want to use the Pulumi AWS Static Website package (aws-static-website) in my project.
## Provider details
- Package: aws-static-website
- Version: v0.4.0
- Publisher: Pulumi
- Source: pulumi
- Repository: https://github.com/pulumi/pulumi-aws-static-website
## Documentation
The Pulumi Cloud Registry API serves canonical, up-to-date docs for this package — including private packages and every published version. Send the "Accept: text/markdown" header for clean readable content, or "application/json" for structured data.
Start at the navigation tree, which cross-links to the readme, installation guide, and per-resource docs URL template:
- https://api.pulumi.com/api/registry/packages/pulumi/pulumi/aws-static-website/versions/latest/nav
Returns a summary by default. The full tree can be hundreds of kB for large providers, so prefer targeted search: append "?q=<query>&depth=full" to filter by resource/function title or token (for example "?q=bucket&depth=full"). Only request the full nav without a query if you actually need to enumerate every resource.
Other endpoints:
- Overview and getting started: https://api.pulumi.com/api/registry/packages/pulumi/pulumi/aws-static-website/versions/latest/readme
- Installation and configuration: https://api.pulumi.com/api/registry/packages/pulumi/pulumi/aws-static-website/versions/latest/installation
- Per-resource/function docs: https://api.pulumi.com/api/registry/packages/pulumi/pulumi/aws-static-website/versions/latest/docs/{token}?lang={lang}
Replace {token} with the percent-encoded token from the nav response (for example aws:s3/bucket:Bucket).
Replace {lang} with typescript, python, go, csharp, java, yaml, or hcl.
Fetch the installation endpoint above for the correct setup steps — install instructions vary between native providers, bridged Terraform providers, and component packages.
Help me get started using this provider. Show me a complete Pulumi program that provisions a common resource, including all necessary configuration and imports.
This package is deprecated.
Viewing docs for AWS Static Website v0.4.0
published on Wednesday, Apr 19, 2023 by Pulumi
published on Wednesday, Apr 19, 2023 by Pulumi
This component makes it easy to deploy a static website to s3 along with an optional CloudFront distribution using any of the supported Pulumi programming languages including markup languages like YAML and JSON.
Examples
const args = {
sitePath: "../website/build",
} as staticwebsite.WebsiteArgs
const site = new staticwebsite.Website("website", args);
resources:
web:
type: "aws-static-website:index:Website"
properties:
sitePath: "../website/build"
outputs:
websiteURL: ${web.websiteURL}
Input Properties
This component takes the following inputs.
- sitePath - the root directory containing the website’s contents to be served (required)
- withCDN - provision a CloudFront CDN to serve content
- targetDomain - the domain used to serve the content. A Route53 hosted zone must exist for this domain is this option is specified
- index.html - the default document for the site. Defaults to index.html
- error404 - the default 404 error page
- certificateARN - the ARN of the ACM certificate to use for serving HTTPS. If one is not provided, a certificate will be created during the provisioning process
- cacheTTL - TTL inseconds for cached objects
- withLogs - provision a bucket to house access logs
- priceClass - the price class to use for the CDN. Defaults to
100if not specified.
Outputs
This component provides the following outputs. Some may not be available depending on the given input configuration (e.g. if withCDN was not specified there will be no output for cdnDomainName and cdnURL)
- bucketName - the name of the s3 bucket containing the website’s contents
- bucketWebsiteURL - the website URL for the s3 bucket
- cdnDomainName - the CDN domain name
- cdnURL - the CDN’s endpoint URL
- logsBucketName - the name of the s3 bucket containing the access logs
- websiteURL - the URL to access the website
Notes:
- If specifying a target domain and provisioning a CloudFront distribution, it is assumed there is a hosted zone configured in route53 for that target domain.
- If you already have an ACM certificate provisioned for your domain, then you can simply pass the ARN as one of the input properties. If not we will attempt to provision one for you based on the target domain provided.
This package is deprecated.
Viewing docs for AWS Static Website v0.4.0
published on Wednesday, Apr 19, 2023 by Pulumi
published on Wednesday, Apr 19, 2023 by Pulumi