aws-cdk-lib.aws_lightsail

AWS::Lightsail Construct Library

This module is part of the AWS Cloud Development Kit project.

import * as lightsail from 'aws-cdk-lib/aws-lightsail';

import aws_cdk.aws_lightsail as lightsail

import software.amazon.awscdk.services.lightsail.*;

using Amazon.CDK.AWS.Lightsail;

import lightsail "github.com/aws/aws-cdk-go/awscdk"

There are no official hand-written (L2) constructs for this service yet. Here are some suggestions on how to proceed:

• Search Construct Hub for Lightsail construct libraries
• Use the automatically generated L1 constructs, in the same way you would use the CloudFormation AWS::Lightsail resources directly.

There are no hand-written (L2) constructs for this service yet. However, you can still use the automatically generated L1 constructs, and use this service exactly as you would using CloudFormation directly.

For more information on the resources and properties available for this service, see the CloudFormation documentation for AWS::Lightsail.

(Read the CDK Contributing Guide and submit an RFC if you are interested in contributing to this construct library.)

Types

Name	Kind	Summary
CfnAlarm	Construct (L1)	The AWS::Lightsail::Alarm resource specifies an alarm that can be used to monitor a single metric for one of your Lightsail resources.
CfnBucket	Construct (L1)	The AWS::Lightsail::Bucket resource specifies a bucket.
CfnCertificate	Construct (L1)	The AWS::Lightsail::Certificate resource specifies an SSL/TLS certificate that you can use with a content delivery network (CDN) distribution and a container service.
CfnContactMethod	Construct (L1)	Resource Type definition for AWS::Lightsail::ContactMethod.
CfnContainer	Construct (L1)	The AWS::Lightsail::Container resource specifies a container service.
CfnDatabase	Construct (L1)	The AWS::Lightsail::Database resource specifies an Amazon Lightsail database.
CfnDatabaseSnapshot	Construct (L1)	Resource Type definition for AWS::Lightsail::DatabaseSnapshot.
CfnDisk	Construct (L1)	The AWS::Lightsail::Disk resource specifies a disk that can be attached to an Amazon Lightsail instance that is in the same AWS Region and Availability Zone.
CfnDiskSnapshot	Construct (L1)	Describes a block storage disk snapshot.
CfnDistribution	Construct (L1)	The AWS::Lightsail::Distribution resource specifies a content delivery network (CDN) distribution.
CfnDomain	Construct (L1)	Describes a domain where you are storing recordsets.
CfnInstance	Construct (L1)	The AWS::Lightsail::Instance resource specifies an Amazon Lightsail instance.
CfnInstanceSnapshot	Construct (L1)	Describes an instance snapshot.
CfnKeyPair	Construct (L1)	Resource Type definition for AWS::Lightsail::KeyPair.
CfnLoadBalancer	Construct (L1)	The AWS::Lightsail::LoadBalancer resource specifies a load balancer that can be used with Lightsail instances.
CfnLoadBalancerTlsCertificate	Construct (L1)	The AWS::Lightsail::LoadBalancerTlsCertificate resource specifies a TLS certificate that can be used with a Lightsail load balancer.
CfnStaticIp	Construct (L1)	The AWS::Lightsail::StaticIp resource specifies a static IP that can be attached to an Amazon Lightsail instance that is in the same AWS Region and Availability Zone.
CfnAlarmProps	Struct	Properties for defining a CfnAlarm.
CfnBucket.AccessRulesProperty	Struct	AccessRules is a property of the AWS::Lightsail::Bucket resource. It describes access rules for a bucket.
CfnBucketProps	Struct	Properties for defining a CfnBucket.
CfnCertificateProps	Struct	Properties for defining a CfnCertificate.
CfnContactMethodProps	Struct	Properties for defining a CfnContactMethod.
CfnContainer.ContainerProperty	Struct	Container is a property of the ContainerServiceDeployment property. It describes the settings of a container that will be launched, or that is launched, to an Amazon Lightsail container service.
CfnContainer.ContainerServiceDeploymentProperty	Struct	ContainerServiceDeployment is a property of the AWS::Lightsail::Container resource. It describes a container deployment configuration of a container service.
CfnContainer.EcrImagePullerRoleProperty	Struct	Describes the IAM role that you can use to grant a Lightsail container service access to Amazon ECR private repositories.
CfnContainer.EnvironmentVariableProperty	Struct	EnvironmentVariable is a property of the Container property. It describes the environment variables of a container on a container service which are key-value parameters that provide dynamic configuration of the application or script run by the container.
CfnContainer.HealthCheckConfigProperty	Struct	HealthCheckConfig is a property of the PublicEndpoint property. It describes the healthcheck configuration of a container deployment on a container service.
CfnContainer.PortInfoProperty	Struct	PortInfo is a property of the Container property. It describes the ports to open and the protocols to use for a container on a Amazon Lightsail container service.
CfnContainer.PrivateRegistryAccessProperty	Struct	Describes the configuration for an Amazon Lightsail container service to access private container image repositories, such as ( Amazon ECR ) private repositories.
CfnContainer.PublicDomainNameProperty	Struct	PublicDomainName is a property of the AWS::Lightsail::Container resource. It describes the public domain names to use with a container service, such as example.com and www.example.com . It also describes the certificates to use with a container service.
CfnContainer.PublicEndpointProperty	Struct	PublicEndpoint is a property of the ContainerServiceDeployment property. It describes describes the settings of the public endpoint of a container on a container service.
CfnContainerProps	Struct	Properties for defining a CfnContainer.
CfnDatabase.RelationalDatabaseParameterProperty	Struct	RelationalDatabaseParameter is a property of the AWS::Lightsail::Database resource. It describes parameters for the database.
CfnDatabaseProps	Struct	Properties for defining a CfnDatabase.
CfnDatabaseSnapshot.LocationProperty	Struct	The Region name and Availability Zone where the database snapshot is located.
CfnDatabaseSnapshotProps	Struct	Properties for defining a CfnDatabaseSnapshot.
CfnDisk.AddOnProperty	Struct	AddOn is a property of the AWS::Lightsail::Disk resource. It describes the add-ons for a disk.
CfnDisk.AutoSnapshotAddOnProperty	Struct	AutoSnapshotAddOn is a property of the AddOn property. It describes the automatic snapshot add-on for a disk.
CfnDisk.LocationProperty	Struct	The AWS Region and Availability Zone where the disk is located.
CfnDiskProps	Struct	Properties for defining a CfnDisk.
CfnDiskSnapshot.LocationProperty	Struct	The AWS Region and Availability Zone where the disk snapshot was created.
CfnDiskSnapshotProps	Struct	Properties for defining a CfnDiskSnapshot.
CfnDistribution.CacheBehaviorPerPathProperty	Struct	CacheBehaviorPerPath is a property of the AWS::Lightsail::Distribution resource. It describes the per-path cache behavior of an Amazon Lightsail content delivery network (CDN) distribution.
CfnDistribution.CacheBehaviorProperty	Struct	CacheBehavior is a property of the AWS::Lightsail::Distribution resource. It describes the default cache behavior of an Amazon Lightsail content delivery network (CDN) distribution.
CfnDistribution.CacheSettingsProperty	Struct	CacheSettings is a property of the AWS::Lightsail::Distribution resource. It describes the cache settings of an Amazon Lightsail content delivery network (CDN) distribution.
CfnDistribution.CookieObjectProperty	Struct	CookieObject is a property of the CacheSettings property. It describes whether an Amazon Lightsail content delivery network (CDN) distribution forwards cookies to the origin and, if so, which ones.
CfnDistribution.HeaderObjectProperty	Struct	HeaderObject is a property of the CacheSettings property. It describes the request headers used by your distribution, which caches your content based on the request headers.
CfnDistribution.InputOriginProperty	Struct	InputOrigin is a property of the AWS::Lightsail::Distribution resource. It describes the origin resource of an Amazon Lightsail content delivery network (CDN) distribution.
CfnDistribution.QueryStringObjectProperty	Struct	QueryStringObject is a property of the CacheSettings property. It describes the query string parameters that an Amazon Lightsail content delivery network (CDN) distribution to bases caching on.
CfnDistributionProps	Struct	Properties for defining a CfnDistribution.
CfnDomain.DomainEntryProperty	Struct	Describes a domain recordset entry.
CfnDomain.LocationProperty	Struct	The AWS Region and Availability Zone where the domain was created (read-only).
CfnDomainProps	Struct	Properties for defining a CfnDomain.
CfnInstance.AddOnProperty	Struct	AddOn is a property of the AWS::Lightsail::Instance resource. It describes the add-ons for an instance.
CfnInstance.AutoSnapshotAddOnProperty	Struct	AutoSnapshotAddOn is a property of the AddOn property. It describes the automatic snapshot add-on for an instance.
CfnInstance.DiskProperty	Struct	Disk is a property of the Hardware property. It describes a disk attached to an instance.
CfnInstance.HardwareProperty	Struct	Hardware is a property of the AWS::Lightsail::Instance resource. It describes the hardware properties for the instance, such as the vCPU count, attached disks, and amount of RAM.
CfnInstance.LocationProperty	Struct	Location is a property of the AWS::Lightsail::Instance resource. It describes the location for an instance.
CfnInstance.MonthlyTransferProperty	Struct	MonthlyTransfer is a property of the Networking property. It describes the amount of allocated monthly data transfer (in GB) for an instance.
CfnInstance.NetworkingProperty	Struct	Networking is a property of the AWS::Lightsail::Instance resource. It describes the public ports and the monthly amount of data transfer allocated for the instance.
CfnInstance.PortProperty	Struct	Port is a property of the Networking property. It describes information about ports for an instance.
CfnInstance.StateProperty	Struct	State is a property of the AWS::Lightsail::Instance resource. It describes the status code and the state (for example, running ) of an instance.
CfnInstanceProps	Struct	Properties for defining a CfnInstance.
CfnInstanceSnapshot.LocationProperty	Struct	The region name and Availability Zone where you created the snapshot.
CfnInstanceSnapshotProps	Struct	Properties for defining a CfnInstanceSnapshot.
CfnKeyPair.ResourceLocationProperty	Struct
CfnKeyPairProps	Struct	Properties for defining a CfnKeyPair.
CfnLoadBalancerProps	Struct	Properties for defining a CfnLoadBalancer.
CfnLoadBalancerTlsCertificateProps	Struct	Properties for defining a CfnLoadBalancerTlsCertificate.
CfnStaticIpProps	Struct	Properties for defining a CfnStaticIp.