AWS Static Website v0.4.0, Apr 19 23

AWS Static Website v0.4.0 published on Wednesday, Apr 19, 2023 by Pulumi

aws-static-website.Website

Explore with Pulumi AI

AWS Static Website v0.4.0 published on Wednesday, Apr 19, 2023 by Pulumi

Create Website Resource

new Website(name: string, args: WebsiteArgs, opts?: CustomResourceOptions);

@overload
def Website(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            add_website_version_header: Optional[bool] = None,
            atomic_deployments: Optional[bool] = None,
            cache_ttl: Optional[float] = None,
            cdn_args: Optional[CDNArgsArgs] = None,
            certificate_arn: Optional[str] = None,
            error404: Optional[str] = None,
            index_html: Optional[str] = None,
            price_class: Optional[str] = None,
            site_path: Optional[str] = None,
            subdomain: Optional[str] = None,
            target_domain: Optional[str] = None,
            with_cdn: Optional[bool] = None,
            with_logs: Optional[bool] = None)
@overload
def Website(resource_name: str,
            args: WebsiteArgs,
            opts: Optional[ResourceOptions] = None)

func NewWebsite(ctx *Context, name string, args WebsiteArgs, opts ...ResourceOption) (*Website, error)

public Website(string name, WebsiteArgs args, CustomResourceOptions? opts = null)

public Website(String name, WebsiteArgs args)
public Website(String name, WebsiteArgs args, CustomResourceOptions options)

type: aws-static-website:Website
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args WebsiteArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args WebsiteArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args WebsiteArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args WebsiteArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args WebsiteArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Website Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Website resource accepts the following input properties:

SitePath string: The root directory containing the website's contents.
AddWebsiteVersionHeader bool: Enable a cache control header to be attached to every request from an Cloudfront Function.
AtomicDeployments bool: Provision a new bucket on each deployment.
CacheTTL double: TTL in seconds for cached objects.
CdnArgs Pulumi.AwsStaticWebsite.Inputs.CDNArgsArgs: Optional arguments used to configure the CDN.
CertificateARN string: 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.
Error404 string: default 404 page
IndexHTML string: The default document for the site. Defaults to index.html
PriceClass string: The price class to use for the CloudFront configuration. Defaults to 100 if not specified. Valid values are all, 100, and 200
Subdomain string: An optional subdomain that can be used to serve the content. This can typically be used to provision a www alias or if a deeply nested subdomain is needed (e.g. foo.bar.baz.com).
TargetDomain string: The domain used to serve the content. A Route53 hosted zone must exist for this domain.
WithCDN bool: Provision CloudFront CDN to serve content.
WithLogs bool: Provision a bucket to hold access logs.

SitePath string: The root directory containing the website's contents.
AddWebsiteVersionHeader bool: Enable a cache control header to be attached to every request from an Cloudfront Function.
AtomicDeployments bool: Provision a new bucket on each deployment.
CacheTTL float64: TTL in seconds for cached objects.
CdnArgs CDNArgsArgs: Optional arguments used to configure the CDN.
CertificateARN string: 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.
Error404 string: default 404 page
IndexHTML string: The default document for the site. Defaults to index.html
PriceClass string: The price class to use for the CloudFront configuration. Defaults to 100 if not specified. Valid values are all, 100, and 200
Subdomain string: An optional subdomain that can be used to serve the content. This can typically be used to provision a www alias or if a deeply nested subdomain is needed (e.g. foo.bar.baz.com).
TargetDomain string: The domain used to serve the content. A Route53 hosted zone must exist for this domain.
WithCDN bool: Provision CloudFront CDN to serve content.
WithLogs bool: Provision a bucket to hold access logs.

sitePath String: The root directory containing the website's contents.
addWebsiteVersionHeader Boolean: Enable a cache control header to be attached to every request from an Cloudfront Function.
atomicDeployments Boolean: Provision a new bucket on each deployment.
cacheTTL Double: TTL in seconds for cached objects.
cdnArgs CDNArgsArgs: Optional arguments used to configure the CDN.
certificateARN String: 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.
error404 String: default 404 page
indexHTML String: The default document for the site. Defaults to index.html
priceClass String: The price class to use for the CloudFront configuration. Defaults to 100 if not specified. Valid values are all, 100, and 200
subdomain String: An optional subdomain that can be used to serve the content. This can typically be used to provision a www alias or if a deeply nested subdomain is needed (e.g. foo.bar.baz.com).
targetDomain String: The domain used to serve the content. A Route53 hosted zone must exist for this domain.
withCDN Boolean: Provision CloudFront CDN to serve content.
withLogs Boolean: Provision a bucket to hold access logs.

sitePath string: The root directory containing the website's contents.
addWebsiteVersionHeader boolean: Enable a cache control header to be attached to every request from an Cloudfront Function.
atomicDeployments boolean: Provision a new bucket on each deployment.
cacheTTL number: TTL in seconds for cached objects.
cdnArgs CDNArgsArgs: Optional arguments used to configure the CDN.
certificateARN string: 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.
error404 string: default 404 page
indexHTML string: The default document for the site. Defaults to index.html
priceClass string: The price class to use for the CloudFront configuration. Defaults to 100 if not specified. Valid values are all, 100, and 200
subdomain string: An optional subdomain that can be used to serve the content. This can typically be used to provision a www alias or if a deeply nested subdomain is needed (e.g. foo.bar.baz.com).
targetDomain string: The domain used to serve the content. A Route53 hosted zone must exist for this domain.
withCDN boolean: Provision CloudFront CDN to serve content.
withLogs boolean: Provision a bucket to hold access logs.

site_path str: The root directory containing the website's contents.
add_website_version_header bool: Enable a cache control header to be attached to every request from an Cloudfront Function.
atomic_deployments bool: Provision a new bucket on each deployment.
cache_ttl float: TTL in seconds for cached objects.
cdn_args CDNArgsArgs: Optional arguments used to configure the CDN.
certificate_arn str: 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.
error404 str: default 404 page
index_html str: The default document for the site. Defaults to index.html
price_class str: The price class to use for the CloudFront configuration. Defaults to 100 if not specified. Valid values are all, 100, and 200
subdomain str: An optional subdomain that can be used to serve the content. This can typically be used to provision a www alias or if a deeply nested subdomain is needed (e.g. foo.bar.baz.com).
target_domain str: The domain used to serve the content. A Route53 hosted zone must exist for this domain.
with_cdn bool: Provision CloudFront CDN to serve content.
with_logs bool: Provision a bucket to hold access logs.

sitePath String: The root directory containing the website's contents.
addWebsiteVersionHeader Boolean: Enable a cache control header to be attached to every request from an Cloudfront Function.
atomicDeployments Boolean: Provision a new bucket on each deployment.
cacheTTL Number: TTL in seconds for cached objects.
cdnArgs Property Map: Optional arguments used to configure the CDN.
certificateARN String: 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.
error404 String: default 404 page
indexHTML String: The default document for the site. Defaults to index.html
priceClass String: The price class to use for the CloudFront configuration. Defaults to 100 if not specified. Valid values are all, 100, and 200
subdomain String: An optional subdomain that can be used to serve the content. This can typically be used to provision a www alias or if a deeply nested subdomain is needed (e.g. foo.bar.baz.com).
targetDomain String: The domain used to serve the content. A Route53 hosted zone must exist for this domain.
withCDN Boolean: Provision CloudFront CDN to serve content.
withLogs Boolean: Provision a bucket to hold access logs.

Outputs

All input properties are implicitly available as output properties. Additionally, the Website resource produces the following output properties:

BucketName string: The name of the s3 bucket containing the website contents.
BucketWebsiteURL string: The website URL for the s3 bucket.
WebsiteURL string: The URL to access the website
CdnDomainName string: The domain name for the CDN.
CdnURL string: The URL for the CDN
LogsBucketName string: The name of the s3 bucket containing the access logs.

BucketName string: The name of the s3 bucket containing the website contents.
BucketWebsiteURL string: The website URL for the s3 bucket.
WebsiteURL string: The URL to access the website
CdnDomainName string: The domain name for the CDN.
CdnURL string: The URL for the CDN
LogsBucketName string: The name of the s3 bucket containing the access logs.

bucketName String: The name of the s3 bucket containing the website contents.
bucketWebsiteURL String: The website URL for the s3 bucket.
websiteURL String: The URL to access the website
cdnDomainName String: The domain name for the CDN.
cdnURL String: The URL for the CDN
logsBucketName String: The name of the s3 bucket containing the access logs.

bucketName string: The name of the s3 bucket containing the website contents.
bucketWebsiteURL string: The website URL for the s3 bucket.
websiteURL string: The URL to access the website
cdnDomainName string: The domain name for the CDN.
cdnURL string: The URL for the CDN
logsBucketName string: The name of the s3 bucket containing the access logs.

bucket_name str: The name of the s3 bucket containing the website contents.
bucket_website_url str: The website URL for the s3 bucket.
website_url str: The URL to access the website
cdn_domain_name str: The domain name for the CDN.
cdn_url str: The URL for the CDN
logs_bucket_name str: The name of the s3 bucket containing the access logs.

bucketName String: The name of the s3 bucket containing the website contents.
bucketWebsiteURL String: The website URL for the s3 bucket.
websiteURL String: The URL to access the website
cdnDomainName String: The domain name for the CDN.
cdnURL String: The URL for the CDN
logsBucketName String: The name of the s3 bucket containing the access logs.

Supporting Types

CDNArgs

CloudfrontFunctionAssociations List<Pulumi.Aws.CloudFront.Inputs.DistributionOrderedCacheBehaviorFunctionAssociation>: A config block that triggers a cloudfront function with specific actions.
ForwardedValues Pulumi.Aws.CloudFront.Inputs.DistributionDefaultCacheBehaviorForwardedValues: The forwarded values configuration that specifies how CloudFront handles query strings, cookies and headers.
LambdaFunctionAssociations List<Pulumi.Aws.CloudFront.Inputs.DistributionOrderedCacheBehaviorLambdaFunctionAssociation>: A config block that triggers a lambda function with specific actions.

CloudfrontFunctionAssociations DistributionOrderedCacheBehaviorFunctionAssociation: A config block that triggers a cloudfront function with specific actions.
ForwardedValues DistributionDefaultCacheBehaviorForwardedValues: The forwarded values configuration that specifies how CloudFront handles query strings, cookies and headers.
LambdaFunctionAssociations DistributionOrderedCacheBehaviorLambdaFunctionAssociation: A config block that triggers a lambda function with specific actions.

cloudfrontFunctionAssociations List<DistributionOrderedCacheBehaviorFunctionAssociation>: A config block that triggers a cloudfront function with specific actions.
forwardedValues DistributionDefaultCacheBehaviorForwardedValues: The forwarded values configuration that specifies how CloudFront handles query strings, cookies and headers.
lambdaFunctionAssociations List<DistributionOrderedCacheBehaviorLambdaFunctionAssociation>: A config block that triggers a lambda function with specific actions.

cloudfrontFunctionAssociations pulumiAwstypesinputcloudfrontDistributionOrderedCacheBehaviorFunctionAssociation[]: A config block that triggers a cloudfront function with specific actions.
forwardedValues pulumiAwstypesinputcloudfrontDistributionDefaultCacheBehaviorForwardedValues: The forwarded values configuration that specifies how CloudFront handles query strings, cookies and headers.
lambdaFunctionAssociations pulumiAwstypesinputcloudfrontDistributionOrderedCacheBehaviorLambdaFunctionAssociation[]: A config block that triggers a lambda function with specific actions.

cloudfront_function_associations DistributionOrderedCacheBehaviorFunctionAssociationArgs]: A config block that triggers a cloudfront function with specific actions.
forwarded_values DistributionDefaultCacheBehaviorForwardedValuesArgs: The forwarded values configuration that specifies how CloudFront handles query strings, cookies and headers.
lambda_function_associations DistributionOrderedCacheBehaviorLambdaFunctionAssociationArgs]: A config block that triggers a lambda function with specific actions.

cloudfrontFunctionAssociations List<Property Map>: A config block that triggers a cloudfront function with specific actions.
forwardedValues Property Map: The forwarded values configuration that specifies how CloudFront handles query strings, cookies and headers.
lambdaFunctionAssociations List<Property Map>: A config block that triggers a lambda function with specific actions.

Package Details

Repository: aws-static-website pulumi/pulumi-aws-static-website
License

AWS Static Website v0.4.0 published on Wednesday, Apr 19, 2023 by Pulumi

pulumi/pulumi-aws-static-website

aws-static-website.Website

On this page

On this page

Create Website Resource

Website Resource Properties

Inputs

Outputs

Supporting Types

CDNArgs

Package Details

On this page

On this page