README
¶
AWS::Lightsail Construct Library
This module is part of the AWS Cloud Development Kit project.
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.)
Documentation
¶
Index ¶
- func CfnAlarm_CFN_RESOURCE_TYPE_NAME() *string
- func CfnAlarm_IsCfnElement(x interface{}) *bool
- func CfnAlarm_IsCfnResource(x interface{}) *bool
- func CfnAlarm_IsConstruct(x interface{}) *bool
- func CfnBucket_CFN_RESOURCE_TYPE_NAME() *string
- func CfnBucket_IsCfnElement(x interface{}) *bool
- func CfnBucket_IsCfnResource(x interface{}) *bool
- func CfnBucket_IsConstruct(x interface{}) *bool
- func CfnCertificate_CFN_RESOURCE_TYPE_NAME() *string
- func CfnCertificate_IsCfnElement(x interface{}) *bool
- func CfnCertificate_IsCfnResource(x interface{}) *bool
- func CfnCertificate_IsConstruct(x interface{}) *bool
- func CfnContainer_CFN_RESOURCE_TYPE_NAME() *string
- func CfnContainer_IsCfnElement(x interface{}) *bool
- func CfnContainer_IsCfnResource(x interface{}) *bool
- func CfnContainer_IsConstruct(x interface{}) *bool
- func CfnDatabase_CFN_RESOURCE_TYPE_NAME() *string
- func CfnDatabase_IsCfnElement(x interface{}) *bool
- func CfnDatabase_IsCfnResource(x interface{}) *bool
- func CfnDatabase_IsConstruct(x interface{}) *bool
- func CfnDisk_CFN_RESOURCE_TYPE_NAME() *string
- func CfnDisk_IsCfnElement(x interface{}) *bool
- func CfnDisk_IsCfnResource(x interface{}) *bool
- func CfnDisk_IsConstruct(x interface{}) *bool
- func CfnDistribution_CFN_RESOURCE_TYPE_NAME() *string
- func CfnDistribution_IsCfnElement(x interface{}) *bool
- func CfnDistribution_IsCfnResource(x interface{}) *bool
- func CfnDistribution_IsConstruct(x interface{}) *bool
- func CfnInstance_CFN_RESOURCE_TYPE_NAME() *string
- func CfnInstance_IsCfnElement(x interface{}) *bool
- func CfnInstance_IsCfnResource(x interface{}) *bool
- func CfnInstance_IsConstruct(x interface{}) *bool
- func CfnLoadBalancerTlsCertificate_CFN_RESOURCE_TYPE_NAME() *string
- func CfnLoadBalancerTlsCertificate_IsCfnElement(x interface{}) *bool
- func CfnLoadBalancerTlsCertificate_IsCfnResource(x interface{}) *bool
- func CfnLoadBalancerTlsCertificate_IsConstruct(x interface{}) *bool
- func CfnLoadBalancer_CFN_RESOURCE_TYPE_NAME() *string
- func CfnLoadBalancer_IsCfnElement(x interface{}) *bool
- func CfnLoadBalancer_IsCfnResource(x interface{}) *bool
- func CfnLoadBalancer_IsConstruct(x interface{}) *bool
- func CfnStaticIp_CFN_RESOURCE_TYPE_NAME() *string
- func CfnStaticIp_IsCfnElement(x interface{}) *bool
- func CfnStaticIp_IsCfnResource(x interface{}) *bool
- func CfnStaticIp_IsConstruct(x interface{}) *bool
- func NewCfnAlarm_Override(c CfnAlarm, scope constructs.Construct, id *string, props *CfnAlarmProps)
- func NewCfnBucket_Override(c CfnBucket, scope constructs.Construct, id *string, props *CfnBucketProps)
- func NewCfnCertificate_Override(c CfnCertificate, scope constructs.Construct, id *string, ...)
- func NewCfnContainer_Override(c CfnContainer, scope constructs.Construct, id *string, ...)
- func NewCfnDatabase_Override(c CfnDatabase, scope constructs.Construct, id *string, props *CfnDatabaseProps)
- func NewCfnDisk_Override(c CfnDisk, scope constructs.Construct, id *string, props *CfnDiskProps)
- func NewCfnDistribution_Override(c CfnDistribution, scope constructs.Construct, id *string, ...)
- func NewCfnInstance_Override(c CfnInstance, scope constructs.Construct, id *string, props *CfnInstanceProps)
- func NewCfnLoadBalancerTlsCertificate_Override(c CfnLoadBalancerTlsCertificate, scope constructs.Construct, id *string, ...)
- func NewCfnLoadBalancer_Override(c CfnLoadBalancer, scope constructs.Construct, id *string, ...)
- func NewCfnStaticIp_Override(c CfnStaticIp, scope constructs.Construct, id *string, props *CfnStaticIpProps)
- type CfnAlarm
- type CfnAlarmProps
- type CfnBucket
- type CfnBucketProps
- type CfnBucket_AccessRulesProperty
- type CfnCertificate
- type CfnCertificateProps
- type CfnContainer
- type CfnContainerProps
- type CfnContainer_ContainerProperty
- type CfnContainer_ContainerServiceDeploymentProperty
- type CfnContainer_EcrImagePullerRoleProperty
- type CfnContainer_EnvironmentVariableProperty
- type CfnContainer_HealthCheckConfigProperty
- type CfnContainer_PortInfoProperty
- type CfnContainer_PrivateRegistryAccessProperty
- type CfnContainer_PublicDomainNameProperty
- type CfnContainer_PublicEndpointProperty
- type CfnDatabase
- type CfnDatabaseProps
- type CfnDatabase_RelationalDatabaseParameterProperty
- type CfnDisk
- type CfnDiskProps
- type CfnDisk_AddOnProperty
- type CfnDisk_AutoSnapshotAddOnProperty
- type CfnDisk_LocationProperty
- type CfnDistribution
- type CfnDistributionProps
- type CfnDistribution_CacheBehaviorPerPathProperty
- type CfnDistribution_CacheBehaviorProperty
- type CfnDistribution_CacheSettingsProperty
- type CfnDistribution_CookieObjectProperty
- type CfnDistribution_HeaderObjectProperty
- type CfnDistribution_InputOriginProperty
- type CfnDistribution_QueryStringObjectProperty
- type CfnInstance
- type CfnInstanceProps
- type CfnInstance_AddOnProperty
- type CfnInstance_AutoSnapshotAddOnProperty
- type CfnInstance_DiskProperty
- type CfnInstance_HardwareProperty
- type CfnInstance_LocationProperty
- type CfnInstance_MonthlyTransferProperty
- type CfnInstance_NetworkingProperty
- type CfnInstance_PortProperty
- type CfnInstance_StateProperty
- type CfnLoadBalancer
- type CfnLoadBalancerProps
- type CfnLoadBalancerTlsCertificate
- type CfnLoadBalancerTlsCertificateProps
- type CfnStaticIp
- type CfnStaticIpProps
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnAlarm_CFN_RESOURCE_TYPE_NAME ¶ added in v2.9.0
func CfnAlarm_CFN_RESOURCE_TYPE_NAME() *string
func CfnAlarm_IsCfnElement ¶ added in v2.9.0
func CfnAlarm_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnAlarm_IsCfnResource ¶ added in v2.9.0
func CfnAlarm_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnAlarm_IsConstruct ¶ added in v2.9.0
func CfnAlarm_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 CfnBucket_CFN_RESOURCE_TYPE_NAME ¶ added in v2.9.0
func CfnBucket_CFN_RESOURCE_TYPE_NAME() *string
func CfnBucket_IsCfnElement ¶ added in v2.9.0
func CfnBucket_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnBucket_IsCfnResource ¶ added in v2.9.0
func CfnBucket_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnBucket_IsConstruct ¶ added in v2.9.0
func CfnBucket_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 CfnCertificate_CFN_RESOURCE_TYPE_NAME ¶ added in v2.10.0
func CfnCertificate_CFN_RESOURCE_TYPE_NAME() *string
func CfnCertificate_IsCfnElement ¶ added in v2.10.0
func CfnCertificate_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnCertificate_IsCfnResource ¶ added in v2.10.0
func CfnCertificate_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnCertificate_IsConstruct ¶ added in v2.10.0
func CfnCertificate_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 CfnContainer_CFN_RESOURCE_TYPE_NAME ¶ added in v2.10.0
func CfnContainer_CFN_RESOURCE_TYPE_NAME() *string
func CfnContainer_IsCfnElement ¶ added in v2.10.0
func CfnContainer_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnContainer_IsCfnResource ¶ added in v2.10.0
func CfnContainer_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnContainer_IsConstruct ¶ added in v2.10.0
func CfnContainer_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 CfnDatabase_CFN_RESOURCE_TYPE_NAME ¶
func CfnDatabase_CFN_RESOURCE_TYPE_NAME() *string
func CfnDatabase_IsCfnElement ¶
func CfnDatabase_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnDatabase_IsCfnResource ¶
func CfnDatabase_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnDatabase_IsConstruct ¶
func CfnDatabase_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 CfnDisk_CFN_RESOURCE_TYPE_NAME ¶
func CfnDisk_CFN_RESOURCE_TYPE_NAME() *string
func CfnDisk_IsCfnElement ¶
func CfnDisk_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnDisk_IsCfnResource ¶
func CfnDisk_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnDisk_IsConstruct ¶
func CfnDisk_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 CfnDistribution_CFN_RESOURCE_TYPE_NAME ¶ added in v2.10.0
func CfnDistribution_CFN_RESOURCE_TYPE_NAME() *string
func CfnDistribution_IsCfnElement ¶ added in v2.10.0
func CfnDistribution_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnDistribution_IsCfnResource ¶ added in v2.10.0
func CfnDistribution_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnDistribution_IsConstruct ¶ added in v2.10.0
func CfnDistribution_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 CfnInstance_CFN_RESOURCE_TYPE_NAME ¶
func CfnInstance_CFN_RESOURCE_TYPE_NAME() *string
func CfnInstance_IsCfnElement ¶
func CfnInstance_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnInstance_IsCfnResource ¶
func CfnInstance_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnInstance_IsConstruct ¶
func CfnInstance_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 CfnLoadBalancerTlsCertificate_CFN_RESOURCE_TYPE_NAME ¶ added in v2.9.0
func CfnLoadBalancerTlsCertificate_CFN_RESOURCE_TYPE_NAME() *string
func CfnLoadBalancerTlsCertificate_IsCfnElement ¶ added in v2.9.0
func CfnLoadBalancerTlsCertificate_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnLoadBalancerTlsCertificate_IsCfnResource ¶ added in v2.9.0
func CfnLoadBalancerTlsCertificate_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnLoadBalancerTlsCertificate_IsConstruct ¶ added in v2.9.0
func CfnLoadBalancerTlsCertificate_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 CfnLoadBalancer_CFN_RESOURCE_TYPE_NAME ¶ added in v2.9.0
func CfnLoadBalancer_CFN_RESOURCE_TYPE_NAME() *string
func CfnLoadBalancer_IsCfnElement ¶ added in v2.9.0
func CfnLoadBalancer_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnLoadBalancer_IsCfnResource ¶ added in v2.9.0
func CfnLoadBalancer_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnLoadBalancer_IsConstruct ¶ added in v2.9.0
func CfnLoadBalancer_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 CfnStaticIp_CFN_RESOURCE_TYPE_NAME ¶
func CfnStaticIp_CFN_RESOURCE_TYPE_NAME() *string
func CfnStaticIp_IsCfnElement ¶
func CfnStaticIp_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnStaticIp_IsCfnResource ¶
func CfnStaticIp_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnStaticIp_IsConstruct ¶
func CfnStaticIp_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 NewCfnAlarm_Override ¶ added in v2.9.0
func NewCfnAlarm_Override(c CfnAlarm, scope constructs.Construct, id *string, props *CfnAlarmProps)
func NewCfnBucket_Override ¶ added in v2.9.0
func NewCfnBucket_Override(c CfnBucket, scope constructs.Construct, id *string, props *CfnBucketProps)
func NewCfnCertificate_Override ¶ added in v2.10.0
func NewCfnCertificate_Override(c CfnCertificate, scope constructs.Construct, id *string, props *CfnCertificateProps)
func NewCfnContainer_Override ¶ added in v2.10.0
func NewCfnContainer_Override(c CfnContainer, scope constructs.Construct, id *string, props *CfnContainerProps)
func NewCfnDatabase_Override ¶
func NewCfnDatabase_Override(c CfnDatabase, scope constructs.Construct, id *string, props *CfnDatabaseProps)
func NewCfnDisk_Override ¶
func NewCfnDisk_Override(c CfnDisk, scope constructs.Construct, id *string, props *CfnDiskProps)
func NewCfnDistribution_Override ¶ added in v2.10.0
func NewCfnDistribution_Override(c CfnDistribution, scope constructs.Construct, id *string, props *CfnDistributionProps)
func NewCfnInstance_Override ¶
func NewCfnInstance_Override(c CfnInstance, scope constructs.Construct, id *string, props *CfnInstanceProps)
func NewCfnLoadBalancerTlsCertificate_Override ¶ added in v2.9.0
func NewCfnLoadBalancerTlsCertificate_Override(c CfnLoadBalancerTlsCertificate, scope constructs.Construct, id *string, props *CfnLoadBalancerTlsCertificateProps)
func NewCfnLoadBalancer_Override ¶ added in v2.9.0
func NewCfnLoadBalancer_Override(c CfnLoadBalancer, scope constructs.Construct, id *string, props *CfnLoadBalancerProps)
func NewCfnStaticIp_Override ¶
func NewCfnStaticIp_Override(c CfnStaticIp, scope constructs.Construct, id *string, props *CfnStaticIpProps)
Types ¶
type CfnAlarm ¶ added in v2.9.0
type CfnAlarm interface {
awscdk.CfnResource
awscdk.IInspectable
// The name of the alarm.
AlarmName() *string
SetAlarmName(val *string)
// The Amazon Resource Name (ARN) of the alarm.
AttrAlarmArn() *string
// The current state of the alarm.
//
// An alarm has the following possible states:
//
// - `ALARM` - The metric is outside of the defined threshold.
// - `INSUFFICIENT_DATA` - The alarm has recently started, the metric is not available, or not enough data is available for the metric to determine the alarm state.
// - `OK` - The metric is within the defined threshold.
AttrState() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// The arithmetic operation to use when comparing the specified statistic and threshold.
ComparisonOperator() *string
SetComparisonOperator(val *string)
// The contact protocols for the alarm, such as `Email` , `SMS` (text messaging), or both.
ContactProtocols() *[]*string
SetContactProtocols(val *[]*string)
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
// The number of data points within the evaluation periods that must be breaching to cause the alarm to go to the `ALARM` state.
DatapointsToAlarm() *float64
SetDatapointsToAlarm(val *float64)
// The number of periods over which data is compared to the specified threshold.
EvaluationPeriods() *float64
SetEvaluationPeriods(val *float64)
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The name of the metric associated with the alarm.
MetricName() *string
SetMetricName(val *string)
// The name of the Lightsail resource that the alarm monitors.
MonitoredResourceName() *string
SetMonitoredResourceName(val *string)
// The tree node.
Node() constructs.Node
// A Boolean value indicating whether the alarm is enabled.
NotificationEnabled() interface{}
SetNotificationEnabled(val interface{})
// The alarm states that trigger a notification.
NotificationTriggers() *[]*string
SetNotificationTriggers(val *[]*string)
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// The value against which the specified statistic is compared.
Threshold() *float64
SetThreshold(val *float64)
// Specifies how the alarm handles missing data points.
TreatMissingData() *string
SetTreatMissingData(val *string)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// 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`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
The `AWS::Lightsail::Alarm` resource specifies an alarm that can be used to monitor a single metric for one of your Lightsail resources.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnAlarm := awscdk.Aws_lightsail.NewCfnAlarm(this, jsii.String("MyCfnAlarm"), &CfnAlarmProps{
AlarmName: jsii.String("alarmName"),
ComparisonOperator: jsii.String("comparisonOperator"),
EvaluationPeriods: jsii.Number(123),
MetricName: jsii.String("metricName"),
MonitoredResourceName: jsii.String("monitoredResourceName"),
Threshold: jsii.Number(123),
// the properties below are optional
ContactProtocols: []*string{
jsii.String("contactProtocols"),
},
DatapointsToAlarm: jsii.Number(123),
NotificationEnabled: jsii.Boolean(false),
NotificationTriggers: []*string{
jsii.String("notificationTriggers"),
},
TreatMissingData: jsii.String("treatMissingData"),
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-alarm.html
func NewCfnAlarm ¶ added in v2.9.0
func NewCfnAlarm(scope constructs.Construct, id *string, props *CfnAlarmProps) CfnAlarm
type CfnAlarmProps ¶ added in v2.9.0
type CfnAlarmProps struct {
// The name of the alarm.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-alarm.html#cfn-lightsail-alarm-alarmname
//
AlarmName *string `field:"required" json:"alarmName" yaml:"alarmName"`
// The arithmetic operation to use when comparing the specified statistic and threshold.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-alarm.html#cfn-lightsail-alarm-comparisonoperator
//
ComparisonOperator *string `field:"required" json:"comparisonOperator" yaml:"comparisonOperator"`
// The number of periods over which data is compared to the specified threshold.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-alarm.html#cfn-lightsail-alarm-evaluationperiods
//
EvaluationPeriods *float64 `field:"required" json:"evaluationPeriods" yaml:"evaluationPeriods"`
// The name of the metric associated with the alarm.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-alarm.html#cfn-lightsail-alarm-metricname
//
MetricName *string `field:"required" json:"metricName" yaml:"metricName"`
// The name of the Lightsail resource that the alarm monitors.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-alarm.html#cfn-lightsail-alarm-monitoredresourcename
//
MonitoredResourceName *string `field:"required" json:"monitoredResourceName" yaml:"monitoredResourceName"`
// The value against which the specified statistic is compared.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-alarm.html#cfn-lightsail-alarm-threshold
//
Threshold *float64 `field:"required" json:"threshold" yaml:"threshold"`
// The contact protocols for the alarm, such as `Email` , `SMS` (text messaging), or both.
//
// *Allowed Values* : `Email` | `SMS`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-alarm.html#cfn-lightsail-alarm-contactprotocols
//
ContactProtocols *[]*string `field:"optional" json:"contactProtocols" yaml:"contactProtocols"`
// The number of data points within the evaluation periods that must be breaching to cause the alarm to go to the `ALARM` state.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-alarm.html#cfn-lightsail-alarm-datapointstoalarm
//
DatapointsToAlarm *float64 `field:"optional" json:"datapointsToAlarm" yaml:"datapointsToAlarm"`
// A Boolean value indicating whether the alarm is enabled.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-alarm.html#cfn-lightsail-alarm-notificationenabled
//
NotificationEnabled interface{} `field:"optional" json:"notificationEnabled" yaml:"notificationEnabled"`
// The alarm states that trigger a notification.
//
// > To specify the `OK` and `INSUFFICIENT_DATA` values, you must also specify `ContactProtocols` values. Otherwise, the `OK` and `INSUFFICIENT_DATA` values will not take effect and the stack will drift.
//
// *Allowed Values* : `OK` | `ALARM` | `INSUFFICIENT_DATA`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-alarm.html#cfn-lightsail-alarm-notificationtriggers
//
NotificationTriggers *[]*string `field:"optional" json:"notificationTriggers" yaml:"notificationTriggers"`
// Specifies how the alarm handles missing data points.
//
// An alarm can treat missing data in the following ways:
//
// - `breaching` - Assumes the missing data is not within the threshold. Missing data counts towards the number of times that the metric is not within the threshold.
// - `notBreaching` - Assumes the missing data is within the threshold. Missing data does not count towards the number of times that the metric is not within the threshold.
// - `ignore` - Ignores the missing data. Maintains the current alarm state.
// - `missing` - Missing data is treated as missing.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-alarm.html#cfn-lightsail-alarm-treatmissingdata
//
TreatMissingData *string `field:"optional" json:"treatMissingData" yaml:"treatMissingData"`
}
Properties for defining a `CfnAlarm`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnAlarmProps := &CfnAlarmProps{
AlarmName: jsii.String("alarmName"),
ComparisonOperator: jsii.String("comparisonOperator"),
EvaluationPeriods: jsii.Number(123),
MetricName: jsii.String("metricName"),
MonitoredResourceName: jsii.String("monitoredResourceName"),
Threshold: jsii.Number(123),
// the properties below are optional
ContactProtocols: []*string{
jsii.String("contactProtocols"),
},
DatapointsToAlarm: jsii.Number(123),
NotificationEnabled: jsii.Boolean(false),
NotificationTriggers: []*string{
jsii.String("notificationTriggers"),
},
TreatMissingData: jsii.String("treatMissingData"),
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-alarm.html
type CfnBucket ¶ added in v2.9.0
type CfnBucket interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggable
// An object that describes the access rules for the bucket.
AccessRules() interface{}
SetAccessRules(val interface{})
// A Boolean value indicating whether the bundle that is currently applied to your distribution can be changed to another bundle.
AttrAbleToUpdateBundle() awscdk.IResolvable
// The Amazon Resource Name (ARN) of the bucket.
AttrBucketArn() *string
// The URL of the bucket.
AttrUrl() *string
// The name of the bucket.
BucketName() *string
SetBucketName(val *string)
// The bundle ID for the bucket (for example, `small_1_0` ).
BundleId() *string
SetBundleId(val *string)
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The tree node.
Node() constructs.Node
// Indicates whether object versioning is enabled for the bucket.
ObjectVersioning() interface{}
SetObjectVersioning(val interface{})
// An array of AWS account IDs that have read-only access to the bucket.
ReadOnlyAccessAccounts() *[]*string
SetReadOnlyAccessAccounts(val *[]*string)
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
Ref() *string
// An array of Lightsail instances that have access to the bucket.
ResourcesReceivingAccess() *[]*string
SetResourcesReceivingAccess(val *[]*string)
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
// An array of key-value pairs to apply to this resource.
TagsRaw() *[]*awscdk.CfnTag
SetTagsRaw(val *[]*awscdk.CfnTag)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// 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`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
The `AWS::Lightsail::Bucket` resource specifies a bucket.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnBucket := awscdk.Aws_lightsail.NewCfnBucket(this, jsii.String("MyCfnBucket"), &CfnBucketProps{
BucketName: jsii.String("bucketName"),
BundleId: jsii.String("bundleId"),
// the properties below are optional
AccessRules: &AccessRulesProperty{
AllowPublicOverrides: jsii.Boolean(false),
ObjectAccess: jsii.String("objectAccess"),
},
ObjectVersioning: jsii.Boolean(false),
ReadOnlyAccessAccounts: []*string{
jsii.String("readOnlyAccessAccounts"),
},
ResourcesReceivingAccess: []*string{
jsii.String("resourcesReceivingAccess"),
},
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-bucket.html
func NewCfnBucket ¶ added in v2.9.0
func NewCfnBucket(scope constructs.Construct, id *string, props *CfnBucketProps) CfnBucket
type CfnBucketProps ¶ added in v2.9.0
type CfnBucketProps struct {
// The name of the bucket.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-bucket.html#cfn-lightsail-bucket-bucketname
//
BucketName *string `field:"required" json:"bucketName" yaml:"bucketName"`
// The bundle ID for the bucket (for example, `small_1_0` ).
//
// A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-bucket.html#cfn-lightsail-bucket-bundleid
//
BundleId *string `field:"required" json:"bundleId" yaml:"bundleId"`
// An object that describes the access rules for the bucket.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-bucket.html#cfn-lightsail-bucket-accessrules
//
AccessRules interface{} `field:"optional" json:"accessRules" yaml:"accessRules"`
// Indicates whether object versioning is enabled for the bucket.
//
// The following options can be configured:
//
// - `Enabled` - Object versioning is enabled.
// - `Suspended` - Object versioning was previously enabled but is currently suspended. Existing object versions are retained.
// - `NeverEnabled` - Object versioning has never been enabled.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-bucket.html#cfn-lightsail-bucket-objectversioning
//
ObjectVersioning interface{} `field:"optional" json:"objectVersioning" yaml:"objectVersioning"`
// An array of AWS account IDs that have read-only access to the bucket.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-bucket.html#cfn-lightsail-bucket-readonlyaccessaccounts
//
ReadOnlyAccessAccounts *[]*string `field:"optional" json:"readOnlyAccessAccounts" yaml:"readOnlyAccessAccounts"`
// An array of Lightsail instances that have access to the bucket.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-bucket.html#cfn-lightsail-bucket-resourcesreceivingaccess
//
ResourcesReceivingAccess *[]*string `field:"optional" json:"resourcesReceivingAccess" yaml:"resourcesReceivingAccess"`
// An array of key-value pairs to apply to this resource.
//
// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) in the *AWS CloudFormation User Guide* .
//
// > The `Value` of `Tags` is optional for Lightsail resources.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-bucket.html#cfn-lightsail-bucket-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnBucket`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnBucketProps := &CfnBucketProps{
BucketName: jsii.String("bucketName"),
BundleId: jsii.String("bundleId"),
// the properties below are optional
AccessRules: &AccessRulesProperty{
AllowPublicOverrides: jsii.Boolean(false),
ObjectAccess: jsii.String("objectAccess"),
},
ObjectVersioning: jsii.Boolean(false),
ReadOnlyAccessAccounts: []*string{
jsii.String("readOnlyAccessAccounts"),
},
ResourcesReceivingAccess: []*string{
jsii.String("resourcesReceivingAccess"),
},
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-bucket.html
type CfnBucket_AccessRulesProperty ¶ added in v2.9.0
type CfnBucket_AccessRulesProperty struct {
// A Boolean value indicating whether the access control list (ACL) permissions that are applied to individual objects override the `GetObject` option that is currently specified.
//
// When this is true, you can use the [PutObjectAcl](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObjectAcl.html) Amazon S3 API operation to set individual objects to public (read-only) or private, using either the `public-read` ACL or the `private` ACL.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-bucket-accessrules.html#cfn-lightsail-bucket-accessrules-allowpublicoverrides
//
AllowPublicOverrides interface{} `field:"optional" json:"allowPublicOverrides" yaml:"allowPublicOverrides"`
// Specifies the anonymous access to all objects in a bucket.
//
// The following options can be specified:
//
// - `public` - Sets all objects in the bucket to public (read-only), making them readable by everyone on the internet.
//
// If the `GetObject` value is set to `public` , then all objects in the bucket default to public regardless of the `allowPublicOverrides` value.
// - `private` - Sets all objects in the bucket to private, making them readable only by you and anyone that you grant access to.
//
// If the `GetObject` value is set to `private` , and the `allowPublicOverrides` value is set to `true` , then all objects in the bucket default to private unless they are configured with a `public-read` ACL. Individual objects with a `public-read` ACL are readable by everyone on the internet.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-bucket-accessrules.html#cfn-lightsail-bucket-accessrules-getobject
//
ObjectAccess *string `field:"optional" json:"objectAccess" yaml:"objectAccess"`
}
`AccessRules` is a property of the [AWS::Lightsail::Bucket](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-bucket.html) resource. It describes access rules for a bucket.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
accessRulesProperty := &AccessRulesProperty{
AllowPublicOverrides: jsii.Boolean(false),
ObjectAccess: jsii.String("objectAccess"),
}
type CfnCertificate ¶ added in v2.10.0
type CfnCertificate interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggable
// The Amazon Resource Name (ARN) of the certificate.
AttrCertificateArn() *string
// The validation status of the certificate.
AttrStatus() *string
// The name of the certificate.
CertificateName() *string
SetCertificateName(val *string)
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
// The domain name of the certificate.
DomainName() *string
SetDomainName(val *string)
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The tree node.
Node() constructs.Node
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// An array of strings that specify the alternate domains (such as `example.org` ) and subdomains (such as `blog.example.com` ) of the certificate.
SubjectAlternativeNames() *[]*string
SetSubjectAlternativeNames(val *[]*string)
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
// An array of key-value pairs to apply to this resource.
TagsRaw() *[]*awscdk.CfnTag
SetTagsRaw(val *[]*awscdk.CfnTag)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// 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`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
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.
> For information about certificates that you can use with a load balancer, see [AWS::Lightsail::LoadBalancerTlsCertificate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-loadbalancertlscertificate.html) .
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnCertificate := awscdk.Aws_lightsail.NewCfnCertificate(this, jsii.String("MyCfnCertificate"), &CfnCertificateProps{
CertificateName: jsii.String("certificateName"),
DomainName: jsii.String("domainName"),
// the properties below are optional
SubjectAlternativeNames: []*string{
jsii.String("subjectAlternativeNames"),
},
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
func NewCfnCertificate ¶ added in v2.10.0
func NewCfnCertificate(scope constructs.Construct, id *string, props *CfnCertificateProps) CfnCertificate
type CfnCertificateProps ¶ added in v2.10.0
type CfnCertificateProps struct {
// The name of the certificate.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-certificate.html#cfn-lightsail-certificate-certificatename
//
CertificateName *string `field:"required" json:"certificateName" yaml:"certificateName"`
// The domain name of the certificate.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-certificate.html#cfn-lightsail-certificate-domainname
//
DomainName *string `field:"required" json:"domainName" yaml:"domainName"`
// An array of strings that specify the alternate domains (such as `example.org` ) and subdomains (such as `blog.example.com` ) of the certificate.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-certificate.html#cfn-lightsail-certificate-subjectalternativenames
//
SubjectAlternativeNames *[]*string `field:"optional" json:"subjectAlternativeNames" yaml:"subjectAlternativeNames"`
// An array of key-value pairs to apply to this resource.
//
// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) in the *AWS CloudFormation User Guide* .
//
// > The `Value` of `Tags` is optional for Lightsail resources.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-certificate.html#cfn-lightsail-certificate-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnCertificate`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnCertificateProps := &CfnCertificateProps{
CertificateName: jsii.String("certificateName"),
DomainName: jsii.String("domainName"),
// the properties below are optional
SubjectAlternativeNames: []*string{
jsii.String("subjectAlternativeNames"),
},
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
type CfnContainer ¶ added in v2.10.0
type CfnContainer interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggable
// The Amazon Resource Name (ARN) of the container.
AttrContainerArn() *string
// The principle Amazon Resource Name (ARN) of the role.
AttrPrincipalArn() *string
// The principle Amazon Resource Name (ARN) of the role.
AttrPrivateRegistryAccessEcrImagePullerRolePrincipalArn() *string
// The publicly accessible URL of the container service.
//
// If no public endpoint is specified in the current deployment, this URL returns a 404 response.
AttrUrl() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// An object that describes the current container deployment of the container service.
ContainerServiceDeployment() interface{}
SetContainerServiceDeployment(val interface{})
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
// A Boolean value indicating whether the container service is disabled.
IsDisabled() interface{}
SetIsDisabled(val interface{})
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The tree node.
Node() constructs.Node
// The power specification of the container service.
Power() *string
SetPower(val *string)
// An object that describes the configuration for the container service to access private container image repositories, such as Amazon Elastic Container Registry ( Amazon ECR ) private repositories.
PrivateRegistryAccess() interface{}
SetPrivateRegistryAccess(val interface{})
// The public domain name of the container service, such as `example.com` and `www.example.com` .
PublicDomainNames() interface{}
SetPublicDomainNames(val interface{})
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
Ref() *string
// The scale specification of the container service.
Scale() *float64
SetScale(val *float64)
// The name of the container service.
ServiceName() *string
SetServiceName(val *string)
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
// An array of key-value pairs to apply to this resource.
TagsRaw() *[]*awscdk.CfnTag
SetTagsRaw(val *[]*awscdk.CfnTag)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// 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`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
The `AWS::Lightsail::Container` resource specifies a container service.
A Lightsail container service is a compute resource to which you can deploy containers.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnContainer := awscdk.Aws_lightsail.NewCfnContainer(this, jsii.String("MyCfnContainer"), &CfnContainerProps{
Power: jsii.String("power"),
Scale: jsii.Number(123),
ServiceName: jsii.String("serviceName"),
// the properties below are optional
ContainerServiceDeployment: &ContainerServiceDeploymentProperty{
Containers: []interface{}{
&ContainerProperty{
Command: []*string{
jsii.String("command"),
},
ContainerName: jsii.String("containerName"),
Environment: []interface{}{
&EnvironmentVariableProperty{
Value: jsii.String("value"),
Variable: jsii.String("variable"),
},
},
Image: jsii.String("image"),
Ports: []interface{}{
&PortInfoProperty{
Port: jsii.String("port"),
Protocol: jsii.String("protocol"),
},
},
},
},
PublicEndpoint: &PublicEndpointProperty{
ContainerName: jsii.String("containerName"),
ContainerPort: jsii.Number(123),
HealthCheckConfig: &HealthCheckConfigProperty{
HealthyThreshold: jsii.Number(123),
IntervalSeconds: jsii.Number(123),
Path: jsii.String("path"),
SuccessCodes: jsii.String("successCodes"),
TimeoutSeconds: jsii.Number(123),
UnhealthyThreshold: jsii.Number(123),
},
},
},
IsDisabled: jsii.Boolean(false),
PrivateRegistryAccess: &PrivateRegistryAccessProperty{
EcrImagePullerRole: &EcrImagePullerRoleProperty{
IsActive: jsii.Boolean(false),
PrincipalArn: jsii.String("principalArn"),
},
},
PublicDomainNames: []interface{}{
&PublicDomainNameProperty{
CertificateName: jsii.String("certificateName"),
DomainNames: []*string{
jsii.String("domainNames"),
},
},
},
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-container.html
func NewCfnContainer ¶ added in v2.10.0
func NewCfnContainer(scope constructs.Construct, id *string, props *CfnContainerProps) CfnContainer
type CfnContainerProps ¶ added in v2.10.0
type CfnContainerProps struct {
// The power specification of the container service.
//
// The power specifies the amount of RAM, the number of vCPUs, and the base price of the container service.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-container.html#cfn-lightsail-container-power
//
Power *string `field:"required" json:"power" yaml:"power"`
// The scale specification of the container service.
//
// The scale specifies the allocated compute nodes of the container service.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-container.html#cfn-lightsail-container-scale
//
Scale *float64 `field:"required" json:"scale" yaml:"scale"`
// The name of the container service.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-container.html#cfn-lightsail-container-servicename
//
ServiceName *string `field:"required" json:"serviceName" yaml:"serviceName"`
// An object that describes the current container deployment of the container service.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-container.html#cfn-lightsail-container-containerservicedeployment
//
ContainerServiceDeployment interface{} `field:"optional" json:"containerServiceDeployment" yaml:"containerServiceDeployment"`
// A Boolean value indicating whether the container service is disabled.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-container.html#cfn-lightsail-container-isdisabled
//
IsDisabled interface{} `field:"optional" json:"isDisabled" yaml:"isDisabled"`
// An object that describes the configuration for the container service to access private container image repositories, such as Amazon Elastic Container Registry ( Amazon ECR ) private repositories.
//
// For more information, see [Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-container-service-ecr-private-repo-access) in the *Amazon Lightsail Developer Guide* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-container.html#cfn-lightsail-container-privateregistryaccess
//
PrivateRegistryAccess interface{} `field:"optional" json:"privateRegistryAccess" yaml:"privateRegistryAccess"`
// The public domain name of the container service, such as `example.com` and `www.example.com` .
//
// You can specify up to four public domain names for a container service. The domain names that you specify are used when you create a deployment with a container that is configured as the public endpoint of your container service.
//
// If you don't specify public domain names, then you can use the default domain of the container service.
//
// > You must create and validate an SSL/TLS certificate before you can use public domain names with your container service. Use the [AWS::Lightsail::Certificate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-certificate.html) resource to create a certificate for the public domain names that you want to use with your container service.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-container.html#cfn-lightsail-container-publicdomainnames
//
PublicDomainNames interface{} `field:"optional" json:"publicDomainNames" yaml:"publicDomainNames"`
// An array of key-value pairs to apply to this resource.
//
// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) in the *AWS CloudFormation User Guide* .
//
// > The `Value` of `Tags` is optional for Lightsail resources.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-container.html#cfn-lightsail-container-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnContainer`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnContainerProps := &CfnContainerProps{
Power: jsii.String("power"),
Scale: jsii.Number(123),
ServiceName: jsii.String("serviceName"),
// the properties below are optional
ContainerServiceDeployment: &ContainerServiceDeploymentProperty{
Containers: []interface{}{
&ContainerProperty{
Command: []*string{
jsii.String("command"),
},
ContainerName: jsii.String("containerName"),
Environment: []interface{}{
&EnvironmentVariableProperty{
Value: jsii.String("value"),
Variable: jsii.String("variable"),
},
},
Image: jsii.String("image"),
Ports: []interface{}{
&PortInfoProperty{
Port: jsii.String("port"),
Protocol: jsii.String("protocol"),
},
},
},
},
PublicEndpoint: &PublicEndpointProperty{
ContainerName: jsii.String("containerName"),
ContainerPort: jsii.Number(123),
HealthCheckConfig: &HealthCheckConfigProperty{
HealthyThreshold: jsii.Number(123),
IntervalSeconds: jsii.Number(123),
Path: jsii.String("path"),
SuccessCodes: jsii.String("successCodes"),
TimeoutSeconds: jsii.Number(123),
UnhealthyThreshold: jsii.Number(123),
},
},
},
IsDisabled: jsii.Boolean(false),
PrivateRegistryAccess: &PrivateRegistryAccessProperty{
EcrImagePullerRole: &EcrImagePullerRoleProperty{
IsActive: jsii.Boolean(false),
PrincipalArn: jsii.String("principalArn"),
},
},
PublicDomainNames: []interface{}{
&PublicDomainNameProperty{
CertificateName: jsii.String("certificateName"),
DomainNames: []*string{
jsii.String("domainNames"),
},
},
},
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-container.html
type CfnContainer_ContainerProperty ¶ added in v2.10.0
type CfnContainer_ContainerProperty struct {
// The launch command for the container.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-container-container.html#cfn-lightsail-container-container-command
//
Command *[]*string `field:"optional" json:"command" yaml:"command"`
// The name of the container.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-container-container.html#cfn-lightsail-container-container-containername
//
ContainerName *string `field:"optional" json:"containerName" yaml:"containerName"`
// The environment variables of the container.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-container-container.html#cfn-lightsail-container-container-environment
//
Environment interface{} `field:"optional" json:"environment" yaml:"environment"`
// The name of the image used for the container.
//
// Container images that are sourced from (registered and stored on) your container service start with a colon ( `:` ). For example, if your container service name is `container-service-1` , the container image label is `mystaticsite` , and you want to use the third version ( `3` ) of the registered container image, then you should specify `:container-service-1.mystaticsite.3` . To use the latest version of a container image, specify `latest` instead of a version number (for example, `:container-service-1.mystaticsite.latest` ). Your container service will automatically use the highest numbered version of the registered container image.
//
// Container images that are sourced from a public registry like Docker Hub don’t start with a colon. For example, `nginx:latest` or `nginx` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-container-container.html#cfn-lightsail-container-container-image
//
Image *string `field:"optional" json:"image" yaml:"image"`
// An object that describes the open firewall ports and protocols of the container.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-container-container.html#cfn-lightsail-container-container-ports
//
Ports interface{} `field:"optional" json:"ports" yaml:"ports"`
}
`Container` is a property of the [ContainerServiceDeployment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-container-containerservicedeployment.html) property. It describes the settings of a container that will be launched, or that is launched, to an Amazon Lightsail container service.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
containerProperty := &ContainerProperty{
Command: []*string{
jsii.String("command"),
},
ContainerName: jsii.String("containerName"),
Environment: []interface{}{
&EnvironmentVariableProperty{
Value: jsii.String("value"),
Variable: jsii.String("variable"),
},
},
Image: jsii.String("image"),
Ports: []interface{}{
&PortInfoProperty{
Port: jsii.String("port"),
Protocol: jsii.String("protocol"),
},
},
}
type CfnContainer_ContainerServiceDeploymentProperty ¶ added in v2.10.0
type CfnContainer_ContainerServiceDeploymentProperty struct {
// An object that describes the configuration for the containers of the deployment.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-container-containerservicedeployment.html#cfn-lightsail-container-containerservicedeployment-containers
//
Containers interface{} `field:"optional" json:"containers" yaml:"containers"`
// An object that describes the endpoint of the deployment.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-container-containerservicedeployment.html#cfn-lightsail-container-containerservicedeployment-publicendpoint
//
PublicEndpoint interface{} `field:"optional" json:"publicEndpoint" yaml:"publicEndpoint"`
}
`ContainerServiceDeployment` is a property of the [AWS::Lightsail::Container](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-container.html) resource. It describes a container deployment configuration of a container service.
A deployment specifies the settings, such as the ports and launch command, of containers that are deployed to your container service.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
containerServiceDeploymentProperty := &ContainerServiceDeploymentProperty{
Containers: []interface{}{
&ContainerProperty{
Command: []*string{
jsii.String("command"),
},
ContainerName: jsii.String("containerName"),
Environment: []interface{}{
&EnvironmentVariableProperty{
Value: jsii.String("value"),
Variable: jsii.String("variable"),
},
},
Image: jsii.String("image"),
Ports: []interface{}{
&PortInfoProperty{
Port: jsii.String("port"),
Protocol: jsii.String("protocol"),
},
},
},
},
PublicEndpoint: &PublicEndpointProperty{
ContainerName: jsii.String("containerName"),
ContainerPort: jsii.Number(123),
HealthCheckConfig: &HealthCheckConfigProperty{
HealthyThreshold: jsii.Number(123),
IntervalSeconds: jsii.Number(123),
Path: jsii.String("path"),
SuccessCodes: jsii.String("successCodes"),
TimeoutSeconds: jsii.Number(123),
UnhealthyThreshold: jsii.Number(123),
},
},
}
type CfnContainer_EcrImagePullerRoleProperty ¶ added in v2.97.0
type CfnContainer_EcrImagePullerRoleProperty struct {
// A boolean value that indicates whether the `ECRImagePullerRole` is active.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-container-ecrimagepullerrole.html#cfn-lightsail-container-ecrimagepullerrole-isactive
//
IsActive interface{} `field:"optional" json:"isActive" yaml:"isActive"`
// The principle Amazon Resource Name (ARN) of the role.
//
// This property is read-only.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-container-ecrimagepullerrole.html#cfn-lightsail-container-ecrimagepullerrole-principalarn
//
PrincipalArn *string `field:"optional" json:"principalArn" yaml:"principalArn"`
}
Describes the IAM role that you can use to grant a Lightsail container service access to Amazon ECR private repositories.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
ecrImagePullerRoleProperty := &EcrImagePullerRoleProperty{
IsActive: jsii.Boolean(false),
PrincipalArn: jsii.String("principalArn"),
}
type CfnContainer_EnvironmentVariableProperty ¶ added in v2.10.0
type CfnContainer_EnvironmentVariableProperty struct {
// The environment variable value.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-container-environmentvariable.html#cfn-lightsail-container-environmentvariable-value
//
Value *string `field:"optional" json:"value" yaml:"value"`
// The environment variable key.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-container-environmentvariable.html#cfn-lightsail-container-environmentvariable-variable
//
Variable *string `field:"optional" json:"variable" yaml:"variable"`
}
`EnvironmentVariable` is a property of the [Container](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-container-container.html) 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.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
environmentVariableProperty := &EnvironmentVariableProperty{
Value: jsii.String("value"),
Variable: jsii.String("variable"),
}
type CfnContainer_HealthCheckConfigProperty ¶ added in v2.10.0
type CfnContainer_HealthCheckConfigProperty struct {
// The number of consecutive health check successes required before moving the container to the `Healthy` state.
//
// The default value is `2` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-container-healthcheckconfig.html#cfn-lightsail-container-healthcheckconfig-healthythreshold
//
HealthyThreshold *float64 `field:"optional" json:"healthyThreshold" yaml:"healthyThreshold"`
// The approximate interval, in seconds, between health checks of an individual container.
//
// You can specify between `5` and `300` seconds. The default value is `5` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-container-healthcheckconfig.html#cfn-lightsail-container-healthcheckconfig-intervalseconds
//
IntervalSeconds *float64 `field:"optional" json:"intervalSeconds" yaml:"intervalSeconds"`
// The path on the container on which to perform the health check.
//
// The default value is `/` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-container-healthcheckconfig.html#cfn-lightsail-container-healthcheckconfig-path
//
Path *string `field:"optional" json:"path" yaml:"path"`
// The HTTP codes to use when checking for a successful response from a container.
//
// You can specify values between `200` and `499` . You can specify multiple values (for example, `200,202` ) or a range of values (for example, `200-299` ).
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-container-healthcheckconfig.html#cfn-lightsail-container-healthcheckconfig-successcodes
//
SuccessCodes *string `field:"optional" json:"successCodes" yaml:"successCodes"`
// The amount of time, in seconds, during which no response means a failed health check.
//
// You can specify between `2` and `60` seconds. The default value is `2` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-container-healthcheckconfig.html#cfn-lightsail-container-healthcheckconfig-timeoutseconds
//
TimeoutSeconds *float64 `field:"optional" json:"timeoutSeconds" yaml:"timeoutSeconds"`
// The number of consecutive health check failures required before moving the container to the `Unhealthy` state.
//
// The default value is `2` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-container-healthcheckconfig.html#cfn-lightsail-container-healthcheckconfig-unhealthythreshold
//
UnhealthyThreshold *float64 `field:"optional" json:"unhealthyThreshold" yaml:"unhealthyThreshold"`
}
`HealthCheckConfig` is a property of the [PublicEndpoint](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-container-publicendpoint.html) property. It describes the healthcheck configuration of a container deployment on a container service.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
healthCheckConfigProperty := &HealthCheckConfigProperty{
HealthyThreshold: jsii.Number(123),
IntervalSeconds: jsii.Number(123),
Path: jsii.String("path"),
SuccessCodes: jsii.String("successCodes"),
TimeoutSeconds: jsii.Number(123),
UnhealthyThreshold: jsii.Number(123),
}
type CfnContainer_PortInfoProperty ¶ added in v2.10.0
type CfnContainer_PortInfoProperty struct {
// The open firewall ports of the container.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-container-portinfo.html#cfn-lightsail-container-portinfo-port
//
Port *string `field:"optional" json:"port" yaml:"port"`
// The protocol name for the open ports.
//
// *Allowed values* : `HTTP` | `HTTPS` | `TCP` | `UDP`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-container-portinfo.html#cfn-lightsail-container-portinfo-protocol
//
Protocol *string `field:"optional" json:"protocol" yaml:"protocol"`
}
`PortInfo` is a property of the [Container](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-container-container.html) property. It describes the ports to open and the protocols to use for a container on a Amazon Lightsail container service.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
portInfoProperty := &PortInfoProperty{
Port: jsii.String("port"),
Protocol: jsii.String("protocol"),
}
type CfnContainer_PrivateRegistryAccessProperty ¶ added in v2.97.0
type CfnContainer_PrivateRegistryAccessProperty struct {
// An object that describes the activation status of the role that you can use to grant a Lightsail container service access to Amazon ECR private repositories.
//
// If the role is activated, the Amazon Resource Name (ARN) of the role is also listed.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-container-privateregistryaccess.html#cfn-lightsail-container-privateregistryaccess-ecrimagepullerrole
//
EcrImagePullerRole interface{} `field:"optional" json:"ecrImagePullerRole" yaml:"ecrImagePullerRole"`
}
Describes the configuration for an Amazon Lightsail container service to access private container image repositories, such as Amazon Elastic Container Registry ( Amazon ECR ) private repositories.
For more information, see [Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-container-service-ecr-private-repo-access) in the *Amazon Lightsail Developer Guide* .
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
privateRegistryAccessProperty := &PrivateRegistryAccessProperty{
EcrImagePullerRole: &EcrImagePullerRoleProperty{
IsActive: jsii.Boolean(false),
PrincipalArn: jsii.String("principalArn"),
},
}
type CfnContainer_PublicDomainNameProperty ¶ added in v2.10.0
type CfnContainer_PublicDomainNameProperty struct {
// The name of the certificate for the public domains.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-container-publicdomainname.html#cfn-lightsail-container-publicdomainname-certificatename
//
CertificateName *string `field:"optional" json:"certificateName" yaml:"certificateName"`
// The public domain names to use with the container service.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-container-publicdomainname.html#cfn-lightsail-container-publicdomainname-domainnames
//
DomainNames *[]*string `field:"optional" json:"domainNames" yaml:"domainNames"`
}
`PublicDomainName` is a property of the [AWS::Lightsail::Container](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-container.html) 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.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
publicDomainNameProperty := &PublicDomainNameProperty{
CertificateName: jsii.String("certificateName"),
DomainNames: []*string{
jsii.String("domainNames"),
},
}
type CfnContainer_PublicEndpointProperty ¶ added in v2.10.0
type CfnContainer_PublicEndpointProperty struct {
// The name of the container entry of the deployment that the endpoint configuration applies to.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-container-publicendpoint.html#cfn-lightsail-container-publicendpoint-containername
//
ContainerName *string `field:"optional" json:"containerName" yaml:"containerName"`
// The port of the specified container to which traffic is forwarded to.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-container-publicendpoint.html#cfn-lightsail-container-publicendpoint-containerport
//
ContainerPort *float64 `field:"optional" json:"containerPort" yaml:"containerPort"`
// An object that describes the health check configuration of the container.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-container-publicendpoint.html#cfn-lightsail-container-publicendpoint-healthcheckconfig
//
HealthCheckConfig interface{} `field:"optional" json:"healthCheckConfig" yaml:"healthCheckConfig"`
}
`PublicEndpoint` is a property of the [ContainerServiceDeployment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-container-containerservicedeployment.html) property. It describes describes the settings of the public endpoint of a container on a container service.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
publicEndpointProperty := &PublicEndpointProperty{
ContainerName: jsii.String("containerName"),
ContainerPort: jsii.Number(123),
HealthCheckConfig: &HealthCheckConfigProperty{
HealthyThreshold: jsii.Number(123),
IntervalSeconds: jsii.Number(123),
Path: jsii.String("path"),
SuccessCodes: jsii.String("successCodes"),
TimeoutSeconds: jsii.Number(123),
UnhealthyThreshold: jsii.Number(123),
},
}
type CfnDatabase ¶
type CfnDatabase interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggable
// The Amazon Resource Name (ARN) of the database (for example, `arn:aws:lightsail:us-east-2:123456789101:RelationalDatabase/244ad76f-8aad-4741-809f-12345EXAMPLE` ).
AttrDatabaseArn() *string
// The Availability Zone for the database.
AvailabilityZone() *string
SetAvailabilityZone(val *string)
// A Boolean value indicating whether automated backup retention is enabled for the database.
BackupRetention() interface{}
SetBackupRetention(val interface{})
// The certificate associated with the database.
CaCertificateIdentifier() *string
SetCaCertificateIdentifier(val *string)
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The meaning of this parameter differs according to the database engine you use.
MasterDatabaseName() *string
SetMasterDatabaseName(val *string)
// The name for the primary user.
MasterUsername() *string
SetMasterUsername(val *string)
// The password for the primary user of the database.
MasterUserPassword() *string
SetMasterUserPassword(val *string)
// The tree node.
Node() constructs.Node
// The daily time range during which automated backups are created for the database (for example, `16:00-16:30` ).
PreferredBackupWindow() *string
SetPreferredBackupWindow(val *string)
// The weekly time range during which system maintenance can occur for the database, formatted as follows: `ddd:hh24:mi-ddd:hh24:mi` .
PreferredMaintenanceWindow() *string
SetPreferredMaintenanceWindow(val *string)
// A Boolean value indicating whether the database is accessible to anyone on the internet.
PubliclyAccessible() interface{}
SetPubliclyAccessible(val interface{})
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
Ref() *string
// The blueprint ID for the database (for example, `mysql_8_0` ).
RelationalDatabaseBlueprintId() *string
SetRelationalDatabaseBlueprintId(val *string)
// The bundle ID for the database (for example, `medium_1_0` ).
RelationalDatabaseBundleId() *string
SetRelationalDatabaseBundleId(val *string)
// The name of the instance.
RelationalDatabaseName() *string
SetRelationalDatabaseName(val *string)
// An array of parameters for the database.
RelationalDatabaseParameters() interface{}
SetRelationalDatabaseParameters(val interface{})
// A Boolean value indicating whether to change the primary user password to a new, strong password generated by Lightsail .
RotateMasterUserPassword() interface{}
SetRotateMasterUserPassword(val interface{})
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
// An array of key-value pairs to apply to this resource.
TagsRaw() *[]*awscdk.CfnTag
SetTagsRaw(val *[]*awscdk.CfnTag)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// 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`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
The `AWS::Lightsail::Database` resource specifies an Amazon Lightsail database.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnDatabase := awscdk.Aws_lightsail.NewCfnDatabase(this, jsii.String("MyCfnDatabase"), &CfnDatabaseProps{
MasterDatabaseName: jsii.String("masterDatabaseName"),
MasterUsername: jsii.String("masterUsername"),
RelationalDatabaseBlueprintId: jsii.String("relationalDatabaseBlueprintId"),
RelationalDatabaseBundleId: jsii.String("relationalDatabaseBundleId"),
RelationalDatabaseName: jsii.String("relationalDatabaseName"),
// the properties below are optional
AvailabilityZone: jsii.String("availabilityZone"),
BackupRetention: jsii.Boolean(false),
CaCertificateIdentifier: jsii.String("caCertificateIdentifier"),
MasterUserPassword: jsii.String("masterUserPassword"),
PreferredBackupWindow: jsii.String("preferredBackupWindow"),
PreferredMaintenanceWindow: jsii.String("preferredMaintenanceWindow"),
PubliclyAccessible: jsii.Boolean(false),
RelationalDatabaseParameters: []interface{}{
&RelationalDatabaseParameterProperty{
AllowedValues: jsii.String("allowedValues"),
ApplyMethod: jsii.String("applyMethod"),
ApplyType: jsii.String("applyType"),
DataType: jsii.String("dataType"),
Description: jsii.String("description"),
IsModifiable: jsii.Boolean(false),
ParameterName: jsii.String("parameterName"),
ParameterValue: jsii.String("parameterValue"),
},
},
RotateMasterUserPassword: jsii.Boolean(false),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html
func NewCfnDatabase ¶
func NewCfnDatabase(scope constructs.Construct, id *string, props *CfnDatabaseProps) CfnDatabase
type CfnDatabaseProps ¶
type CfnDatabaseProps struct {
// The meaning of this parameter differs according to the database engine you use.
//
// *MySQL*
//
// The name of the database to create when the Lightsail database resource is created. If this parameter isn't specified, no database is created in the database resource.
//
// Constraints:
//
// - Must contain 1-64 letters or numbers.
// - Must begin with a letter. Subsequent characters can be letters, underscores, or numbers (0-9).
// - Can't be a word reserved by the specified database engine.
//
// For more information about reserved words in MySQL, see the Keywords and Reserved Words articles for [MySQL 5.6](https://docs.aws.amazon.com/https://dev.mysql.com/doc/refman/5.6/en/keywords.html) , [MySQL 5.7](https://docs.aws.amazon.com/https://dev.mysql.com/doc/refman/5.7/en/keywords.html) , and [MySQL 8.0](https://docs.aws.amazon.com/https://dev.mysql.com/doc/refman/8.0/en/keywords.html) .
//
// *PostgreSQL*
//
// The name of the database to create when the Lightsail database resource is created. If this parameter isn't specified, a database named `postgres` is created in the database resource.
//
// Constraints:
//
// - Must contain 1-63 letters or numbers.
// - Must begin with a letter. Subsequent characters can be letters, underscores, or numbers (0-9).
// - Can't be a word reserved by the specified database engine.
//
// For more information about reserved words in PostgreSQL, see the SQL Key Words articles for [PostgreSQL 9.6](https://docs.aws.amazon.com/https://www.postgresql.org/docs/9.6/sql-keywords-appendix.html) , [PostgreSQL 10](https://docs.aws.amazon.com/https://www.postgresql.org/docs/10/sql-keywords-appendix.html) , [PostgreSQL 11](https://docs.aws.amazon.com/https://www.postgresql.org/docs/11/sql-keywords-appendix.html) , and [PostgreSQL 12](https://docs.aws.amazon.com/https://www.postgresql.org/docs/12/sql-keywords-appendix.html) .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html#cfn-lightsail-database-masterdatabasename
//
MasterDatabaseName *string `field:"required" json:"masterDatabaseName" yaml:"masterDatabaseName"`
// The name for the primary user.
//
// *MySQL*
//
// Constraints:
//
// - Required for MySQL.
// - Must be 1-16 letters or numbers. Can contain underscores.
// - First character must be a letter.
// - Can't be a reserved word for the chosen database engine.
//
// For more information about reserved words in MySQL 5.6 or 5.7, see the Keywords and Reserved Words articles for [MySQL 5.6](https://docs.aws.amazon.com/https://dev.mysql.com/doc/refman/5.6/en/keywords.html) , [MySQL 5.7](https://docs.aws.amazon.com/https://dev.mysql.com/doc/refman/5.7/en/keywords.html) , or [MySQL 8.0](https://docs.aws.amazon.com/https://dev.mysql.com/doc/refman/8.0/en/keywords.html) .
//
// *PostgreSQL*
//
// Constraints:
//
// - Required for PostgreSQL.
// - Must be 1-63 letters or numbers. Can contain underscores.
// - First character must be a letter.
// - Can't be a reserved word for the chosen database engine.
//
// For more information about reserved words in MySQL 5.6 or 5.7, see the Keywords and Reserved Words articles for [PostgreSQL 9.6](https://docs.aws.amazon.com/https://www.postgresql.org/docs/9.6/sql-keywords-appendix.html) , [PostgreSQL 10](https://docs.aws.amazon.com/https://www.postgresql.org/docs/10/sql-keywords-appendix.html) , [PostgreSQL 11](https://docs.aws.amazon.com/https://www.postgresql.org/docs/11/sql-keywords-appendix.html) , and [PostgreSQL 12](https://docs.aws.amazon.com/https://www.postgresql.org/docs/12/sql-keywords-appendix.html) .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html#cfn-lightsail-database-masterusername
//
MasterUsername *string `field:"required" json:"masterUsername" yaml:"masterUsername"`
// The blueprint ID for the database (for example, `mysql_8_0` ).
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html#cfn-lightsail-database-relationaldatabaseblueprintid
//
RelationalDatabaseBlueprintId *string `field:"required" json:"relationalDatabaseBlueprintId" yaml:"relationalDatabaseBlueprintId"`
// The bundle ID for the database (for example, `medium_1_0` ).
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html#cfn-lightsail-database-relationaldatabasebundleid
//
RelationalDatabaseBundleId *string `field:"required" json:"relationalDatabaseBundleId" yaml:"relationalDatabaseBundleId"`
// The name of the instance.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html#cfn-lightsail-database-relationaldatabasename
//
RelationalDatabaseName *string `field:"required" json:"relationalDatabaseName" yaml:"relationalDatabaseName"`
// The Availability Zone for the database.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html#cfn-lightsail-database-availabilityzone
//
AvailabilityZone *string `field:"optional" json:"availabilityZone" yaml:"availabilityZone"`
// A Boolean value indicating whether automated backup retention is enabled for the database.
//
// Data Import Mode is enabled when `BackupRetention` is set to `false` , and is disabled when `BackupRetention` is set to `true` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html#cfn-lightsail-database-backupretention
//
BackupRetention interface{} `field:"optional" json:"backupRetention" yaml:"backupRetention"`
// The certificate associated with the database.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html#cfn-lightsail-database-cacertificateidentifier
//
CaCertificateIdentifier *string `field:"optional" json:"caCertificateIdentifier" yaml:"caCertificateIdentifier"`
// The password for the primary user of the database.
//
// The password can include any printable ASCII character except the following: /, ", or.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html#cfn-lightsail-database-masteruserpassword
//
MasterUserPassword *string `field:"optional" json:"masterUserPassword" yaml:"masterUserPassword"`
// The daily time range during which automated backups are created for the database (for example, `16:00-16:30` ).
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html#cfn-lightsail-database-preferredbackupwindow
//
PreferredBackupWindow *string `field:"optional" json:"preferredBackupWindow" yaml:"preferredBackupWindow"`
// The weekly time range during which system maintenance can occur for the database, formatted as follows: `ddd:hh24:mi-ddd:hh24:mi` .
//
// For example, `Tue:17:00-Tue:17:30` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html#cfn-lightsail-database-preferredmaintenancewindow
//
PreferredMaintenanceWindow *string `field:"optional" json:"preferredMaintenanceWindow" yaml:"preferredMaintenanceWindow"`
// A Boolean value indicating whether the database is accessible to anyone on the internet.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html#cfn-lightsail-database-publiclyaccessible
//
PubliclyAccessible interface{} `field:"optional" json:"publiclyAccessible" yaml:"publiclyAccessible"`
// An array of parameters for the database.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html#cfn-lightsail-database-relationaldatabaseparameters
//
RelationalDatabaseParameters interface{} `field:"optional" json:"relationalDatabaseParameters" yaml:"relationalDatabaseParameters"`
// A Boolean value indicating whether to change the primary user password to a new, strong password generated by Lightsail .
//
// > The `RotateMasterUserPassword` and `MasterUserPassword` parameters cannot be used together in the same template.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html#cfn-lightsail-database-rotatemasteruserpassword
//
RotateMasterUserPassword interface{} `field:"optional" json:"rotateMasterUserPassword" yaml:"rotateMasterUserPassword"`
// An array of key-value pairs to apply to this resource.
//
// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) in the *AWS CloudFormation User Guide* .
//
// > The `Value` of `Tags` is optional for Lightsail resources.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html#cfn-lightsail-database-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnDatabase`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnDatabaseProps := &CfnDatabaseProps{
MasterDatabaseName: jsii.String("masterDatabaseName"),
MasterUsername: jsii.String("masterUsername"),
RelationalDatabaseBlueprintId: jsii.String("relationalDatabaseBlueprintId"),
RelationalDatabaseBundleId: jsii.String("relationalDatabaseBundleId"),
RelationalDatabaseName: jsii.String("relationalDatabaseName"),
// the properties below are optional
AvailabilityZone: jsii.String("availabilityZone"),
BackupRetention: jsii.Boolean(false),
CaCertificateIdentifier: jsii.String("caCertificateIdentifier"),
MasterUserPassword: jsii.String("masterUserPassword"),
PreferredBackupWindow: jsii.String("preferredBackupWindow"),
PreferredMaintenanceWindow: jsii.String("preferredMaintenanceWindow"),
PubliclyAccessible: jsii.Boolean(false),
RelationalDatabaseParameters: []interface{}{
&RelationalDatabaseParameterProperty{
AllowedValues: jsii.String("allowedValues"),
ApplyMethod: jsii.String("applyMethod"),
ApplyType: jsii.String("applyType"),
DataType: jsii.String("dataType"),
Description: jsii.String("description"),
IsModifiable: jsii.Boolean(false),
ParameterName: jsii.String("parameterName"),
ParameterValue: jsii.String("parameterValue"),
},
},
RotateMasterUserPassword: jsii.Boolean(false),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html
type CfnDatabase_RelationalDatabaseParameterProperty ¶
type CfnDatabase_RelationalDatabaseParameterProperty struct {
// The valid range of values for the parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-database-relationaldatabaseparameter.html#cfn-lightsail-database-relationaldatabaseparameter-allowedvalues
//
AllowedValues *string `field:"optional" json:"allowedValues" yaml:"allowedValues"`
// Indicates when parameter updates are applied.
//
// Can be `immediate` or `pending-reboot` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-database-relationaldatabaseparameter.html#cfn-lightsail-database-relationaldatabaseparameter-applymethod
//
ApplyMethod *string `field:"optional" json:"applyMethod" yaml:"applyMethod"`
// Specifies the engine-specific parameter type.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-database-relationaldatabaseparameter.html#cfn-lightsail-database-relationaldatabaseparameter-applytype
//
ApplyType *string `field:"optional" json:"applyType" yaml:"applyType"`
// The valid data type of the parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-database-relationaldatabaseparameter.html#cfn-lightsail-database-relationaldatabaseparameter-datatype
//
DataType *string `field:"optional" json:"dataType" yaml:"dataType"`
// A description of the parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-database-relationaldatabaseparameter.html#cfn-lightsail-database-relationaldatabaseparameter-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// A Boolean value indicating whether the parameter can be modified.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-database-relationaldatabaseparameter.html#cfn-lightsail-database-relationaldatabaseparameter-ismodifiable
//
IsModifiable interface{} `field:"optional" json:"isModifiable" yaml:"isModifiable"`
// The name of the parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-database-relationaldatabaseparameter.html#cfn-lightsail-database-relationaldatabaseparameter-parametername
//
ParameterName *string `field:"optional" json:"parameterName" yaml:"parameterName"`
// The value for the parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-database-relationaldatabaseparameter.html#cfn-lightsail-database-relationaldatabaseparameter-parametervalue
//
ParameterValue *string `field:"optional" json:"parameterValue" yaml:"parameterValue"`
}
`RelationalDatabaseParameter` is a property of the [AWS::Lightsail::Database](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html) resource. It describes parameters for the database.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
relationalDatabaseParameterProperty := &RelationalDatabaseParameterProperty{
AllowedValues: jsii.String("allowedValues"),
ApplyMethod: jsii.String("applyMethod"),
ApplyType: jsii.String("applyType"),
DataType: jsii.String("dataType"),
Description: jsii.String("description"),
IsModifiable: jsii.Boolean(false),
ParameterName: jsii.String("parameterName"),
ParameterValue: jsii.String("parameterValue"),
}
type CfnDisk ¶
type CfnDisk interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggable
// An array of add-ons for the disk.
AddOns() interface{}
SetAddOns(val interface{})
// The resources to which the disk is attached.
AttrAttachedTo() *string
// (Deprecated) The attachment state of the disk.
//
// > In releases prior to November 14, 2017, this parameter returned `attached` for system disks in the API response. It is now deprecated, but still included in the response. Use `isAttached` instead.
AttrAttachmentState() *string
// The Amazon Resource Name (ARN) of the disk.
AttrDiskArn() *string
// The input/output operations per second (IOPS) of the disk.
AttrIops() *float64
// A Boolean value indicating whether the disk is attached.
AttrIsAttached() awscdk.IResolvable
// The Availability Zone where the disk is located.
AttrLocationAvailabilityZone() *string
// The AWS Region where the disk is located.
AttrLocationRegionName() *string
// The disk path.
AttrPath() *string
// The resource type of the disk (for example, `Disk` ).
AttrResourceType() *string
// The state of the disk (for example, `in-use` ).
AttrState() *string
// The support code of the disk.
//
// Include this code in your email to support when you have questions about a disk or another resource in Lightsail . This code helps our support team to look up your Lightsail information.
AttrSupportCode() *string
// The AWS Region and Availability Zone location for the disk (for example, `us-east-1a` ).
AvailabilityZone() *string
SetAvailabilityZone(val *string)
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
// The name of the disk.
DiskName() *string
SetDiskName(val *string)
// The AWS Region and Availability Zone where the disk is located.
Location() interface{}
SetLocation(val interface{})
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The tree node.
Node() constructs.Node
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
Ref() *string
// The size of the disk in GB.
SizeInGb() *float64
SetSizeInGb(val *float64)
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
// An array of key-value pairs to apply to this resource.
TagsRaw() *[]*awscdk.CfnTag
SetTagsRaw(val *[]*awscdk.CfnTag)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// 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`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
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.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnDisk := awscdk.Aws_lightsail.NewCfnDisk(this, jsii.String("MyCfnDisk"), &CfnDiskProps{
DiskName: jsii.String("diskName"),
SizeInGb: jsii.Number(123),
// the properties below are optional
AddOns: []interface{}{
&AddOnProperty{
AddOnType: jsii.String("addOnType"),
// the properties below are optional
AutoSnapshotAddOnRequest: &AutoSnapshotAddOnProperty{
SnapshotTimeOfDay: jsii.String("snapshotTimeOfDay"),
},
Status: jsii.String("status"),
},
},
AvailabilityZone: jsii.String("availabilityZone"),
Location: &LocationProperty{
AvailabilityZone: jsii.String("availabilityZone"),
RegionName: jsii.String("regionName"),
},
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-disk.html
func NewCfnDisk ¶
func NewCfnDisk(scope constructs.Construct, id *string, props *CfnDiskProps) CfnDisk
type CfnDiskProps ¶
type CfnDiskProps struct {
// The name of the disk.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-disk.html#cfn-lightsail-disk-diskname
//
DiskName *string `field:"required" json:"diskName" yaml:"diskName"`
// The size of the disk in GB.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-disk.html#cfn-lightsail-disk-sizeingb
//
SizeInGb *float64 `field:"required" json:"sizeInGb" yaml:"sizeInGb"`
// An array of add-ons for the disk.
//
// > If the disk has an add-on enabled when performing a delete disk request, the add-on is automatically disabled before the disk is deleted.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-disk.html#cfn-lightsail-disk-addons
//
AddOns interface{} `field:"optional" json:"addOns" yaml:"addOns"`
// The AWS Region and Availability Zone location for the disk (for example, `us-east-1a` ).
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-disk.html#cfn-lightsail-disk-availabilityzone
//
AvailabilityZone *string `field:"optional" json:"availabilityZone" yaml:"availabilityZone"`
// The AWS Region and Availability Zone where the disk is located.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-disk.html#cfn-lightsail-disk-location
//
Location interface{} `field:"optional" json:"location" yaml:"location"`
// An array of key-value pairs to apply to this resource.
//
// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) in the *AWS CloudFormation User Guide* .
//
// > The `Value` of `Tags` is optional for Lightsail resources.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-disk.html#cfn-lightsail-disk-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnDisk`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnDiskProps := &CfnDiskProps{
DiskName: jsii.String("diskName"),
SizeInGb: jsii.Number(123),
// the properties below are optional
AddOns: []interface{}{
&AddOnProperty{
AddOnType: jsii.String("addOnType"),
// the properties below are optional
AutoSnapshotAddOnRequest: &AutoSnapshotAddOnProperty{
SnapshotTimeOfDay: jsii.String("snapshotTimeOfDay"),
},
Status: jsii.String("status"),
},
},
AvailabilityZone: jsii.String("availabilityZone"),
Location: &LocationProperty{
AvailabilityZone: jsii.String("availabilityZone"),
RegionName: jsii.String("regionName"),
},
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-disk.html
type CfnDisk_AddOnProperty ¶
type CfnDisk_AddOnProperty struct {
// The add-on type (for example, `AutoSnapshot` ).
//
// > `AutoSnapshot` is the only add-on that can be enabled for a disk.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-disk-addon.html#cfn-lightsail-disk-addon-addontype
//
AddOnType *string `field:"required" json:"addOnType" yaml:"addOnType"`
// The parameters for the automatic snapshot add-on, such as the daily time when an automatic snapshot will be created.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-disk-addon.html#cfn-lightsail-disk-addon-autosnapshotaddonrequest
//
AutoSnapshotAddOnRequest interface{} `field:"optional" json:"autoSnapshotAddOnRequest" yaml:"autoSnapshotAddOnRequest"`
// The status of the add-on.
//
// Valid Values: `Enabled` | `Disabled`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-disk-addon.html#cfn-lightsail-disk-addon-status
//
Status *string `field:"optional" json:"status" yaml:"status"`
}
`AddOn` is a property of the [AWS::Lightsail::Disk](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-disk.html) resource. It describes the add-ons for a disk.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
addOnProperty := &AddOnProperty{
AddOnType: jsii.String("addOnType"),
// the properties below are optional
AutoSnapshotAddOnRequest: &AutoSnapshotAddOnProperty{
SnapshotTimeOfDay: jsii.String("snapshotTimeOfDay"),
},
Status: jsii.String("status"),
}
type CfnDisk_AutoSnapshotAddOnProperty ¶
type CfnDisk_AutoSnapshotAddOnProperty struct {
// The daily time when an automatic snapshot will be created.
//
// Constraints:
//
// - Must be in `HH:00` format, and in an hourly increment.
// - Specified in Coordinated Universal Time (UTC).
// - The snapshot will be automatically created between the time specified and up to 45 minutes after.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-disk-autosnapshotaddon.html#cfn-lightsail-disk-autosnapshotaddon-snapshottimeofday
//
SnapshotTimeOfDay *string `field:"optional" json:"snapshotTimeOfDay" yaml:"snapshotTimeOfDay"`
}
`AutoSnapshotAddOn` is a property of the [AddOn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-disk-addon.html) property. It describes the automatic snapshot add-on for a disk.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
autoSnapshotAddOnProperty := &AutoSnapshotAddOnProperty{
SnapshotTimeOfDay: jsii.String("snapshotTimeOfDay"),
}
type CfnDisk_LocationProperty ¶ added in v2.55.0
type CfnDisk_LocationProperty struct {
// The Availability Zone where the disk is located.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-disk-location.html#cfn-lightsail-disk-location-availabilityzone
//
AvailabilityZone *string `field:"optional" json:"availabilityZone" yaml:"availabilityZone"`
// The AWS Region where the disk is located.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-disk-location.html#cfn-lightsail-disk-location-regionname
//
RegionName *string `field:"optional" json:"regionName" yaml:"regionName"`
}
The AWS Region and Availability Zone where the disk is located.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
locationProperty := &LocationProperty{
AvailabilityZone: jsii.String("availabilityZone"),
RegionName: jsii.String("regionName"),
}
type CfnDistribution ¶ added in v2.10.0
type CfnDistribution interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggable
// Indicates whether you can update the distribution’s current bundle to another bundle.
AttrAbleToUpdateBundle() awscdk.IResolvable
// The Amazon Resource Name (ARN) of the distribution.
AttrDistributionArn() *string
// The status of the distribution.
AttrStatus() *string
// The ID of the bundle applied to the distribution.
BundleId() *string
SetBundleId(val *string)
// An array of objects that describe the per-path cache behavior of the distribution.
CacheBehaviors() interface{}
SetCacheBehaviors(val interface{})
// An object that describes the cache behavior settings of the distribution.
CacheBehaviorSettings() interface{}
SetCacheBehaviorSettings(val interface{})
// The name of the SSL/TLS certificate attached to the distribution.
CertificateName() *string
SetCertificateName(val *string)
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
// An object that describes the default cache behavior of the distribution.
DefaultCacheBehavior() interface{}
SetDefaultCacheBehavior(val interface{})
// The name of the distribution.
DistributionName() *string
SetDistributionName(val *string)
// The IP address type of the distribution.
IpAddressType() *string
SetIpAddressType(val *string)
// A Boolean value indicating whether the distribution is enabled.
IsEnabled() interface{}
SetIsEnabled(val interface{})
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The tree node.
Node() constructs.Node
// An object that describes the origin resource of the distribution, such as a Lightsail instance, bucket, or load balancer.
Origin() interface{}
SetOrigin(val interface{})
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
// An array of key-value pairs to apply to this resource.
TagsRaw() *[]*awscdk.CfnTag
SetTagsRaw(val *[]*awscdk.CfnTag)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// 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`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
The `AWS::Lightsail::Distribution` resource specifies a content delivery network (CDN) distribution.
You can create distributions only in the `us-east-1` AWS Region.
A distribution is a globally distributed network of caching servers that improve the performance of your website or web application hosted on a Lightsail instance, static content hosted on a Lightsail bucket, or through a Lightsail load balancer.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnDistribution := awscdk.Aws_lightsail.NewCfnDistribution(this, jsii.String("MyCfnDistribution"), &CfnDistributionProps{
BundleId: jsii.String("bundleId"),
DefaultCacheBehavior: &CacheBehaviorProperty{
Behavior: jsii.String("behavior"),
},
DistributionName: jsii.String("distributionName"),
Origin: &InputOriginProperty{
Name: jsii.String("name"),
ProtocolPolicy: jsii.String("protocolPolicy"),
RegionName: jsii.String("regionName"),
},
// the properties below are optional
CacheBehaviors: []interface{}{
&CacheBehaviorPerPathProperty{
Behavior: jsii.String("behavior"),
Path: jsii.String("path"),
},
},
CacheBehaviorSettings: &CacheSettingsProperty{
AllowedHttpMethods: jsii.String("allowedHttpMethods"),
CachedHttpMethods: jsii.String("cachedHttpMethods"),
DefaultTtl: jsii.Number(123),
ForwardedCookies: &CookieObjectProperty{
CookiesAllowList: []*string{
jsii.String("cookiesAllowList"),
},
Option: jsii.String("option"),
},
ForwardedHeaders: &HeaderObjectProperty{
HeadersAllowList: []*string{
jsii.String("headersAllowList"),
},
Option: jsii.String("option"),
},
ForwardedQueryStrings: &QueryStringObjectProperty{
Option: jsii.Boolean(false),
QueryStringsAllowList: []*string{
jsii.String("queryStringsAllowList"),
},
},
MaximumTtl: jsii.Number(123),
MinimumTtl: jsii.Number(123),
},
CertificateName: jsii.String("certificateName"),
IpAddressType: jsii.String("ipAddressType"),
IsEnabled: jsii.Boolean(false),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
func NewCfnDistribution ¶ added in v2.10.0
func NewCfnDistribution(scope constructs.Construct, id *string, props *CfnDistributionProps) CfnDistribution
type CfnDistributionProps ¶ added in v2.10.0
type CfnDistributionProps struct {
// The ID of the bundle applied to the distribution.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-distribution.html#cfn-lightsail-distribution-bundleid
//
BundleId *string `field:"required" json:"bundleId" yaml:"bundleId"`
// An object that describes the default cache behavior of the distribution.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-distribution.html#cfn-lightsail-distribution-defaultcachebehavior
//
DefaultCacheBehavior interface{} `field:"required" json:"defaultCacheBehavior" yaml:"defaultCacheBehavior"`
// The name of the distribution.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-distribution.html#cfn-lightsail-distribution-distributionname
//
DistributionName *string `field:"required" json:"distributionName" yaml:"distributionName"`
// An object that describes the origin resource of the distribution, such as a Lightsail instance, bucket, or load balancer.
//
// The distribution pulls, caches, and serves content from the origin.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-distribution.html#cfn-lightsail-distribution-origin
//
Origin interface{} `field:"required" json:"origin" yaml:"origin"`
// An array of objects that describe the per-path cache behavior of the distribution.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-distribution.html#cfn-lightsail-distribution-cachebehaviors
//
CacheBehaviors interface{} `field:"optional" json:"cacheBehaviors" yaml:"cacheBehaviors"`
// An object that describes the cache behavior settings of the distribution.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-distribution.html#cfn-lightsail-distribution-cachebehaviorsettings
//
CacheBehaviorSettings interface{} `field:"optional" json:"cacheBehaviorSettings" yaml:"cacheBehaviorSettings"`
// The name of the SSL/TLS certificate attached to the distribution.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-distribution.html#cfn-lightsail-distribution-certificatename
//
CertificateName *string `field:"optional" json:"certificateName" yaml:"certificateName"`
// The IP address type of the distribution.
//
// The possible values are `ipv4` for IPv4 only, and `dualstack` for IPv4 and IPv6.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-distribution.html#cfn-lightsail-distribution-ipaddresstype
//
IpAddressType *string `field:"optional" json:"ipAddressType" yaml:"ipAddressType"`
// A Boolean value indicating whether the distribution is enabled.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-distribution.html#cfn-lightsail-distribution-isenabled
//
IsEnabled interface{} `field:"optional" json:"isEnabled" yaml:"isEnabled"`
// An array of key-value pairs to apply to this resource.
//
// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) in the *AWS CloudFormation User Guide* .
//
// > The `Value` of `Tags` is optional for Lightsail resources.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-distribution.html#cfn-lightsail-distribution-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnDistribution`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnDistributionProps := &CfnDistributionProps{
BundleId: jsii.String("bundleId"),
DefaultCacheBehavior: &CacheBehaviorProperty{
Behavior: jsii.String("behavior"),
},
DistributionName: jsii.String("distributionName"),
Origin: &InputOriginProperty{
Name: jsii.String("name"),
ProtocolPolicy: jsii.String("protocolPolicy"),
RegionName: jsii.String("regionName"),
},
// the properties below are optional
CacheBehaviors: []interface{}{
&CacheBehaviorPerPathProperty{
Behavior: jsii.String("behavior"),
Path: jsii.String("path"),
},
},
CacheBehaviorSettings: &CacheSettingsProperty{
AllowedHttpMethods: jsii.String("allowedHttpMethods"),
CachedHttpMethods: jsii.String("cachedHttpMethods"),
DefaultTtl: jsii.Number(123),
ForwardedCookies: &CookieObjectProperty{
CookiesAllowList: []*string{
jsii.String("cookiesAllowList"),
},
Option: jsii.String("option"),
},
ForwardedHeaders: &HeaderObjectProperty{
HeadersAllowList: []*string{
jsii.String("headersAllowList"),
},
Option: jsii.String("option"),
},
ForwardedQueryStrings: &QueryStringObjectProperty{
Option: jsii.Boolean(false),
QueryStringsAllowList: []*string{
jsii.String("queryStringsAllowList"),
},
},
MaximumTtl: jsii.Number(123),
MinimumTtl: jsii.Number(123),
},
CertificateName: jsii.String("certificateName"),
IpAddressType: jsii.String("ipAddressType"),
IsEnabled: jsii.Boolean(false),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
type CfnDistribution_CacheBehaviorPerPathProperty ¶ added in v2.10.0
type CfnDistribution_CacheBehaviorPerPathProperty struct {
// The cache behavior for the specified path.
//
// You can specify one of the following per-path cache behaviors:
//
// - *`cache`* - This behavior caches the specified path.
// - *`dont-cache`* - This behavior doesn't cache the specified path.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-distribution-cachebehaviorperpath.html#cfn-lightsail-distribution-cachebehaviorperpath-behavior
//
Behavior *string `field:"optional" json:"behavior" yaml:"behavior"`
// The path to a directory or file to cache, or not cache.
//
// Use an asterisk symbol to specify wildcard directories ( `path/to/assets/*` ), and file types ( `*.html` , `*jpg` , `*js` ). Directories and file paths are case-sensitive.
//
// Examples:
//
// - Specify the following to cache all files in the document root of an Apache web server running on a instance.
//
// `var/www/html/`
// - Specify the following file to cache only the index page in the document root of an Apache web server.
//
// `var/www/html/index.html`
// - Specify the following to cache only the .html files in the document root of an Apache web server.
//
// `var/www/html/*.html`
// - Specify the following to cache only the .jpg, .png, and .gif files in the images sub-directory of the document root of an Apache web server.
//
// `var/www/html/images/*.jpg`
//
// `var/www/html/images/*.png`
//
// `var/www/html/images/*.gif`
//
// Specify the following to cache all files in the images subdirectory of the document root of an Apache web server.
//
// `var/www/html/images/`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-distribution-cachebehaviorperpath.html#cfn-lightsail-distribution-cachebehaviorperpath-path
//
Path *string `field:"optional" json:"path" yaml:"path"`
}
`CacheBehaviorPerPath` is a property of the [AWS::Lightsail::Distribution](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-distribution.html) resource. It describes the per-path cache behavior of an Amazon Lightsail content delivery network (CDN) distribution.
Use a per-path cache behavior to override the default cache behavior of a distribution, or to add an exception to it. For example, if you set the `CacheBehavior` to `cache` , you can use a per-path cache behavior to specify a directory, file, or file type that your distribution will cache. If you don’t want your distribution to cache a specified directory, file, or file type, set the per-path cache behavior to `dont-cache` .
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cacheBehaviorPerPathProperty := &CacheBehaviorPerPathProperty{
Behavior: jsii.String("behavior"),
Path: jsii.String("path"),
}
type CfnDistribution_CacheBehaviorProperty ¶ added in v2.10.0
type CfnDistribution_CacheBehaviorProperty struct {
// The cache behavior of the distribution.
//
// The following cache behaviors can be specified:
//
// - *`cache`* - This option is best for static sites. When specified, your distribution caches and serves your entire website as static content. This behavior is ideal for websites with static content that doesn't change depending on who views it, or for websites that don't use cookies, headers, or query strings to personalize content.
// - *`dont-cache`* - This option is best for sites that serve a mix of static and dynamic content. When specified, your distribution caches and serves only the content that is specified in the distribution’s `CacheBehaviorPerPath` parameter. This behavior is ideal for websites or web applications that use cookies, headers, and query strings to personalize content for individual users.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-distribution-cachebehavior.html#cfn-lightsail-distribution-cachebehavior-behavior
//
Behavior *string `field:"optional" json:"behavior" yaml:"behavior"`
}
`CacheBehavior` is a property of the [AWS::Lightsail::Distribution](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-distribution.html) resource. It describes the default cache behavior of an Amazon Lightsail content delivery network (CDN) distribution.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cacheBehaviorProperty := &CacheBehaviorProperty{
Behavior: jsii.String("behavior"),
}
type CfnDistribution_CacheSettingsProperty ¶ added in v2.10.0
type CfnDistribution_CacheSettingsProperty struct {
// The HTTP methods that are processed and forwarded to the distribution's origin.
//
// You can specify the following options:
//
// - `GET,HEAD` - The distribution forwards the `GET` and `HEAD` methods.
// - `GET,HEAD,OPTIONS` - The distribution forwards the `GET` , `HEAD` , and `OPTIONS` methods.
// - `GET,HEAD,OPTIONS,PUT,PATCH,POST,DELETE` - The distribution forwards the `GET` , `HEAD` , `OPTIONS` , `PUT` , `PATCH` , `POST` , and `DELETE` methods.
//
// If you specify `GET,HEAD,OPTIONS,PUT,PATCH,POST,DELETE` , you might need to restrict access to your distribution's origin so users can't perform operations that you don't want them to. For example, you might not want users to have permission to delete objects from your origin.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-distribution-cachesettings.html#cfn-lightsail-distribution-cachesettings-allowedhttpmethods
//
AllowedHttpMethods *string `field:"optional" json:"allowedHttpMethods" yaml:"allowedHttpMethods"`
// The HTTP method responses that are cached by your distribution.
//
// You can specify the following options:
//
// - `GET,HEAD` - The distribution caches responses to the `GET` and `HEAD` methods.
// - `GET,HEAD,OPTIONS` - The distribution caches responses to the `GET` , `HEAD` , and `OPTIONS` methods.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-distribution-cachesettings.html#cfn-lightsail-distribution-cachesettings-cachedhttpmethods
//
CachedHttpMethods *string `field:"optional" json:"cachedHttpMethods" yaml:"cachedHttpMethods"`
// The default amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the content has been updated.
//
// > The value specified applies only when the origin does not add HTTP headers such as `Cache-Control max-age` , `Cache-Control s-maxage` , and `Expires` to objects.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-distribution-cachesettings.html#cfn-lightsail-distribution-cachesettings-defaultttl
//
DefaultTtl *float64 `field:"optional" json:"defaultTtl" yaml:"defaultTtl"`
// An object that describes the cookies that are forwarded to the origin.
//
// Your content is cached based on the cookies that are forwarded.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-distribution-cachesettings.html#cfn-lightsail-distribution-cachesettings-forwardedcookies
//
ForwardedCookies interface{} `field:"optional" json:"forwardedCookies" yaml:"forwardedCookies"`
// An object that describes the headers that are forwarded to the origin.
//
// Your content is cached based on the headers that are forwarded.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-distribution-cachesettings.html#cfn-lightsail-distribution-cachesettings-forwardedheaders
//
ForwardedHeaders interface{} `field:"optional" json:"forwardedHeaders" yaml:"forwardedHeaders"`
// An object that describes the query strings that are forwarded to the origin.
//
// Your content is cached based on the query strings that are forwarded.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-distribution-cachesettings.html#cfn-lightsail-distribution-cachesettings-forwardedquerystrings
//
ForwardedQueryStrings interface{} `field:"optional" json:"forwardedQueryStrings" yaml:"forwardedQueryStrings"`
// The maximum amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the object has been updated.
//
// The value specified applies only when the origin adds HTTP headers such as `Cache-Control max-age` , `Cache-Control s-maxage` , and `Expires` to objects.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-distribution-cachesettings.html#cfn-lightsail-distribution-cachesettings-maximumttl
//
MaximumTtl *float64 `field:"optional" json:"maximumTtl" yaml:"maximumTtl"`
// The minimum amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the object has been updated.
//
// A value of `0` must be specified for `minimumTTL` if the distribution is configured to forward all headers to the origin.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-distribution-cachesettings.html#cfn-lightsail-distribution-cachesettings-minimumttl
//
MinimumTtl *float64 `field:"optional" json:"minimumTtl" yaml:"minimumTtl"`
}
`CacheSettings` is a property of the [AWS::Lightsail::Distribution](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-distribution.html) resource. It describes the cache settings of an Amazon Lightsail content delivery network (CDN) distribution.
These settings apply only to your distribution’s `CacheBehaviors` that have a `Behavior` of `cache` . This includes the `DefaultCacheBehavior` .
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cacheSettingsProperty := &CacheSettingsProperty{
AllowedHttpMethods: jsii.String("allowedHttpMethods"),
CachedHttpMethods: jsii.String("cachedHttpMethods"),
DefaultTtl: jsii.Number(123),
ForwardedCookies: &CookieObjectProperty{
CookiesAllowList: []*string{
jsii.String("cookiesAllowList"),
},
Option: jsii.String("option"),
},
ForwardedHeaders: &HeaderObjectProperty{
HeadersAllowList: []*string{
jsii.String("headersAllowList"),
},
Option: jsii.String("option"),
},
ForwardedQueryStrings: &QueryStringObjectProperty{
Option: jsii.Boolean(false),
QueryStringsAllowList: []*string{
jsii.String("queryStringsAllowList"),
},
},
MaximumTtl: jsii.Number(123),
MinimumTtl: jsii.Number(123),
}
type CfnDistribution_CookieObjectProperty ¶ added in v2.10.0
type CfnDistribution_CookieObjectProperty struct {
// The specific cookies to forward to your distribution's origin.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-distribution-cookieobject.html#cfn-lightsail-distribution-cookieobject-cookiesallowlist
//
CookiesAllowList *[]*string `field:"optional" json:"cookiesAllowList" yaml:"cookiesAllowList"`
// Specifies which cookies to forward to the distribution's origin for a cache behavior.
//
// Use one of the following configurations for your distribution:
//
// - *`all`* - Forwards all cookies to your origin.
// - *`none`* - Doesn’t forward cookies to your origin.
// - *`allow-list`* - Forwards only the cookies that you specify using the `CookiesAllowList` parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-distribution-cookieobject.html#cfn-lightsail-distribution-cookieobject-option
//
Option *string `field:"optional" json:"option" yaml:"option"`
}
`CookieObject` is a property of the [CacheSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-distribution-cachesettings.html) property. It describes whether an Amazon Lightsail content delivery network (CDN) distribution forwards cookies to the origin and, if so, which ones.
For the cookies that you specify, your distribution caches separate versions of the specified content based on the cookie values in viewer requests.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cookieObjectProperty := &CookieObjectProperty{
CookiesAllowList: []*string{
jsii.String("cookiesAllowList"),
},
Option: jsii.String("option"),
}
type CfnDistribution_HeaderObjectProperty ¶ added in v2.10.0
type CfnDistribution_HeaderObjectProperty struct {
// The specific headers to forward to your distribution's origin.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-distribution-headerobject.html#cfn-lightsail-distribution-headerobject-headersallowlist
//
HeadersAllowList *[]*string `field:"optional" json:"headersAllowList" yaml:"headersAllowList"`
// The headers that you want your distribution to forward to your origin.
//
// Your distribution caches your content based on these headers.
//
// Use one of the following configurations for your distribution:
//
// - *`all`* - Forwards all headers to your origin..
// - *`none`* - Forwards only the default headers.
// - *`allow-list`* - Forwards only the headers that you specify using the `HeadersAllowList` parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-distribution-headerobject.html#cfn-lightsail-distribution-headerobject-option
//
Option *string `field:"optional" json:"option" yaml:"option"`
}
`HeaderObject` is a property of the [CacheSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-distribution-cachesettings.html) property. It describes the request headers used by your distribution, which caches your content based on the request headers.
For the headers that you specify, your distribution caches separate versions of the specified content based on the header values in viewer requests. For example, suppose that viewer requests for logo.jpg contain a custom product header that has a value of either acme or apex. Also, suppose that you configure your distribution to cache your content based on values in the product header. Your distribution forwards the product header to the origin and caches the response from the origin once for each header value.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
headerObjectProperty := &HeaderObjectProperty{
HeadersAllowList: []*string{
jsii.String("headersAllowList"),
},
Option: jsii.String("option"),
}
type CfnDistribution_InputOriginProperty ¶ added in v2.10.0
type CfnDistribution_InputOriginProperty struct {
// The name of the origin resource.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-distribution-inputorigin.html#cfn-lightsail-distribution-inputorigin-name
//
Name *string `field:"optional" json:"name" yaml:"name"`
// The protocol that your Amazon Lightsail distribution uses when establishing a connection with your origin to pull content.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-distribution-inputorigin.html#cfn-lightsail-distribution-inputorigin-protocolpolicy
//
ProtocolPolicy *string `field:"optional" json:"protocolPolicy" yaml:"protocolPolicy"`
// The AWS Region name of the origin resource.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-distribution-inputorigin.html#cfn-lightsail-distribution-inputorigin-regionname
//
RegionName *string `field:"optional" json:"regionName" yaml:"regionName"`
}
`InputOrigin` is a property of the [AWS::Lightsail::Distribution](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-distribution.html) resource. It describes the origin resource of an Amazon Lightsail content delivery network (CDN) distribution.
An origin can be a instance, bucket, or load balancer. A distribution pulls content from an origin, caches it, and serves it to viewers through a worldwide network of edge servers.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
inputOriginProperty := &InputOriginProperty{
Name: jsii.String("name"),
ProtocolPolicy: jsii.String("protocolPolicy"),
RegionName: jsii.String("regionName"),
}
type CfnDistribution_QueryStringObjectProperty ¶ added in v2.10.0
type CfnDistribution_QueryStringObjectProperty struct {
// Indicates whether the distribution forwards and caches based on query strings.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-distribution-querystringobject.html#cfn-lightsail-distribution-querystringobject-option
//
Option interface{} `field:"optional" json:"option" yaml:"option"`
// The specific query strings that the distribution forwards to the origin.
//
// Your distribution caches content based on the specified query strings.
//
// If the `option` parameter is true, then your distribution forwards all query strings, regardless of what you specify using the `QueryStringsAllowList` parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-distribution-querystringobject.html#cfn-lightsail-distribution-querystringobject-querystringsallowlist
//
QueryStringsAllowList *[]*string `field:"optional" json:"queryStringsAllowList" yaml:"queryStringsAllowList"`
}
`QueryStringObject` is a property of the [CacheSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-distribution-cachesettings.html) property. It describes the query string parameters that an Amazon Lightsail content delivery network (CDN) distribution to bases caching on.
For the query strings that you specify, your distribution caches separate versions of the specified content based on the query string values in viewer requests.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
queryStringObjectProperty := &QueryStringObjectProperty{
Option: jsii.Boolean(false),
QueryStringsAllowList: []*string{
jsii.String("queryStringsAllowList"),
},
}
type CfnInstance ¶
type CfnInstance interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggable
// An array of add-ons for the instance.
AddOns() interface{}
SetAddOns(val interface{})
// The number of vCPUs the instance has.
AttrHardwareCpuCount() *float64
// The amount of RAM in GB on the instance (for example, `1.0` ).
AttrHardwareRamSizeInGb() *float64
// The Amazon Resource Name (ARN) of the instance (for example, `arn:aws:lightsail:us-east-2:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE` ).
AttrInstanceArn() *string
// The IPv6 addresses of the instance.
AttrIpv6Addresses() *[]*string
// A Boolean value indicating whether the instance has a static IP assigned to it.
AttrIsStaticIp() awscdk.IResolvable
// The AWS Region and Availability Zone where the instance is located.
AttrLocationAvailabilityZone() *string
// The AWS Region of the instance.
AttrLocationRegionName() *string
// The amount of allocated monthly data transfer (in GB) for an instance.
AttrNetworkingMonthlyTransferGbPerMonthAllocated() *string
// The private IP address of the instance.
AttrPrivateIpAddress() *string
// The public IP address of the instance.
AttrPublicIpAddress() *string
// The resource type of the instance (for example, `Instance` ).
AttrResourceType() *string
// The name of the SSH key pair used by the instance.
AttrSshKeyName() *string
// The status code of the instance.
AttrStateCode() *float64
// The state of the instance (for example, `running` or `pending` ).
AttrStateName() *string
// The support code of the instance.
//
// Include this code in your email to support when you have questions about an instance or another resource in Lightsail . This code helps our support team to look up your Lightsail information.
AttrSupportCode() *string
// The user name for connecting to the instance (for example, `ec2-user` ).
AttrUserName() *string
// The Availability Zone for the instance.
AvailabilityZone() *string
SetAvailabilityZone(val *string)
// The blueprint ID for the instance (for example, `os_amlinux_2016_03` ).
BlueprintId() *string
SetBlueprintId(val *string)
// The bundle ID for the instance (for example, `micro_1_0` ).
BundleId() *string
SetBundleId(val *string)
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
// The hardware properties for the instance, such as the vCPU count, attached disks, and amount of RAM.
Hardware() interface{}
SetHardware(val interface{})
// The name of the instance.
InstanceName() *string
SetInstanceName(val *string)
// The name of the key pair to use for the instance.
KeyPairName() *string
SetKeyPairName(val *string)
// The location for the instance, such as the AWS Region and Availability Zone.
Location() interface{}
SetLocation(val interface{})
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The public ports and the monthly amount of data transfer allocated for the instance.
Networking() interface{}
SetNetworking(val interface{})
// The tree node.
Node() constructs.Node
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// The status code and the state (for example, `running` ) of the instance.
State() interface{}
SetState(val interface{})
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
// An array of key-value pairs to apply to this resource.
TagsRaw() *[]*awscdk.CfnTag
SetTagsRaw(val *[]*awscdk.CfnTag)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// The optional launch script for the instance.
UserData() *string
SetUserData(val *string)
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// 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`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
The `AWS::Lightsail::Instance` resource specifies an Amazon Lightsail instance.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnInstance := awscdk.Aws_lightsail.NewCfnInstance(this, jsii.String("MyCfnInstance"), &CfnInstanceProps{
BlueprintId: jsii.String("blueprintId"),
BundleId: jsii.String("bundleId"),
InstanceName: jsii.String("instanceName"),
// the properties below are optional
AddOns: []interface{}{
&AddOnProperty{
AddOnType: jsii.String("addOnType"),
// the properties below are optional
AutoSnapshotAddOnRequest: &AutoSnapshotAddOnProperty{
SnapshotTimeOfDay: jsii.String("snapshotTimeOfDay"),
},
Status: jsii.String("status"),
},
},
AvailabilityZone: jsii.String("availabilityZone"),
Hardware: &HardwareProperty{
CpuCount: jsii.Number(123),
Disks: []interface{}{
&DiskProperty{
DiskName: jsii.String("diskName"),
Path: jsii.String("path"),
// the properties below are optional
AttachedTo: jsii.String("attachedTo"),
AttachmentState: jsii.String("attachmentState"),
Iops: jsii.Number(123),
IsSystemDisk: jsii.Boolean(false),
SizeInGb: jsii.String("sizeInGb"),
},
},
RamSizeInGb: jsii.Number(123),
},
KeyPairName: jsii.String("keyPairName"),
Location: &LocationProperty{
AvailabilityZone: jsii.String("availabilityZone"),
RegionName: jsii.String("regionName"),
},
Networking: &NetworkingProperty{
Ports: []interface{}{
&PortProperty{
AccessDirection: jsii.String("accessDirection"),
AccessFrom: jsii.String("accessFrom"),
AccessType: jsii.String("accessType"),
CidrListAliases: []*string{
jsii.String("cidrListAliases"),
},
Cidrs: []*string{
jsii.String("cidrs"),
},
CommonName: jsii.String("commonName"),
FromPort: jsii.Number(123),
Ipv6Cidrs: []*string{
jsii.String("ipv6Cidrs"),
},
Protocol: jsii.String("protocol"),
ToPort: jsii.Number(123),
},
},
// the properties below are optional
MonthlyTransfer: &MonthlyTransferProperty{
GbPerMonthAllocated: jsii.String("gbPerMonthAllocated"),
},
},
State: &StateProperty{
Code: jsii.Number(123),
Name: jsii.String("name"),
},
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
UserData: jsii.String("userData"),
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html
func NewCfnInstance ¶
func NewCfnInstance(scope constructs.Construct, id *string, props *CfnInstanceProps) CfnInstance
type CfnInstanceProps ¶
type CfnInstanceProps struct {
// The blueprint ID for the instance (for example, `os_amlinux_2016_03` ).
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#cfn-lightsail-instance-blueprintid
//
BlueprintId *string `field:"required" json:"blueprintId" yaml:"blueprintId"`
// The bundle ID for the instance (for example, `micro_1_0` ).
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#cfn-lightsail-instance-bundleid
//
BundleId *string `field:"required" json:"bundleId" yaml:"bundleId"`
// The name of the instance.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#cfn-lightsail-instance-instancename
//
InstanceName *string `field:"required" json:"instanceName" yaml:"instanceName"`
// An array of add-ons for the instance.
//
// > If the instance has an add-on enabled when performing a delete instance request, the add-on is automatically disabled before the instance is deleted.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#cfn-lightsail-instance-addons
//
AddOns interface{} `field:"optional" json:"addOns" yaml:"addOns"`
// The Availability Zone for the instance.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#cfn-lightsail-instance-availabilityzone
//
AvailabilityZone *string `field:"optional" json:"availabilityZone" yaml:"availabilityZone"`
// The hardware properties for the instance, such as the vCPU count, attached disks, and amount of RAM.
//
// > The instance restarts when performing an attach disk or detach disk request. This resets the public IP address of your instance if a static IP isn't attached to it.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#cfn-lightsail-instance-hardware
//
Hardware interface{} `field:"optional" json:"hardware" yaml:"hardware"`
// The name of the key pair to use for the instance.
//
// If no key pair name is specified, the Regional Lightsail default key pair is used.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#cfn-lightsail-instance-keypairname
//
KeyPairName *string `field:"optional" json:"keyPairName" yaml:"keyPairName"`
// The location for the instance, such as the AWS Region and Availability Zone.
//
// > The `Location` property is read-only and should not be specified in a create instance or update instance request.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#cfn-lightsail-instance-location
//
Location interface{} `field:"optional" json:"location" yaml:"location"`
// The public ports and the monthly amount of data transfer allocated for the instance.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#cfn-lightsail-instance-networking
//
Networking interface{} `field:"optional" json:"networking" yaml:"networking"`
// The status code and the state (for example, `running` ) of the instance.
//
// > The `State` property is read-only and should not be specified in a create instance or update instance request.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#cfn-lightsail-instance-state
//
State interface{} `field:"optional" json:"state" yaml:"state"`
// An array of key-value pairs to apply to this resource.
//
// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) in the *AWS CloudFormation User Guide* .
//
// > The `Value` of `Tags` is optional for Lightsail resources.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#cfn-lightsail-instance-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
// The optional launch script for the instance.
//
// Specify a launch script to configure an instance with additional user data. For example, you might want to specify `apt-get -y update` as a launch script.
//
// > Depending on the blueprint of your instance, the command to get software on your instance varies. Amazon Linux and CentOS use `yum` , Debian and Ubuntu use `apt-get` , and FreeBSD uses `pkg` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html#cfn-lightsail-instance-userdata
//
UserData *string `field:"optional" json:"userData" yaml:"userData"`
}
Properties for defining a `CfnInstance`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnInstanceProps := &CfnInstanceProps{
BlueprintId: jsii.String("blueprintId"),
BundleId: jsii.String("bundleId"),
InstanceName: jsii.String("instanceName"),
// the properties below are optional
AddOns: []interface{}{
&AddOnProperty{
AddOnType: jsii.String("addOnType"),
// the properties below are optional
AutoSnapshotAddOnRequest: &AutoSnapshotAddOnProperty{
SnapshotTimeOfDay: jsii.String("snapshotTimeOfDay"),
},
Status: jsii.String("status"),
},
},
AvailabilityZone: jsii.String("availabilityZone"),
Hardware: &HardwareProperty{
CpuCount: jsii.Number(123),
Disks: []interface{}{
&DiskProperty{
DiskName: jsii.String("diskName"),
Path: jsii.String("path"),
// the properties below are optional
AttachedTo: jsii.String("attachedTo"),
AttachmentState: jsii.String("attachmentState"),
Iops: jsii.Number(123),
IsSystemDisk: jsii.Boolean(false),
SizeInGb: jsii.String("sizeInGb"),
},
},
RamSizeInGb: jsii.Number(123),
},
KeyPairName: jsii.String("keyPairName"),
Location: &LocationProperty{
AvailabilityZone: jsii.String("availabilityZone"),
RegionName: jsii.String("regionName"),
},
Networking: &NetworkingProperty{
Ports: []interface{}{
&PortProperty{
AccessDirection: jsii.String("accessDirection"),
AccessFrom: jsii.String("accessFrom"),
AccessType: jsii.String("accessType"),
CidrListAliases: []*string{
jsii.String("cidrListAliases"),
},
Cidrs: []*string{
jsii.String("cidrs"),
},
CommonName: jsii.String("commonName"),
FromPort: jsii.Number(123),
Ipv6Cidrs: []*string{
jsii.String("ipv6Cidrs"),
},
Protocol: jsii.String("protocol"),
ToPort: jsii.Number(123),
},
},
// the properties below are optional
MonthlyTransfer: &MonthlyTransferProperty{
GbPerMonthAllocated: jsii.String("gbPerMonthAllocated"),
},
},
State: &StateProperty{
Code: jsii.Number(123),
Name: jsii.String("name"),
},
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
UserData: jsii.String("userData"),
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html
type CfnInstance_AddOnProperty ¶
type CfnInstance_AddOnProperty struct {
// The add-on type (for example, `AutoSnapshot` ).
//
// > `AutoSnapshot` is the only add-on that can be enabled for an instance.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-addon.html#cfn-lightsail-instance-addon-addontype
//
AddOnType *string `field:"required" json:"addOnType" yaml:"addOnType"`
// The parameters for the automatic snapshot add-on, such as the daily time when an automatic snapshot will be created.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-addon.html#cfn-lightsail-instance-addon-autosnapshotaddonrequest
//
AutoSnapshotAddOnRequest interface{} `field:"optional" json:"autoSnapshotAddOnRequest" yaml:"autoSnapshotAddOnRequest"`
// The status of the add-on.
//
// Valid Values: `Enabled` | `Disabled`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-addon.html#cfn-lightsail-instance-addon-status
//
Status *string `field:"optional" json:"status" yaml:"status"`
}
`AddOn` is a property of the [AWS::Lightsail::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html) resource. It describes the add-ons for an instance.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
addOnProperty := &AddOnProperty{
AddOnType: jsii.String("addOnType"),
// the properties below are optional
AutoSnapshotAddOnRequest: &AutoSnapshotAddOnProperty{
SnapshotTimeOfDay: jsii.String("snapshotTimeOfDay"),
},
Status: jsii.String("status"),
}
type CfnInstance_AutoSnapshotAddOnProperty ¶
type CfnInstance_AutoSnapshotAddOnProperty struct {
// The daily time when an automatic snapshot will be created.
//
// Constraints:
//
// - Must be in `HH:00` format, and in an hourly increment.
// - Specified in Coordinated Universal Time (UTC).
// - The snapshot will be automatically created between the time specified and up to 45 minutes after.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-autosnapshotaddon.html#cfn-lightsail-instance-autosnapshotaddon-snapshottimeofday
//
SnapshotTimeOfDay *string `field:"optional" json:"snapshotTimeOfDay" yaml:"snapshotTimeOfDay"`
}
`AutoSnapshotAddOn` is a property of the [AddOn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-addon.html) property. It describes the automatic snapshot add-on for an instance.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
autoSnapshotAddOnProperty := &AutoSnapshotAddOnProperty{
SnapshotTimeOfDay: jsii.String("snapshotTimeOfDay"),
}
type CfnInstance_DiskProperty ¶
type CfnInstance_DiskProperty struct {
// The unique name of the disk.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-disk.html#cfn-lightsail-instance-disk-diskname
//
DiskName *string `field:"required" json:"diskName" yaml:"diskName"`
// The disk path.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-disk.html#cfn-lightsail-instance-disk-path
//
Path *string `field:"required" json:"path" yaml:"path"`
// The resources to which the disk is attached.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-disk.html#cfn-lightsail-instance-disk-attachedto
//
AttachedTo *string `field:"optional" json:"attachedTo" yaml:"attachedTo"`
// (Deprecated) The attachment state of the disk.
//
// > In releases prior to November 14, 2017, this parameter returned `attached` for system disks in the API response. It is now deprecated, but still included in the response. Use `isAttached` instead.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-disk.html#cfn-lightsail-instance-disk-attachmentstate
//
AttachmentState *string `field:"optional" json:"attachmentState" yaml:"attachmentState"`
// The input/output operations per second (IOPS) of the disk.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-disk.html#cfn-lightsail-instance-disk-iops
//
Iops *float64 `field:"optional" json:"iops" yaml:"iops"`
// A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-disk.html#cfn-lightsail-instance-disk-issystemdisk
//
IsSystemDisk interface{} `field:"optional" json:"isSystemDisk" yaml:"isSystemDisk"`
// The size of the disk in GB.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-disk.html#cfn-lightsail-instance-disk-sizeingb
//
SizeInGb *string `field:"optional" json:"sizeInGb" yaml:"sizeInGb"`
}
`Disk` is a property of the [Hardware](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-hardware.html) property. It describes a disk attached to an instance.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
diskProperty := &DiskProperty{
DiskName: jsii.String("diskName"),
Path: jsii.String("path"),
// the properties below are optional
AttachedTo: jsii.String("attachedTo"),
AttachmentState: jsii.String("attachmentState"),
Iops: jsii.Number(123),
IsSystemDisk: jsii.Boolean(false),
SizeInGb: jsii.String("sizeInGb"),
}
type CfnInstance_HardwareProperty ¶
type CfnInstance_HardwareProperty struct {
// The number of vCPUs the instance has.
//
// > The `CpuCount` property is read-only and should not be specified in a create instance or update instance request.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-hardware.html#cfn-lightsail-instance-hardware-cpucount
//
CpuCount *float64 `field:"optional" json:"cpuCount" yaml:"cpuCount"`
// The disks attached to the instance.
//
// The instance restarts when performing an attach disk or detach disk request. This resets the public IP address of your instance if a static IP isn't attached to it.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-hardware.html#cfn-lightsail-instance-hardware-disks
//
Disks interface{} `field:"optional" json:"disks" yaml:"disks"`
// The amount of RAM in GB on the instance (for example, `1.0` ).
//
// > The `RamSizeInGb` property is read-only and should not be specified in a create instance or update instance request.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-hardware.html#cfn-lightsail-instance-hardware-ramsizeingb
//
RamSizeInGb *float64 `field:"optional" json:"ramSizeInGb" yaml:"ramSizeInGb"`
}
`Hardware` is a property of the [AWS::Lightsail::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html) resource. It describes the hardware properties for the instance, such as the vCPU count, attached disks, and amount of RAM.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
hardwareProperty := &HardwareProperty{
CpuCount: jsii.Number(123),
Disks: []interface{}{
&DiskProperty{
DiskName: jsii.String("diskName"),
Path: jsii.String("path"),
// the properties below are optional
AttachedTo: jsii.String("attachedTo"),
AttachmentState: jsii.String("attachmentState"),
Iops: jsii.Number(123),
IsSystemDisk: jsii.Boolean(false),
SizeInGb: jsii.String("sizeInGb"),
},
},
RamSizeInGb: jsii.Number(123),
}
type CfnInstance_LocationProperty ¶
type CfnInstance_LocationProperty struct {
// The Availability Zone for the instance.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-location.html#cfn-lightsail-instance-location-availabilityzone
//
AvailabilityZone *string `field:"optional" json:"availabilityZone" yaml:"availabilityZone"`
// The name of the AWS Region for the instance.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-location.html#cfn-lightsail-instance-location-regionname
//
RegionName *string `field:"optional" json:"regionName" yaml:"regionName"`
}
`Location` is a property of the [AWS::Lightsail::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html) resource. It describes the location for an instance.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
locationProperty := &LocationProperty{
AvailabilityZone: jsii.String("availabilityZone"),
RegionName: jsii.String("regionName"),
}
type CfnInstance_MonthlyTransferProperty ¶
type CfnInstance_MonthlyTransferProperty struct {
// The amount of allocated monthly data transfer (in GB) for an instance.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-monthlytransfer.html#cfn-lightsail-instance-monthlytransfer-gbpermonthallocated
//
GbPerMonthAllocated *string `field:"optional" json:"gbPerMonthAllocated" yaml:"gbPerMonthAllocated"`
}
`MonthlyTransfer` is a property of the [Networking](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-networking.html) property. It describes the amount of allocated monthly data transfer (in GB) for an instance.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
monthlyTransferProperty := &MonthlyTransferProperty{
GbPerMonthAllocated: jsii.String("gbPerMonthAllocated"),
}
type CfnInstance_NetworkingProperty ¶
type CfnInstance_NetworkingProperty struct {
// An array of ports to open on the instance.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-networking.html#cfn-lightsail-instance-networking-ports
//
Ports interface{} `field:"required" json:"ports" yaml:"ports"`
// The monthly amount of data transfer, in GB, allocated for the instance.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-networking.html#cfn-lightsail-instance-networking-monthlytransfer
//
MonthlyTransfer interface{} `field:"optional" json:"monthlyTransfer" yaml:"monthlyTransfer"`
}
`Networking` is a property of the [AWS::Lightsail::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html) resource. It describes the public ports and the monthly amount of data transfer allocated for the instance.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
networkingProperty := &NetworkingProperty{
Ports: []interface{}{
&PortProperty{
AccessDirection: jsii.String("accessDirection"),
AccessFrom: jsii.String("accessFrom"),
AccessType: jsii.String("accessType"),
CidrListAliases: []*string{
jsii.String("cidrListAliases"),
},
Cidrs: []*string{
jsii.String("cidrs"),
},
CommonName: jsii.String("commonName"),
FromPort: jsii.Number(123),
Ipv6Cidrs: []*string{
jsii.String("ipv6Cidrs"),
},
Protocol: jsii.String("protocol"),
ToPort: jsii.Number(123),
},
},
// the properties below are optional
MonthlyTransfer: &MonthlyTransferProperty{
GbPerMonthAllocated: jsii.String("gbPerMonthAllocated"),
},
}
type CfnInstance_PortProperty ¶
type CfnInstance_PortProperty struct {
// The access direction ( `inbound` or `outbound` ).
//
// > Lightsail currently supports only `inbound` access direction.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-port.html#cfn-lightsail-instance-port-accessdirection
//
AccessDirection *string `field:"optional" json:"accessDirection" yaml:"accessDirection"`
// The location from which access is allowed.
//
// For example, `Anywhere (0.0.0.0/0)` , or `Custom` if a specific IP address or range of IP addresses is allowed.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-port.html#cfn-lightsail-instance-port-accessfrom
//
AccessFrom *string `field:"optional" json:"accessFrom" yaml:"accessFrom"`
// The type of access ( `Public` or `Private` ).
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-port.html#cfn-lightsail-instance-port-accesstype
//
AccessType *string `field:"optional" json:"accessType" yaml:"accessType"`
// An alias that defines access for a preconfigured range of IP addresses.
//
// The only alias currently supported is `lightsail-connect` , which allows IP addresses of the browser-based RDP/SSH client in the Lightsail console to connect to your instance.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-port.html#cfn-lightsail-instance-port-cidrlistaliases
//
CidrListAliases *[]*string `field:"optional" json:"cidrListAliases" yaml:"cidrListAliases"`
// The IPv4 address, or range of IPv4 addresses (in CIDR notation) that are allowed to connect to an instance through the ports, and the protocol.
//
// > The `ipv6Cidrs` parameter lists the IPv6 addresses that are allowed to connect to an instance.
//
// Examples:
//
// - To allow the IP address `192.0.2.44` , specify `192.0.2.44` or `192.0.2.44/32` .
// - To allow the IP addresses `192.0.2.0` to `192.0.2.255` , specify `192.0.2.0/24` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-port.html#cfn-lightsail-instance-port-cidrs
//
Cidrs *[]*string `field:"optional" json:"cidrs" yaml:"cidrs"`
// The common name of the port information.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-port.html#cfn-lightsail-instance-port-commonname
//
CommonName *string `field:"optional" json:"commonName" yaml:"commonName"`
// The first port in a range of open ports on an instance.
//
// Allowed ports:
//
// - TCP and UDP - `0` to `65535`
// - ICMP - The ICMP type for IPv4 addresses. For example, specify `8` as the `fromPort` (ICMP type), and `-1` as the `toPort` (ICMP code), to enable ICMP Ping.
// - ICMPv6 - The ICMP type for IPv6 addresses. For example, specify `128` as the `fromPort` (ICMPv6 type), and `0` as `toPort` (ICMPv6 code).
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-port.html#cfn-lightsail-instance-port-fromport
//
FromPort *float64 `field:"optional" json:"fromPort" yaml:"fromPort"`
// The IPv6 address, or range of IPv6 addresses (in CIDR notation) that are allowed to connect to an instance through the ports, and the protocol.
//
// Only devices with an IPv6 address can connect to an instance through IPv6; otherwise, IPv4 should be used.
//
// > The `cidrs` parameter lists the IPv4 addresses that are allowed to connect to an instance.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-port.html#cfn-lightsail-instance-port-ipv6cidrs
//
Ipv6Cidrs *[]*string `field:"optional" json:"ipv6Cidrs" yaml:"ipv6Cidrs"`
// The IP protocol name.
//
// The name can be one of the following:
//
// - `tcp` - Transmission Control Protocol (TCP) provides reliable, ordered, and error-checked delivery of streamed data between applications running on hosts communicating by an IP network. If you have an application that doesn't require reliable data stream service, use UDP instead.
// - `all` - All transport layer protocol types.
// - `udp` - With User Datagram Protocol (UDP), computer applications can send messages (or datagrams) to other hosts on an Internet Protocol (IP) network. Prior communications are not required to set up transmission channels or data paths. Applications that don't require reliable data stream service can use UDP, which provides a connectionless datagram service that emphasizes reduced latency over reliability. If you do require reliable data stream service, use TCP instead.
// - `icmp` - Internet Control Message Protocol (ICMP) is used to send error messages and operational information indicating success or failure when communicating with an instance. For example, an error is indicated when an instance could not be reached. When you specify `icmp` as the `protocol` , you must specify the ICMP type using the `fromPort` parameter, and ICMP code using the `toPort` parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-port.html#cfn-lightsail-instance-port-protocol
//
Protocol *string `field:"optional" json:"protocol" yaml:"protocol"`
// The last port in a range of open ports on an instance.
//
// Allowed ports:
//
// - TCP and UDP - `0` to `65535`
// - ICMP - The ICMP code for IPv4 addresses. For example, specify `8` as the `fromPort` (ICMP type), and `-1` as the `toPort` (ICMP code), to enable ICMP Ping.
// - ICMPv6 - The ICMP code for IPv6 addresses. For example, specify `128` as the `fromPort` (ICMPv6 type), and `0` as `toPort` (ICMPv6 code).
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-port.html#cfn-lightsail-instance-port-toport
//
ToPort *float64 `field:"optional" json:"toPort" yaml:"toPort"`
}
`Port` is a property of the [Networking](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-networking.html) property. It describes information about ports for an instance.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
portProperty := &PortProperty{
AccessDirection: jsii.String("accessDirection"),
AccessFrom: jsii.String("accessFrom"),
AccessType: jsii.String("accessType"),
CidrListAliases: []*string{
jsii.String("cidrListAliases"),
},
Cidrs: []*string{
jsii.String("cidrs"),
},
CommonName: jsii.String("commonName"),
FromPort: jsii.Number(123),
Ipv6Cidrs: []*string{
jsii.String("ipv6Cidrs"),
},
Protocol: jsii.String("protocol"),
ToPort: jsii.Number(123),
}
type CfnInstance_StateProperty ¶
type CfnInstance_StateProperty struct {
// The status code of the instance.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-state.html#cfn-lightsail-instance-state-code
//
Code *float64 `field:"optional" json:"code" yaml:"code"`
// The state of the instance (for example, `running` or `pending` ).
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-state.html#cfn-lightsail-instance-state-name
//
Name *string `field:"optional" json:"name" yaml:"name"`
}
`State` is a property of the [AWS::Lightsail::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instance.html) resource. It describes the status code and the state (for example, `running` ) of an instance.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
stateProperty := &StateProperty{
Code: jsii.Number(123),
Name: jsii.String("name"),
}
type CfnLoadBalancer ¶ added in v2.9.0
type CfnLoadBalancer interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggable
// The Lightsail instances to attach to the load balancer.
AttachedInstances() *[]*string
SetAttachedInstances(val *[]*string)
// The Amazon Resource Name (ARN) of the load balancer.
AttrLoadBalancerArn() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
// The path on the attached instance where the health check will be performed.
HealthCheckPath() *string
SetHealthCheckPath(val *string)
// The port that the load balancer uses to direct traffic to your Lightsail instances.
InstancePort() *float64
SetInstancePort(val *float64)
// The IP address type of the load balancer.
IpAddressType() *string
SetIpAddressType(val *string)
// The name of the load balancer.
LoadBalancerName() *string
SetLoadBalancerName(val *string)
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The tree node.
Node() constructs.Node
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
Ref() *string
// A Boolean value indicating whether session stickiness is enabled.
SessionStickinessEnabled() interface{}
SetSessionStickinessEnabled(val interface{})
// The time period, in seconds, after which the load balancer session stickiness cookie should be considered stale.
SessionStickinessLbCookieDurationSeconds() *string
SetSessionStickinessLbCookieDurationSeconds(val *string)
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
// An array of key-value pairs to apply to this resource.
TagsRaw() *[]*awscdk.CfnTag
SetTagsRaw(val *[]*awscdk.CfnTag)
// The name of the TLS security policy for the load balancer.
TlsPolicyName() *string
SetTlsPolicyName(val *string)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// 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`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
The `AWS::Lightsail::LoadBalancer` resource specifies a load balancer that can be used with Lightsail instances.
> You cannot attach a TLS certificate to a load balancer using the `AWS::Lightsail::LoadBalancer` resource type. Instead, use the `AWS::Lightsail::LoadBalancerTlsCertificate` resource type to create a certificate and attach it to a load balancer.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnLoadBalancer := awscdk.Aws_lightsail.NewCfnLoadBalancer(this, jsii.String("MyCfnLoadBalancer"), &CfnLoadBalancerProps{
InstancePort: jsii.Number(123),
LoadBalancerName: jsii.String("loadBalancerName"),
// the properties below are optional
AttachedInstances: []*string{
jsii.String("attachedInstances"),
},
HealthCheckPath: jsii.String("healthCheckPath"),
IpAddressType: jsii.String("ipAddressType"),
SessionStickinessEnabled: jsii.Boolean(false),
SessionStickinessLbCookieDurationSeconds: jsii.String("sessionStickinessLbCookieDurationSeconds"),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
TlsPolicyName: jsii.String("tlsPolicyName"),
})
func NewCfnLoadBalancer ¶ added in v2.9.0
func NewCfnLoadBalancer(scope constructs.Construct, id *string, props *CfnLoadBalancerProps) CfnLoadBalancer
type CfnLoadBalancerProps ¶ added in v2.9.0
type CfnLoadBalancerProps struct {
// The port that the load balancer uses to direct traffic to your Lightsail instances.
//
// For HTTP traffic, specify port `80` . For HTTPS traffic, specify port `443` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-loadbalancer.html#cfn-lightsail-loadbalancer-instanceport
//
InstancePort *float64 `field:"required" json:"instancePort" yaml:"instancePort"`
// The name of the load balancer.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-loadbalancer.html#cfn-lightsail-loadbalancer-loadbalancername
//
LoadBalancerName *string `field:"required" json:"loadBalancerName" yaml:"loadBalancerName"`
// The Lightsail instances to attach to the load balancer.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-loadbalancer.html#cfn-lightsail-loadbalancer-attachedinstances
//
AttachedInstances *[]*string `field:"optional" json:"attachedInstances" yaml:"attachedInstances"`
// The path on the attached instance where the health check will be performed.
//
// If no path is specified, the load balancer tries to make a request to the default (root) page ( `/index.html` ).
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-loadbalancer.html#cfn-lightsail-loadbalancer-healthcheckpath
//
HealthCheckPath *string `field:"optional" json:"healthCheckPath" yaml:"healthCheckPath"`
// The IP address type of the load balancer.
//
// The possible values are `ipv4` for IPv4 only, and `dualstack` for both IPv4 and IPv6.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-loadbalancer.html#cfn-lightsail-loadbalancer-ipaddresstype
//
IpAddressType *string `field:"optional" json:"ipAddressType" yaml:"ipAddressType"`
// A Boolean value indicating whether session stickiness is enabled.
//
// Enable session stickiness (also known as *session affinity* ) to bind a user's session to a specific instance. This ensures that all requests from the user during the session are sent to the same instance.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-loadbalancer.html#cfn-lightsail-loadbalancer-sessionstickinessenabled
//
SessionStickinessEnabled interface{} `field:"optional" json:"sessionStickinessEnabled" yaml:"sessionStickinessEnabled"`
// The time period, in seconds, after which the load balancer session stickiness cookie should be considered stale.
//
// If you do not specify this parameter, the default value is 0, which indicates that the sticky session should last for the duration of the browser session.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-loadbalancer.html#cfn-lightsail-loadbalancer-sessionstickinesslbcookiedurationseconds
//
SessionStickinessLbCookieDurationSeconds *string `field:"optional" json:"sessionStickinessLbCookieDurationSeconds" yaml:"sessionStickinessLbCookieDurationSeconds"`
// An array of key-value pairs to apply to this resource.
//
// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) in the *AWS CloudFormation User Guide* .
//
// > The `Value` of `Tags` is optional for Lightsail resources.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-loadbalancer.html#cfn-lightsail-loadbalancer-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
// The name of the TLS security policy for the load balancer.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-loadbalancer.html#cfn-lightsail-loadbalancer-tlspolicyname
//
TlsPolicyName *string `field:"optional" json:"tlsPolicyName" yaml:"tlsPolicyName"`
}
Properties for defining a `CfnLoadBalancer`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnLoadBalancerProps := &CfnLoadBalancerProps{
InstancePort: jsii.Number(123),
LoadBalancerName: jsii.String("loadBalancerName"),
// the properties below are optional
AttachedInstances: []*string{
jsii.String("attachedInstances"),
},
HealthCheckPath: jsii.String("healthCheckPath"),
IpAddressType: jsii.String("ipAddressType"),
SessionStickinessEnabled: jsii.Boolean(false),
SessionStickinessLbCookieDurationSeconds: jsii.String("sessionStickinessLbCookieDurationSeconds"),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
TlsPolicyName: jsii.String("tlsPolicyName"),
}
type CfnLoadBalancerTlsCertificate ¶ added in v2.9.0
type CfnLoadBalancerTlsCertificate interface {
awscdk.CfnResource
awscdk.IInspectable
// The Amazon Resource Name (ARN) of the SSL/TLS certificate.
AttrLoadBalancerTlsCertificateArn() *string
// The validation status of the SSL/TLS certificate.
//
// Valid Values: `PENDING_VALIDATION` | `ISSUED` | `INACTIVE` | `EXPIRED` | `VALIDATION_TIMED_OUT` | `REVOKED` | `FAILED` | `UNKNOWN`.
AttrStatus() *string
// An array of alternative domain names and subdomain names for your SSL/TLS certificate.
CertificateAlternativeNames() *[]*string
SetCertificateAlternativeNames(val *[]*string)
// The domain name for the SSL/TLS certificate.
CertificateDomainName() *string
SetCertificateDomainName(val *string)
// The name of the SSL/TLS certificate.
CertificateName() *string
SetCertificateName(val *string)
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
// A Boolean value indicating whether HTTPS redirection is enabled for the load balancer that the TLS certificate is attached to.
HttpsRedirectionEnabled() interface{}
SetHttpsRedirectionEnabled(val interface{})
// A Boolean value indicating whether the SSL/TLS certificate is attached to a Lightsail load balancer.
IsAttached() interface{}
SetIsAttached(val interface{})
// The name of the load balancer that the SSL/TLS certificate is attached to.
LoadBalancerName() *string
SetLoadBalancerName(val *string)
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The tree node.
Node() constructs.Node
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// 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`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
The `AWS::Lightsail::LoadBalancerTlsCertificate` resource specifies a TLS certificate that can be used with a Lightsail load balancer.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnLoadBalancerTlsCertificate := awscdk.Aws_lightsail.NewCfnLoadBalancerTlsCertificate(this, jsii.String("MyCfnLoadBalancerTlsCertificate"), &CfnLoadBalancerTlsCertificateProps{
CertificateDomainName: jsii.String("certificateDomainName"),
CertificateName: jsii.String("certificateName"),
LoadBalancerName: jsii.String("loadBalancerName"),
// the properties below are optional
CertificateAlternativeNames: []*string{
jsii.String("certificateAlternativeNames"),
},
HttpsRedirectionEnabled: jsii.Boolean(false),
IsAttached: jsii.Boolean(false),
})
func NewCfnLoadBalancerTlsCertificate ¶ added in v2.9.0
func NewCfnLoadBalancerTlsCertificate(scope constructs.Construct, id *string, props *CfnLoadBalancerTlsCertificateProps) CfnLoadBalancerTlsCertificate
type CfnLoadBalancerTlsCertificateProps ¶ added in v2.9.0
type CfnLoadBalancerTlsCertificateProps struct {
// The domain name for the SSL/TLS certificate.
//
// For example, `example.com` or `www.example.com` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-loadbalancertlscertificate.html#cfn-lightsail-loadbalancertlscertificate-certificatedomainname
//
CertificateDomainName *string `field:"required" json:"certificateDomainName" yaml:"certificateDomainName"`
// The name of the SSL/TLS certificate.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-loadbalancertlscertificate.html#cfn-lightsail-loadbalancertlscertificate-certificatename
//
CertificateName *string `field:"required" json:"certificateName" yaml:"certificateName"`
// The name of the load balancer that the SSL/TLS certificate is attached to.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-loadbalancertlscertificate.html#cfn-lightsail-loadbalancertlscertificate-loadbalancername
//
LoadBalancerName *string `field:"required" json:"loadBalancerName" yaml:"loadBalancerName"`
// An array of alternative domain names and subdomain names for your SSL/TLS certificate.
//
// In addition to the primary domain name, you can have up to nine alternative domain names. Wildcards (such as `*.example.com` ) are not supported.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-loadbalancertlscertificate.html#cfn-lightsail-loadbalancertlscertificate-certificatealternativenames
//
CertificateAlternativeNames *[]*string `field:"optional" json:"certificateAlternativeNames" yaml:"certificateAlternativeNames"`
// A Boolean value indicating whether HTTPS redirection is enabled for the load balancer that the TLS certificate is attached to.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-loadbalancertlscertificate.html#cfn-lightsail-loadbalancertlscertificate-httpsredirectionenabled
//
HttpsRedirectionEnabled interface{} `field:"optional" json:"httpsRedirectionEnabled" yaml:"httpsRedirectionEnabled"`
// A Boolean value indicating whether the SSL/TLS certificate is attached to a Lightsail load balancer.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-loadbalancertlscertificate.html#cfn-lightsail-loadbalancertlscertificate-isattached
//
IsAttached interface{} `field:"optional" json:"isAttached" yaml:"isAttached"`
}
Properties for defining a `CfnLoadBalancerTlsCertificate`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnLoadBalancerTlsCertificateProps := &CfnLoadBalancerTlsCertificateProps{
CertificateDomainName: jsii.String("certificateDomainName"),
CertificateName: jsii.String("certificateName"),
LoadBalancerName: jsii.String("loadBalancerName"),
// the properties below are optional
CertificateAlternativeNames: []*string{
jsii.String("certificateAlternativeNames"),
},
HttpsRedirectionEnabled: jsii.Boolean(false),
IsAttached: jsii.Boolean(false),
}
type CfnStaticIp ¶
type CfnStaticIp interface {
awscdk.CfnResource
awscdk.IInspectable
// The instance that the static IP is attached to.
AttachedTo() *string
SetAttachedTo(val *string)
// The IP address of the static IP.
AttrIpAddress() *string
// A Boolean value indicating whether the static IP is attached to an instance.
AttrIsAttached() awscdk.IResolvable
// The Amazon Resource Name (ARN) of the static IP (for example, `arn:aws:lightsail:us-east-2:123456789101:StaticIp/244ad76f-8aad-4741-809f-12345EXAMPLE` ).
AttrStaticIpArn() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The tree node.
Node() constructs.Node
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// The name of the static IP.
StaticIpName() *string
SetStaticIpName(val *string)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// 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`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
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.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnStaticIp := awscdk.Aws_lightsail.NewCfnStaticIp(this, jsii.String("MyCfnStaticIp"), &CfnStaticIpProps{
StaticIpName: jsii.String("staticIpName"),
// the properties below are optional
AttachedTo: jsii.String("attachedTo"),
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-staticip.html
func NewCfnStaticIp ¶
func NewCfnStaticIp(scope constructs.Construct, id *string, props *CfnStaticIpProps) CfnStaticIp
type CfnStaticIpProps ¶
type CfnStaticIpProps struct {
// The name of the static IP.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-staticip.html#cfn-lightsail-staticip-staticipname
//
StaticIpName *string `field:"required" json:"staticIpName" yaml:"staticIpName"`
// The instance that the static IP is attached to.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-staticip.html#cfn-lightsail-staticip-attachedto
//
AttachedTo *string `field:"optional" json:"attachedTo" yaml:"attachedTo"`
}
Properties for defining a `CfnStaticIp`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnStaticIpProps := &CfnStaticIpProps{
StaticIpName: jsii.String("staticIpName"),
// the properties below are optional
AttachedTo: jsii.String("attachedTo"),
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-staticip.html
Source Files
¶
- CfnAlarm.go
- CfnAlarmProps.go
- CfnAlarm__checks.go
- CfnBucket.go
- CfnBucketProps.go
- CfnBucket_AccessRulesProperty.go
- CfnBucket__checks.go
- CfnCertificate.go
- CfnCertificateProps.go
- CfnCertificate__checks.go
- CfnContainer.go
- CfnContainerProps.go
- CfnContainer_ContainerProperty.go
- CfnContainer_ContainerServiceDeploymentProperty.go
- CfnContainer_EcrImagePullerRoleProperty.go
- CfnContainer_EnvironmentVariableProperty.go
- CfnContainer_HealthCheckConfigProperty.go
- CfnContainer_PortInfoProperty.go
- CfnContainer_PrivateRegistryAccessProperty.go
- CfnContainer_PublicDomainNameProperty.go
- CfnContainer_PublicEndpointProperty.go
- CfnContainer__checks.go
- CfnDatabase.go
- CfnDatabaseProps.go
- CfnDatabase_RelationalDatabaseParameterProperty.go
- CfnDatabase__checks.go
- CfnDisk.go
- CfnDiskProps.go
- CfnDisk_AddOnProperty.go
- CfnDisk_AutoSnapshotAddOnProperty.go
- CfnDisk_LocationProperty.go
- CfnDisk__checks.go
- CfnDistribution.go
- CfnDistributionProps.go
- CfnDistribution_CacheBehaviorPerPathProperty.go
- CfnDistribution_CacheBehaviorProperty.go
- CfnDistribution_CacheSettingsProperty.go
- CfnDistribution_CookieObjectProperty.go
- CfnDistribution_HeaderObjectProperty.go
- CfnDistribution_InputOriginProperty.go
- CfnDistribution_QueryStringObjectProperty.go
- CfnDistribution__checks.go
- CfnInstance.go
- CfnInstanceProps.go
- CfnInstance_AddOnProperty.go
- CfnInstance_AutoSnapshotAddOnProperty.go
- CfnInstance_DiskProperty.go
- CfnInstance_HardwareProperty.go
- CfnInstance_LocationProperty.go
- CfnInstance_MonthlyTransferProperty.go
- CfnInstance_NetworkingProperty.go
- CfnInstance_PortProperty.go
- CfnInstance_StateProperty.go
- CfnInstance__checks.go
- CfnLoadBalancer.go
- CfnLoadBalancerProps.go
- CfnLoadBalancerTlsCertificate.go
- CfnLoadBalancerTlsCertificateProps.go
- CfnLoadBalancerTlsCertificate__checks.go
- CfnLoadBalancer__checks.go
- CfnStaticIp.go
- CfnStaticIpProps.go
- CfnStaticIp__checks.go
- main.go
Directories
Click to show internal directories.
Click to hide internal directories.