p6cdkwebsiteplus

package module
v1.0.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 1, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

README

AWS CDK: R53 -> CF -> S3

P6CDKWebsitePlus

LICENSE

License

Other

Gitpod ready-to-code Sonarcloud Status GitHub commit activity GitHub commit activity

Usage

...
import { P6CDKWebsitePlus } from 'p6-cdk-website-plus';

new P6CDKWebsitePlus(this, 'WebsiteName', {
  hostedZoneName: 'gollucci.com',
  verifyEmail: 'pgollucci@p6m7g8.com',
  cloudfrontRecordName: 'www.gollucci.com',
});

Architecture

./assets/diagram.png

Author

Philip M. Gollucci pgollucci@p6m7g8.com

Documentation

Overview

R53 -> CF -> S3

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewP6CDKWebsitePlus_Override

func NewP6CDKWebsitePlus_Override(p P6CDKWebsitePlus, scope constructs.Construct, id *string, props IP6CDKWebsiteProps)

func P6CDKWebsitePlus_IsConstruct

func P6CDKWebsitePlus_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.

Returns: true if `x` is an object created from a class which extends `Construct`.

func P6CDKWebsitePlus_IsOwnedResource

func P6CDKWebsitePlus_IsOwnedResource(construct constructs.IConstruct) *bool

Returns true if the construct was created by CDK, and false otherwise.

func P6CDKWebsitePlus_IsResource

func P6CDKWebsitePlus_IsResource(construct constructs.IConstruct) *bool

Check whether the given construct is a Resource.

Types

type IP6CDKWebsiteProps

type IP6CDKWebsiteProps interface {
	CloudfrontRecordName() *string
	SetCloudfrontRecordName(c *string)
	HostedZoneName() *string
	SetHostedZoneName(h *string)
	VerifyEmail() *string
	SetVerifyEmail(v *string)
}

type P6CDKWebsitePlus

type P6CDKWebsitePlus interface {
	awscdk.Resource
	// The environment this resource belongs to.
	//
	// For resources that are created and managed by the CDK
	// (generally, those created by creating new class instances like Role, Bucket, etc.),
	// this is always the same as the environment of the stack they belong to;
	// however, for imported resources
	// (those obtained from static methods like fromRoleArn, fromBucketName, etc.),
	// that might be different than the stack they were imported into.
	Env() *awscdk.ResourceEnvironment
	// The tree node.
	Node() constructs.Node
	// Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
	//
	// This value will resolve to one of the following:
	// - a concrete value (e.g. `"my-awesome-bucket"`)
	// - `undefined`, when a name should be generated by CloudFormation
	// - a concrete name generated automatically during synthesis, in
	//   cross-environment scenarios.
	PhysicalName() *string
	// The stack in which this resource is defined.
	Stack() awscdk.Stack
	// Apply the given removal policy to this resource.
	//
	// The Removal Policy controls what happens to this resource when it stops
	// being managed by CloudFormation, either because you've removed it from the
	// CDK application or because you've made a change that requires the resource
	// to be replaced.
	//
	// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
	// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	GeneratePhysicalName() *string
	// Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`).
	//
	// Normally, this token will resolve to `arnAttr`, but if the resource is
	// referenced across environments, `arnComponents` will be used to synthesize
	// a concrete ARN with the resource's physical name. Make sure to reference
	// `this.physicalName` in `arnComponents`.
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	// Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`).
	//
	// Normally, this token will resolve to `nameAttr`, but if the resource is
	// referenced across environments, it will be resolved to `this.physicalName`,
	// which will be a concrete name.
	GetResourceNameAttribute(nameAttr *string) *string
	// Returns a string representation of this construct.
	ToString() *string
}

func NewP6CDKWebsitePlus

func NewP6CDKWebsitePlus(scope constructs.Construct, id *string, props IP6CDKWebsiteProps) P6CDKWebsitePlus

Directories

Path Synopsis
Package jsii contains the functionaility needed for jsii packages to initialize their dependencies and themselves.
Package jsii contains the functionaility needed for jsii packages to initialize their dependencies and themselves.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL