README
¶
Amazon EC2 Construct Library
The aws-cdk-lib/aws-ec2 package contains primitives for setting up networking and
instances.
import ec2 "github.com/aws/aws-cdk-go/awscdk"
VPC
Most projects need a Virtual Private Cloud to provide security by means of
network partitioning. This is achieved by creating an instance of
Vpc:
vpc := ec2.NewVpc(this, jsii.String("VPC"))
All default constructs require EC2 instances to be launched inside a VPC, so you should generally start by defining a VPC whenever you need to launch instances for your project.
Subnet Types
A VPC consists of one or more subnets that instances can be placed into. CDK distinguishes three different subnet types:
- Public (
SubnetType.PUBLIC) - public subnets connect directly to the Internet using an Internet Gateway. If you want your instances to have a public IP address and be directly reachable from the Internet, you must place them in a public subnet. - Private with Internet Access (
SubnetType.PRIVATE_WITH_EGRESS) - instances in private subnets are not directly routable from the Internet, and you must provide a way to connect out to the Internet. By default, a NAT gateway is created in every public subnet for maximum availability. Be aware that you will be charged for NAT gateways. Alternatively you can setnatGateways:0and provide your own egress configuration (i.e through Transit Gateway) - Isolated (
SubnetType.PRIVATE_ISOLATED) - isolated subnets do not route from or to the Internet, and as such do not require NAT gateways. They can only connect to or be connected to from other instances in the same VPC. A default VPC configuration will not include isolated subnets,
A default VPC configuration will create public and private subnets. However, if
natGateways:0 and subnetConfiguration is undefined, default VPC configuration
will create public and isolated subnets. See Advanced Subnet Configuration
below for information on how to change the default subnet configuration.
Constructs using the VPC will "launch instances" (or more accurately, create
Elastic Network Interfaces) into one or more of the subnets. They all accept
a property called subnetSelection (sometimes called vpcSubnets) to allow
you to select in what subnet to place the ENIs, usually defaulting to
private subnets if the property is omitted.
If you would like to save on the cost of NAT gateways, you can use
isolated subnets instead of private subnets (as described in Advanced
Subnet Configuration). If you need private instances to have
internet connectivity, another option is to reduce the number of NAT gateways
created by setting the natGateways property to a lower value (the default
is one NAT gateway per availability zone). Be aware that this may have
availability implications for your application.
Control over availability zones
By default, a VPC will spread over at most 3 Availability Zones available to
it. To change the number of Availability Zones that the VPC will spread over,
specify the maxAzs property when defining it.
The number of Availability Zones that are available depends on the region
and account of the Stack containing the VPC. If the region and account are
specified on
the Stack, the CLI will look up the existing Availability
Zones
and get an accurate count. The result of this operation will be written to a file
called cdk.context.json. You must commit this file to source control so
that the lookup values are available in non-privileged environments such
as CI build steps, and to ensure your template builds are repeatable.
If region and account are not specified, the stack could be deployed anywhere and it will have to make a safe choice, limiting itself to 2 Availability Zones.
Therefore, to get the VPC to spread over 3 or more availability zones, you must specify the environment where the stack will be deployed.
You can gain full control over the availability zones selection strategy by overriding the Stack's get availabilityZones() method:
// This example is only available in TypeScript
class MyStack extends Stack {
constructor(scope: Construct, id: string, props?: StackProps) {
super(scope, id, props);
// ...
}
get availabilityZones(): string[] {
return ['us-west-2a', 'us-west-2b'];
}
}
Note that overriding the get availabilityZones() method will override the default behavior for all constructs defined within the Stack.
Choosing subnets for resources
When creating resources that create Elastic Network Interfaces (such as
databases or instances), there is an option to choose which subnets to place
them in. For example, a VPC endpoint by default is placed into a subnet in
every availability zone, but you can override which subnets to use. The property
is typically called one of subnets, vpcSubnets or subnetSelection.
The example below will place the endpoint into two AZs (us-east-1a and us-east-1c),
in Isolated subnets:
var vpc vpc
ec2.NewInterfaceVpcEndpoint(this, jsii.String("VPC Endpoint"), &InterfaceVpcEndpointProps{
Vpc: Vpc,
Service: ec2.NewInterfaceVpcEndpointService(jsii.String("com.amazonaws.vpce.us-east-1.vpce-svc-uuddlrlrbastrtsvc"), jsii.Number(443)),
Subnets: &SubnetSelection{
SubnetType: ec2.SubnetType_PRIVATE_ISOLATED,
AvailabilityZones: []*string{
jsii.String("us-east-1a"),
jsii.String("us-east-1c"),
},
},
})
You can also specify specific subnet objects for granular control:
var vpc vpc
var subnet1 subnet
var subnet2 subnet
ec2.NewInterfaceVpcEndpoint(this, jsii.String("VPC Endpoint"), &InterfaceVpcEndpointProps{
Vpc: Vpc,
Service: ec2.NewInterfaceVpcEndpointService(jsii.String("com.amazonaws.vpce.us-east-1.vpce-svc-uuddlrlrbastrtsvc"), jsii.Number(443)),
Subnets: &SubnetSelection{
Subnets: []iSubnet{
subnet1,
subnet2,
},
},
})
Which subnets are selected is evaluated as follows:
-
subnets: if specific subnet objects are supplied, these are selected, and no other logic is used. -
subnetType/subnetGroupName: otherwise, a set of subnets is selected by supplying either type or name:subnetTypewill select all subnets of the given type.subnetGroupNameshould be used to distinguish between multiple groups of subnets of the same type (for example, you may want to separate your application instances and your RDS instances into two distinct groups of Isolated subnets).- If neither are given, the first available subnet group of a given type that exists in the VPC will be used, in this order: Private, then Isolated, then Public. In short: by default ENIs will preferentially be placed in subnets not connected to the Internet.
-
availabilityZones/onePerAz: finally, some availability-zone based filtering may be done. This filtering by availability zones will only be possible if the VPC has been created or looked up in a non-environment agnostic stack (so account and region have been set and availability zones have been looked up).availabilityZones: only the specific subnets from the selected subnet groups that are in the given availability zones will be returned.onePerAz: per availability zone, a maximum of one subnet will be returned (Useful for resource types that do not allow creating two ENIs in the same availability zone).
-
subnetFilters: additional filtering on subnets using any number of user-provided filters which extendSubnetFilter. The following methods on theSubnetFilterclass can be used to create a filter:byIds: chooses subnets from a list of idsavailabilityZones: chooses subnets in the provided list of availability zonesonePerAz: chooses at most one subnet per availability zonecontainsIpAddresses: chooses a subnet which contains any of the listed ip addressesbyCidrMask: chooses subnets that have the provided CIDR netmaskbyCidrRanges: chooses subnets which are inside any of the specified CIDR ranges
Using NAT instances
By default, the Vpc construct will create NAT gateways for you, which
are managed by AWS. If you would prefer to use your own managed NAT
instances instead, specify a different value for the natGatewayProvider
property, as follows:
The construct will automatically selects the latest version of Amazon Linux 2023.
If you prefer to use a custom AMI, use machineImage: MachineImage.genericLinux({ ... }) and configure the right AMI ID for the
regions you want to deploy to.
Warning The NAT instances created using this method will be unmonitored. They are not part of an Auto Scaling Group, and if they become unavailable or are terminated for any reason, will not be restarted or replaced.
By default, the NAT instances will route all traffic. To control what traffic
gets routed, pass a custom value for defaultAllowedTraffic and access the
NatInstanceProvider.connections member after having passed the NAT provider to
the VPC:
var instanceType instanceType
provider := ec2.NatProvider_InstanceV2(&NatInstanceProps{
InstanceType: InstanceType,
DefaultAllowedTraffic: ec2.NatTrafficDirection_OUTBOUND_ONLY,
})
ec2.NewVpc(this, jsii.String("TheVPC"), &VpcProps{
NatGatewayProvider: provider,
})
provider.connections.AllowFrom(ec2.Peer_Ipv4(jsii.String("1.2.3.4/8")), ec2.Port_HTTP())
You can also customize the characteristics of your NAT instances, including their security group, as well as their initialization scripts:
var bucket bucket
userData := ec2.UserData_ForLinux()
userData.AddCommands(
(SpreadElement ...ec2.NatInstanceProviderV2.DEFAULT_USER_DATA_COMMANDS
ec2.NatInstanceProviderV2_DEFAULT_USER_DATA_COMMANDS()), jsii.String("echo \"hello world!\" > hello.txt"),
fmt.Sprintf("aws s3 cp hello.txt s3://%v", bucket.BucketName))
provider := ec2.NatProvider_InstanceV2(&NatInstanceProps{
InstanceType: ec2.NewInstanceType(jsii.String("t3.small")),
CreditSpecification: ec2.CpuCredits_UNLIMITED,
DefaultAllowedTraffic: ec2.NatTrafficDirection_NONE,
})
vpc := ec2.NewVpc(this, jsii.String("TheVPC"), &VpcProps{
NatGatewayProvider: provider,
NatGateways: jsii.Number(2),
})
securityGroup := ec2.NewSecurityGroup(this, jsii.String("SecurityGroup"), &SecurityGroupProps{
Vpc: Vpc,
})
securityGroup.AddEgressRule(ec2.Peer_AnyIpv4(), ec2.Port_Tcp(jsii.Number(443)))
for _, gateway := range provider.gatewayInstances {
bucket.GrantWrite(gateway)
gateway.AddSecurityGroup(securityGroup)
}
// Configure the `natGatewayProvider` when defining a Vpc
natGatewayProvider := ec2.NatProvider_Instance(&NatInstanceProps{
InstanceType: ec2.NewInstanceType(jsii.String("t3.small")),
})
vpc := ec2.NewVpc(this, jsii.String("MyVpc"), &VpcProps{
NatGatewayProvider: NatGatewayProvider,
// The 'natGateways' parameter now controls the number of NAT instances
NatGateways: jsii.Number(2),
})
The V1 NatProvider.instance construct will use the AWS official NAT instance AMI, which has already
reached EOL on Dec 31, 2023. For more information, see the following blog post:
Amazon Linux AMI end of life.
var instanceType instanceType
provider := ec2.NatProvider_Instance(&NatInstanceProps{
InstanceType: InstanceType,
DefaultAllowedTraffic: ec2.NatTrafficDirection_OUTBOUND_ONLY,
})
ec2.NewVpc(this, jsii.String("TheVPC"), &VpcProps{
NatGatewayProvider: provider,
})
provider.connections.AllowFrom(ec2.Peer_Ipv4(jsii.String("1.2.3.4/8")), ec2.Port_HTTP())
Ip Address Management
The VPC spans a supernet IP range, which contains the non-overlapping IPs of its contained subnets. Possible sources for this IP range are:
- You specify an IP range directly by specifying a CIDR
- You allocate an IP range of a given size automatically from AWS IPAM
By default the Vpc will allocate the 10.0.0.0/16 address range which will be exhaustively spread across all subnets in the subnet configuration. This behavior can be changed by passing an object that implements IIpAddresses to the ipAddress property of a Vpc. See the subsequent sections for the options.
Be aware that if you don't explicitly reserve subnet groups in subnetConfiguration, the address space will be fully allocated! If you predict you may need to add more subnet groups later, add them early on and set reserved: true (see the "Advanced Subnet Configuration" section for more information).
Specifying a CIDR directly
Use IpAddresses.cidr to define a Cidr range for your Vpc directly in code:
import "github.com/aws/aws-cdk-go/awscdk"
ec2.NewVpc(this, jsii.String("TheVPC"), &VpcProps{
IpAddresses: awscdk.IpAddresses_Cidr(jsii.String("10.0.1.0/20")),
})
Space will be allocated to subnets in the following order:
- First, spaces is allocated for all subnets groups that explicitly have a
cidrMaskset as part of their configuration (including reserved subnets). - Afterwards, any remaining space is divided evenly between the rest of the subnets (if any).
The argument to IpAddresses.cidr may not be a token, and concrete Cidr values are generated in the synthesized CloudFormation template.
Allocating an IP range from AWS IPAM
Amazon VPC IP Address Manager (IPAM) manages a large IP space, from which chunks can be allocated for use in the Vpc. For information on Amazon VPC IP Address Manager please see the official documentation. An example of allocating from AWS IPAM looks like this:
import "github.com/aws/aws-cdk-go/awscdk"
var pool cfnIPAMPool
ec2.NewVpc(this, jsii.String("TheVPC"), &VpcProps{
IpAddresses: awscdk.IpAddresses_AwsIpamAllocation(&AwsIpamProps{
Ipv4IpamPoolId: pool.ref,
Ipv4NetmaskLength: jsii.Number(18),
DefaultSubnetIpv4NetmaskLength: jsii.Number(24),
}),
})
IpAddresses.awsIpamAllocation requires the following:
ipv4IpamPoolId, the id of an IPAM Pool from which the VPC range should be allocated.ipv4NetmaskLength, the size of the IP range that will be requested from the Pool at deploy time.defaultSubnetIpv4NetmaskLength, the size of subnets in groups that don't havecidrMaskset.
With this method of IP address management, no attempt is made to guess at subnet group sizes or to exhaustively allocate the IP range. All subnet groups must have an explicit cidrMask set as part of their subnet configuration, or defaultSubnetIpv4NetmaskLength must be set for a default size. If not, synthesis will fail and you must provide one or the other.
Dual Stack configuration
To allocate both IPv4 and IPv6 addresses in your VPC, you can configure your VPC to have a dual stack protocol.
ec2.NewVpc(this, jsii.String("DualStackVpc"), &VpcProps{
IpProtocol: ec2.IpProtocol_DUAL_STACK,
})
By default, a dual stack VPC will create an Amazon provided IPv6 /56 CIDR block associated to the VPC. It will then assign /64 portions of the block to each subnet. For each subnet, auto-assigning an IPv6 address will be enabled, and auto-asigning a public IPv4 address will be disabled. An egress only internet gateway will be created for PRIVATE_WITH_EGRESS subnets, and IPv6 routes will be added for IGWs and EIGWs.
Disabling the auto-assigning of a public IPv4 address by default can avoid the cost of public IPv4 addresses starting 2/1/2024. For use cases that need an IPv4 address, the mapPublicIpOnLaunch property in subnetConfiguration can be set to auto-assign the IPv4 address. Note that private IPv4 address allocation will not be changed.
See Advanced Subnet Configuration for all IPv6 specific properties.
Reserving availability zones
There are situations where the IP space for availability zones will
need to be reserved. This is useful in situations where availability
zones would need to be added after the vpc is originally deployed,
without causing IP renumbering for availability zones subnets. The IP
space for reserving n availability zones can be done by setting the
reservedAzs to n in vpc props, as shown below:
vpc := ec2.NewVpc(this, jsii.String("TheVPC"), &VpcProps{
Cidr: jsii.String("10.0.0.0/21"),
MaxAzs: jsii.Number(3),
ReservedAzs: jsii.Number(1),
})
In the example above, the subnets for reserved availability zones is not
actually provisioned but its IP space is still reserved. If, in the future,
new availability zones needs to be provisioned, then we would decrement
the value of reservedAzs and increment the maxAzs or availabilityZones
accordingly. This action would not cause the IP address of subnets to get
renumbered, but rather the IP space that was previously reserved will be
used for the new availability zones subnets.
Advanced Subnet Configuration
If the default VPC configuration (public and private subnets spanning the
size of the VPC) don't suffice for you, you can configure what subnets to
create by specifying the subnetConfiguration property. It allows you
to configure the number and size of all subnets. Specifying an advanced
subnet configuration could look like this:
vpc := ec2.NewVpc(this, jsii.String("TheVPC"), &VpcProps{
// 'IpAddresses' configures the IP range and size of the entire VPC.
// The IP space will be divided based on configuration for the subnets.
IpAddresses: ec2.IpAddresses_Cidr(jsii.String("10.0.0.0/21")),
// 'maxAzs' configures the maximum number of availability zones to use.
// If you want to specify the exact availability zones you want the VPC
// to use, use `availabilityZones` instead.
MaxAzs: jsii.Number(3),
// 'subnetConfiguration' specifies the "subnet groups" to create.
// Every subnet group will have a subnet for each AZ, so this
// configuration will create `3 groups × 3 AZs = 9` subnets.
SubnetConfiguration: []subnetConfiguration{
&subnetConfiguration{
// 'subnetType' controls Internet access, as described above.
SubnetType: ec2.SubnetType_PUBLIC,
// 'name' is used to name this particular subnet group. You will have to
// use the name for subnet selection if you have more than one subnet
// group of the same type.
Name: jsii.String("Ingress"),
// 'cidrMask' specifies the IP addresses in the range of of individual
// subnets in the group. Each of the subnets in this group will contain
// `2^(32 address bits - 24 subnet bits) - 2 reserved addresses = 254`
// usable IP addresses.
//
// If 'cidrMask' is left out the available address space is evenly
// divided across the remaining subnet groups.
CidrMask: jsii.Number(24),
},
&subnetConfiguration{
CidrMask: jsii.Number(24),
Name: jsii.String("Application"),
SubnetType: ec2.SubnetType_PRIVATE_WITH_EGRESS,
},
&subnetConfiguration{
CidrMask: jsii.Number(28),
Name: jsii.String("Database"),
SubnetType: ec2.SubnetType_PRIVATE_ISOLATED,
// 'reserved' can be used to reserve IP address space. No resources will
// be created for this subnet, but the IP range will be kept available for
// future creation of this subnet, or even for future subdivision.
Reserved: jsii.Boolean(true),
},
},
})
The example above is one possible configuration, but the user can use the constructs above to implement many other network configurations.
The Vpc from the above configuration in a Region with three
availability zones will be the following:
| Subnet Name | Type | IP Block | AZ | Features |
|---|---|---|---|---|
| IngressSubnet1 | PUBLIC |
10.0.0.0/24 |
#1 | NAT Gateway |
| IngressSubnet2 | PUBLIC |
10.0.1.0/24 |
#2 | NAT Gateway |
| IngressSubnet3 | PUBLIC |
10.0.2.0/24 |
#3 | NAT Gateway |
| ApplicationSubnet1 | PRIVATE |
10.0.3.0/24 |
#1 | Route to NAT in IngressSubnet1 |
| ApplicationSubnet2 | PRIVATE |
10.0.4.0/24 |
#2 | Route to NAT in IngressSubnet2 |
| ApplicationSubnet3 | PRIVATE |
10.0.5.0/24 |
#3 | Route to NAT in IngressSubnet3 |
| DatabaseSubnet1 | ISOLATED |
10.0.6.0/28 |
#1 | Only routes within the VPC |
| DatabaseSubnet2 | ISOLATED |
10.0.6.16/28 |
#2 | Only routes within the VPC |
| DatabaseSubnet3 | ISOLATED |
10.0.6.32/28 |
#3 | Only routes within the VPC |
Dual Stack Configurations
Here is a break down of IPv4 and IPv6 specifc subnetConfiguration properties in a dual stack VPC:
vpc := ec2.NewVpc(this, jsii.String("TheVPC"), &VpcProps{
IpProtocol: ec2.IpProtocol_DUAL_STACK,
SubnetConfiguration: []subnetConfiguration{
&subnetConfiguration{
// general properties
Name: jsii.String("Public"),
SubnetType: ec2.SubnetType_PUBLIC,
Reserved: jsii.Boolean(false),
// IPv4 specific properties
MapPublicIpOnLaunch: jsii.Boolean(true),
CidrMask: jsii.Number(24),
// new IPv6 specific property
Ipv6AssignAddressOnCreation: jsii.Boolean(true),
},
},
})
The property mapPublicIpOnLaunch controls if a public IPv4 address will be assigned. This defaults to false for dual stack VPCs to avoid inadvertant costs of having the public address. However, a public IP must be enabled (or otherwise configured with BYOIP or IPAM) in order for services that rely on the address to function.
The ipv6AssignAddressOnCreation property controls the same behavior for the IPv6 address. It defaults to true.
Using IPv6 specific properties in an IPv4 only VPC will result in errors.
Accessing the Internet Gateway
If you need access to the internet gateway, you can get its ID like so:
var vpc vpc
igwId := vpc.InternetGatewayId
For a VPC with only ISOLATED subnets, this value will be undefined.
This is only supported for VPCs created in the stack - currently you're unable to get the ID for imported VPCs. To do that you'd have to specifically look up the Internet Gateway by name, which would require knowing the name beforehand.
This can be useful for configuring routing using a combination of gateways: for more information see Routing below.
Disabling the creation of the default internet gateway
If you need to control the creation of the internet gateway explicitly,
you can disable the creation of the default one using the createInternetGateway
property:
vpc := ec2.NewVpc(this, jsii.String("VPC"), &VpcProps{
CreateInternetGateway: jsii.Boolean(false),
SubnetConfiguration: []subnetConfiguration{
&subnetConfiguration{
SubnetType: ec2.SubnetType_PUBLIC,
Name: jsii.String("Public"),
},
},
})
Routing
It's possible to add routes to any subnets using the addRoute() method. If for
example you want an isolated subnet to have a static route via the default
Internet Gateway created for the public subnet - perhaps for routing a VPN
connection - you can do so like this:
vpc := ec2.NewVpc(this, jsii.String("VPC"), &VpcProps{
SubnetConfiguration: []subnetConfiguration{
&subnetConfiguration{
SubnetType: ec2.SubnetType_PUBLIC,
Name: jsii.String("Public"),
},
&subnetConfiguration{
SubnetType: ec2.SubnetType_PRIVATE_ISOLATED,
Name: jsii.String("Isolated"),
},
},
})
(vpc.IsolatedSubnets[0].(subnet)).AddRoute(jsii.String("StaticRoute"), &AddRouteOptions{
RouterId: vpc.InternetGatewayId,
RouterType: ec2.RouterType_GATEWAY,
DestinationCidrBlock: jsii.String("8.8.8.8/32"),
})
Note that we cast to Subnet here because the list of subnets only returns an
ISubnet.
Reserving subnet IP space
There are situations where the IP space for a subnet or number of subnets
will need to be reserved. This is useful in situations where subnets would
need to be added after the vpc is originally deployed, without causing IP
renumbering for existing subnets. The IP space for a subnet may be reserved
by setting the reserved subnetConfiguration property to true, as shown
below:
vpc := ec2.NewVpc(this, jsii.String("TheVPC"), &VpcProps{
NatGateways: jsii.Number(1),
SubnetConfiguration: []subnetConfiguration{
&subnetConfiguration{
CidrMask: jsii.Number(26),
Name: jsii.String("Public"),
SubnetType: ec2.SubnetType_PUBLIC,
},
&subnetConfiguration{
CidrMask: jsii.Number(26),
Name: jsii.String("Application1"),
SubnetType: ec2.SubnetType_PRIVATE_WITH_EGRESS,
},
&subnetConfiguration{
CidrMask: jsii.Number(26),
Name: jsii.String("Application2"),
SubnetType: ec2.SubnetType_PRIVATE_WITH_EGRESS,
Reserved: jsii.Boolean(true),
},
&subnetConfiguration{
CidrMask: jsii.Number(27),
Name: jsii.String("Database"),
SubnetType: ec2.SubnetType_PRIVATE_ISOLATED,
},
},
})
In the example above, the subnet for Application2 is not actually provisioned
but its IP space is still reserved. If in the future this subnet needs to be
provisioned, then the reserved: true property should be removed. Reserving
parts of the IP space prevents the other subnets from getting renumbered.
Sharing VPCs between stacks
If you are creating multiple Stacks inside the same CDK application, you
can reuse a VPC defined in one Stack in another by simply passing the VPC
instance around:
/**
* Stack1 creates the VPC
*/
type stack1 struct {
stack
vpc vpc
}
func newStack1(scope app, id *string, props stackProps) *stack1 {
this := &stack1{}
cdk.NewStack_Override(this, scope, id, props)
this.vpc = ec2.NewVpc(this, jsii.String("VPC"))
return this
}
type stack2Props struct {
stackProps
vpc *iVpc
}
/**
* Stack2 consumes the VPC
*/
type stack2 struct {
stack
}
func newStack2(scope app, id *string, props stack2Props) *stack2 {
this := &stack2{}
cdk.NewStack_Override(this, scope, id, props)
// Pass the VPC to a construct that needs it
// Pass the VPC to a construct that needs it
NewConstructThatTakesAVpc(this, jsii.String("Construct"), &constructThatTakesAVpcProps{
vpc: props.vpc,
})
return this
}
stack1 := NewStack1(app, jsii.String("Stack1"))
stack2 := NewStack2(app, jsii.String("Stack2"), &stack2Props{
vpc: stack1.vpc,
})
Importing an existing VPC
If your VPC is created outside your CDK app, you can use Vpc.fromLookup().
The CDK CLI will search for the specified VPC in the the stack's region and
account, and import the subnet configuration. Looking up can be done by VPC
ID, but more flexibly by searching for a specific tag on the VPC.
Subnet types will be determined from the aws-cdk:subnet-type tag on the
subnet if it exists, or the presence of a route to an Internet Gateway
otherwise. Subnet names will be determined from the aws-cdk:subnet-name tag
on the subnet if it exists, or will mirror the subnet type otherwise (i.e.
a public subnet will have the name "Public").
The result of the Vpc.fromLookup() operation will be written to a file
called cdk.context.json. You must commit this file to source control so
that the lookup values are available in non-privileged environments such
as CI build steps, and to ensure your template builds are repeatable.
Here's how Vpc.fromLookup() can be used:
vpc := ec2.Vpc_FromLookup(stack, jsii.String("VPC"), &VpcLookupOptions{
// This imports the default VPC but you can also
// specify a 'vpcName' or 'tags'.
IsDefault: jsii.Boolean(true),
})
Vpc.fromLookup is the recommended way to import VPCs. If for whatever
reason you do not want to use the context mechanism to look up a VPC at
synthesis time, you can also use Vpc.fromVpcAttributes. This has the
following limitations:
- Every subnet group in the VPC must have a subnet in each availability zone (for example, each AZ must have both a public and private subnet). Asymmetric VPCs are not supported.
- All VpcId, SubnetId, RouteTableId, ... parameters must either be known at synthesis time, or they must come from deploy-time list parameters whose deploy-time lengths are known at synthesis time.
Using Vpc.fromVpcAttributes() looks like this:
vpc := ec2.Vpc_FromVpcAttributes(this, jsii.String("VPC"), &VpcAttributes{
VpcId: jsii.String("vpc-1234"),
AvailabilityZones: []*string{
jsii.String("us-east-1a"),
jsii.String("us-east-1b"),
},
// Either pass literals for all IDs
PublicSubnetIds: []*string{
jsii.String("s-12345"),
jsii.String("s-67890"),
},
// OR: import a list of known length
PrivateSubnetIds: awscdk.Fn_ImportListValue(jsii.String("PrivateSubnetIds"), jsii.Number(2)),
// OR: split an imported string to a list of known length
IsolatedSubnetIds: awscdk.Fn_Split(jsii.String(","), ssm.StringParameter_ValueForStringParameter(this, jsii.String("MyParameter")), jsii.Number(2)),
})
For each subnet group the import function accepts optional parameters for subnet
names, route table ids and IPv4 CIDR blocks. When supplied, the length of these
lists are required to match the length of the list of subnet ids, allowing the
lists to be zipped together to form ISubnet instances.
Public subnet group example (for private or isolated subnet groups, use the properties with the respective prefix):
vpc := ec2.Vpc_FromVpcAttributes(this, jsii.String("VPC"), &VpcAttributes{
VpcId: jsii.String("vpc-1234"),
AvailabilityZones: []*string{
jsii.String("us-east-1a"),
jsii.String("us-east-1b"),
jsii.String("us-east-1c"),
},
PublicSubnetIds: []*string{
jsii.String("s-12345"),
jsii.String("s-34567"),
jsii.String("s-56789"),
},
PublicSubnetNames: []*string{
jsii.String("Subnet A"),
jsii.String("Subnet B"),
jsii.String("Subnet C"),
},
PublicSubnetRouteTableIds: []*string{
jsii.String("rt-12345"),
jsii.String("rt-34567"),
jsii.String("rt-56789"),
},
PublicSubnetIpv4CidrBlocks: []*string{
jsii.String("10.0.0.0/24"),
jsii.String("10.0.1.0/24"),
jsii.String("10.0.2.0/24"),
},
})
The above example will create an IVpc instance with three public subnets:
| Subnet id | Availability zone | Subnet name | Route table id | IPv4 CIDR | | --------- | ----------------- | ----------- | -------------- | ----------- | | s-12345 | us-east-1a | Subnet A | rt-12345 | 10.0.0.0/24 | | s-34567 | us-east-1b | Subnet B | rt-34567 | 10.0.1.0/24 | | s-56789 | us-east-1c | Subnet B | rt-56789 | 10.0.2.0/24 |
Restricting access to the VPC default security group
AWS Security best practices recommend that the VPC default security group should
not allow inbound and outbound
traffic.
When the @aws-cdk/aws-ec2:restrictDefaultSecurityGroup feature flag is set to
true (default for new projects) this will be enabled by default. If you do not
have this feature flag set you can either set the feature flag or you can set
the restrictDefaultSecurityGroup property to true.
ec2.NewVpc(this, jsii.String("VPC"), &VpcProps{
RestrictDefaultSecurityGroup: jsii.Boolean(true),
})
If you set this property to true and then later remove it or set it to false
the default ingress/egress will be restored on the default security group.
Allowing Connections
In AWS, all network traffic in and out of Elastic Network Interfaces (ENIs)
is controlled by Security Groups. You can think of Security Groups as a
firewall with a set of rules. By default, Security Groups allow no incoming
(ingress) traffic and all outgoing (egress) traffic. You can add ingress rules
to them to allow incoming traffic streams. To exert fine-grained control over
egress traffic, set allowAllOutbound: false on the SecurityGroup, after
which you can add egress traffic rules.
You can manipulate Security Groups directly:
mySecurityGroup := ec2.NewSecurityGroup(this, jsii.String("SecurityGroup"), &SecurityGroupProps{
Vpc: Vpc,
Description: jsii.String("Allow ssh access to ec2 instances"),
AllowAllOutbound: jsii.Boolean(true),
})
mySecurityGroup.AddIngressRule(ec2.Peer_AnyIpv4(), ec2.Port_Tcp(jsii.Number(22)), jsii.String("allow ssh access from the world"))
All constructs that create ENIs on your behalf (typically constructs that create EC2 instances or other VPC-connected resources) will all have security groups automatically assigned. Those constructs have an attribute called connections, which is an object that makes it convenient to update the security groups. If you want to allow connections between two constructs that have security groups, you have to add an Egress rule to one Security Group, and an Ingress rule to the other. The connections object will automatically take care of this for you:
var loadBalancer applicationLoadBalancer
var appFleet autoScalingGroup
var dbFleet autoScalingGroup
// Allow connections from anywhere
loadBalancer.Connections.AllowFromAnyIpv4(ec2.Port_HTTPS(), jsii.String("Allow inbound HTTPS"))
// The same, but an explicit IP address
loadBalancer.Connections.AllowFrom(ec2.Peer_Ipv4(jsii.String("1.2.3.4/32")), ec2.Port_HTTPS(), jsii.String("Allow inbound HTTPS"))
// Allow connection between AutoScalingGroups
appFleet.connections.AllowTo(dbFleet, ec2.Port_HTTPS(), jsii.String("App can call database"))
Connection Peers
There are various classes that implement the connection peer part:
var appFleet autoScalingGroup
var dbFleet autoScalingGroup
// Simple connection peers
peer := ec2.Peer_Ipv4(jsii.String("10.0.0.0/16"))
peer = ec2.Peer_AnyIpv4()
peer = ec2.Peer_Ipv6(jsii.String("::0/0"))
peer = ec2.Peer_AnyIpv6()
peer = ec2.Peer_PrefixList(jsii.String("pl-12345"))
appFleet.connections.AllowTo(peer, ec2.Port_HTTPS(), jsii.String("Allow outbound HTTPS"))
Any object that has a security group can itself be used as a connection peer:
var fleet1 autoScalingGroup
var fleet2 autoScalingGroup
var appFleet autoScalingGroup
// These automatically create appropriate ingress and egress rules in both security groups
fleet1.connections.AllowTo(fleet2, ec2.Port_HTTP(), jsii.String("Allow between fleets"))
appFleet.connections.AllowFromAnyIpv4(ec2.Port_HTTP(), jsii.String("Allow from load balancer"))
Port Ranges
The connections that are allowed are specified by port ranges. A number of classes provide the connection specifier:
ec2.Port_Tcp(jsii.Number(80))
ec2.Port_HTTPS()
ec2.Port_TcpRange(jsii.Number(60000), jsii.Number(65535))
ec2.Port_AllTcp()
ec2.Port_AllIcmp()
ec2.Port_AllIcmpV6()
ec2.Port_AllTraffic()
NOTE: Not all protocols have corresponding helper methods. In the absence of a helper method, you can instantiate
Portyourself with your own settings. You are also welcome to contribute new helper methods.
Default Ports
Some Constructs have default ports associated with them. For example, the listener of a load balancer does (it's the public port), or instances of an RDS database (it's the port the database is accepting connections on).
If the object you're calling the peering method on has a default port associated with it, you can call
allowDefaultPortFrom() and omit the port specifier. If the argument has an associated default port, call
allowDefaultPortTo().
For example:
var listener applicationListener
var appFleet autoScalingGroup
var rdsDatabase databaseCluster
// Port implicit in listener
listener.Connections.AllowDefaultPortFromAnyIpv4(jsii.String("Allow public"))
// Port implicit in peer
appFleet.connections.AllowDefaultPortTo(rdsDatabase, jsii.String("Fleet can access database"))
Security group rules
By default, security group wills be added inline to the security group in the output cloud formation template, if applicable. This includes any static rules by ip address and port range. This optimization helps to minimize the size of the template.
In some environments this is not desirable, for example if your security group access is controlled
via tags. You can disable inline rules per security group or globally via the context key
@aws-cdk/aws-ec2.securityGroupDisableInlineRules.
mySecurityGroupWithoutInlineRules := ec2.NewSecurityGroup(this, jsii.String("SecurityGroup"), &SecurityGroupProps{
Vpc: Vpc,
Description: jsii.String("Allow ssh access to ec2 instances"),
AllowAllOutbound: jsii.Boolean(true),
DisableInlineRules: jsii.Boolean(true),
})
//This will add the rule as an external cloud formation construct
mySecurityGroupWithoutInlineRules.AddIngressRule(ec2.Peer_AnyIpv4(), ec2.Port_SSH(), jsii.String("allow ssh access from the world"))
Importing an existing security group
If you know the ID and the configuration of the security group to import, you can use SecurityGroup.fromSecurityGroupId:
sg := ec2.SecurityGroup_FromSecurityGroupId(this, jsii.String("SecurityGroupImport"), jsii.String("sg-1234"), &SecurityGroupImportOptions{
AllowAllOutbound: jsii.Boolean(true),
})
Alternatively, use lookup methods to import security groups if you do not know the ID or the configuration details. Method SecurityGroup.fromLookupByName looks up a security group if the security group ID is unknown.
sg := ec2.SecurityGroup_FromLookupByName(this, jsii.String("SecurityGroupLookup"), jsii.String("security-group-name"), vpc)
If the security group ID is known and configuration details are unknown, use method SecurityGroup.fromLookupById instead. This method will lookup property allowAllOutbound from the current configuration of the security group.
sg := ec2.SecurityGroup_FromLookupById(this, jsii.String("SecurityGroupLookup"), jsii.String("sg-1234"))
The result of SecurityGroup.fromLookupByName and SecurityGroup.fromLookupById operations will be written to a file called cdk.context.json. You must commit this file to source control so that the lookup values are available in non-privileged environments such as CI build steps, and to ensure your template builds are repeatable.
Cross Stack Connections
If you are attempting to add a connection from a peer in one stack to a peer in a different stack, sometimes it is necessary to ensure that you are making the connection in a specific stack in order to avoid a cyclic reference. If there are no other dependencies between stacks then it will not matter in which stack you make the connection, but if there are existing dependencies (i.e. stack1 already depends on stack2), then it is important to make the connection in the dependent stack (i.e. stack1).
Whenever you make a connections function call, the ingress and egress security group rules will be added to the stack that the calling object exists in.
So if you are doing something like peer1.connections.allowFrom(peer2), then the security group rules (both ingress and egress) will be created in peer1's Stack.
As an example, if we wanted to allow a connection from a security group in one stack (egress) to a security group in a different stack (ingress), we would make the connection like:
If Stack1 depends on Stack2
// Stack 1
var stack1 stack
var stack2 stack
sg1 := ec2.NewSecurityGroup(stack1, jsii.String("SG1"), &SecurityGroupProps{
AllowAllOutbound: jsii.Boolean(false),
// if this is `true` then no egress rule will be created
Vpc: Vpc,
})
// Stack 2
sg2 := ec2.NewSecurityGroup(stack2, jsii.String("SG2"), &SecurityGroupProps{
AllowAllOutbound: jsii.Boolean(false),
// if this is `true` then no egress rule will be created
Vpc: Vpc,
})
// `connections.allowTo` on `sg1` since we want the
// rules to be created in Stack1
sg1.connections.AllowTo(sg2, ec2.Port_Tcp(jsii.Number(3333)))
In this case both the Ingress Rule for sg2 and the Egress Rule for sg1 will both be created
in Stack 1 which avoids the cyclic reference.
If Stack2 depends on Stack1
// Stack 1
var stack1 stack
var stack2 stack
sg1 := ec2.NewSecurityGroup(stack1, jsii.String("SG1"), &SecurityGroupProps{
AllowAllOutbound: jsii.Boolean(false),
// if this is `true` then no egress rule will be created
Vpc: Vpc,
})
// Stack 2
sg2 := ec2.NewSecurityGroup(stack2, jsii.String("SG2"), &SecurityGroupProps{
AllowAllOutbound: jsii.Boolean(false),
// if this is `true` then no egress rule will be created
Vpc: Vpc,
})
// `connections.allowFrom` on `sg2` since we want the
// rules to be created in Stack2
sg2.connections.AllowFrom(sg1, ec2.Port_Tcp(jsii.Number(3333)))
In this case both the Ingress Rule for sg2 and the Egress Rule for sg1 will both be created
in Stack 2 which avoids the cyclic reference.
Machine Images (AMIs)
AMIs control the OS that gets launched when you start your EC2 instance. The EC2 library contains constructs to select the AMI you want to use.
Depending on the type of AMI, you select it a different way. Here are some examples of images you might want to use:
// Pick the right Amazon Linux edition. All arguments shown are optional
// and will default to these values when omitted.
amznLinux := ec2.MachineImage_LatestAmazonLinux(&AmazonLinuxImageProps{
Generation: ec2.AmazonLinuxGeneration_AMAZON_LINUX,
Edition: ec2.AmazonLinuxEdition_STANDARD,
Virtualization: ec2.AmazonLinuxVirt_HVM,
Storage: ec2.AmazonLinuxStorage_GENERAL_PURPOSE,
CpuType: ec2.AmazonLinuxCpuType_X86_64,
})
// Pick a Windows edition to use
windows := ec2.MachineImage_LatestWindows(ec2.WindowsVersion_WINDOWS_SERVER_2019_ENGLISH_FULL_BASE)
// Read AMI id from SSM parameter store
ssm := ec2.MachineImage_FromSsmParameter(jsii.String("/my/ami"), &SsmParameterImageOptions{
Os: ec2.OperatingSystemType_LINUX,
})
// Look up the most recent image matching a set of AMI filters.
// In this case, look up the NAT instance AMI, by using a wildcard
// in the 'name' field:
natAmi := ec2.MachineImage_Lookup(&LookupMachineImageProps{
Name: jsii.String("amzn-ami-vpc-nat-*"),
Owners: []*string{
jsii.String("amazon"),
},
})
// For other custom (Linux) images, instantiate a `GenericLinuxImage` with
// a map giving the AMI to in for each region:
linux := ec2.MachineImage_GenericLinux(map[string]*string{
"us-east-1": jsii.String("ami-97785bed"),
"eu-west-1": jsii.String("ami-12345678"),
})
// For other custom (Windows) images, instantiate a `GenericWindowsImage` with
// a map giving the AMI to in for each region:
genericWindows := ec2.MachineImage_GenericWindows(map[string]*string{
"us-east-1": jsii.String("ami-97785bed"),
"eu-west-1": jsii.String("ami-12345678"),
})
NOTE: The AMIs selected by
MachineImage.lookup()will be cached incdk.context.json, so that your AutoScalingGroup instances aren't replaced while you are making unrelated changes to your CDK app.To query for the latest AMI again, remove the relevant cache entry from
cdk.context.json, or use thecdk contextcommand. For more information, see Runtime Context in the CDK developer guide.
MachineImage.genericLinux(),MachineImage.genericWindows()will useCfnMappingin an agnostic stack.
Special VPC configurations
VPN connections to a VPC
Create your VPC with VPN connections by specifying the vpnConnections props (keys are construct ids):
import "github.com/aws/aws-cdk-go/awscdk"
vpc := ec2.NewVpc(this, jsii.String("MyVpc"), &VpcProps{
VpnConnections: map[string]vpnConnectionOptions{
"dynamic": &vpnConnectionOptions{
// Dynamic routing (BGP)
"ip": jsii.String("1.2.3.4"),
"tunnelOptions": []VpnTunnelOption{
&VpnTunnelOption{
"preSharedKeySecret": awscdk.SecretValue_unsafePlainText(jsii.String("secretkey1234")),
},
&VpnTunnelOption{
"preSharedKeySecret": awscdk.SecretValue_unsafePlainText(jsii.String("secretkey5678")),
},
},
},
"static": &vpnConnectionOptions{
// Static routing
"ip": jsii.String("4.5.6.7"),
"staticRoutes": []*string{
jsii.String("192.168.10.0/24"),
jsii.String("192.168.20.0/24"),
},
},
},
})
To create a VPC that can accept VPN connections, set vpnGateway to true:
vpc := ec2.NewVpc(this, jsii.String("MyVpc"), &VpcProps{
VpnGateway: jsii.Boolean(true),
})
VPN connections can then be added:
vpc.addVpnConnection(jsii.String("Dynamic"), &VpnConnectionOptions{
Ip: jsii.String("1.2.3.4"),
})
By default, routes will be propagated on the route tables associated with the private subnets. If no
private subnets exist, isolated subnets are used. If no isolated subnets exist, public subnets are
used. Use the Vpc property vpnRoutePropagation to customize this behavior.
VPN connections expose metrics (cloudwatch.Metric) across all tunnels in the account/region and per connection:
// Across all tunnels in the account/region
allDataOut := ec2.VpnConnection_MetricAllTunnelDataOut()
// For a specific vpn connection
vpnConnection := vpc.addVpnConnection(jsii.String("Dynamic"), &VpnConnectionOptions{
Ip: jsii.String("1.2.3.4"),
})
state := vpnConnection.metricTunnelState()
VPC endpoints
A VPC endpoint enables you to privately connect your VPC to supported AWS services and VPC endpoint services powered by PrivateLink without requiring an internet gateway, NAT device, VPN connection, or AWS Direct Connect connection. Instances in your VPC do not require public IP addresses to communicate with resources in the service. Traffic between your VPC and the other service does not leave the Amazon network.
Endpoints are virtual devices. They are horizontally scaled, redundant, and highly available VPC components that allow communication between instances in your VPC and services without imposing availability risks or bandwidth constraints on your network traffic.
// Add gateway endpoints when creating the VPC
vpc := ec2.NewVpc(this, jsii.String("MyVpc"), &VpcProps{
GatewayEndpoints: map[string]gatewayVpcEndpointOptions{
"S3": &gatewayVpcEndpointOptions{
"service": ec2.GatewayVpcEndpointAwsService_S3(),
},
},
})
// Alternatively gateway endpoints can be added on the VPC
dynamoDbEndpoint := vpc.addGatewayEndpoint(jsii.String("DynamoDbEndpoint"), &gatewayVpcEndpointOptions{
Service: ec2.GatewayVpcEndpointAwsService_DYNAMODB(),
})
// This allows to customize the endpoint policy
dynamoDbEndpoint.AddToPolicy(
iam.NewPolicyStatement(&PolicyStatementProps{
// Restrict to listing and describing tables
Principals: []iPrincipal{
iam.NewAnyPrincipal(),
},
Actions: []*string{
jsii.String("dynamodb:DescribeTable"),
jsii.String("dynamodb:ListTables"),
},
Resources: []*string{
jsii.String("*"),
},
}))
// Add an interface endpoint
vpc.addInterfaceEndpoint(jsii.String("EcrDockerEndpoint"), &InterfaceVpcEndpointOptions{
Service: ec2.InterfaceVpcEndpointAwsService_ECR_DOCKER(),
})
By default, CDK will place a VPC endpoint in one subnet per AZ. If you wish to override the AZs CDK places the VPC endpoint in,
use the subnets parameter as follows:
var vpc vpc
ec2.NewInterfaceVpcEndpoint(this, jsii.String("VPC Endpoint"), &InterfaceVpcEndpointProps{
Vpc: Vpc,
Service: ec2.NewInterfaceVpcEndpointService(jsii.String("com.amazonaws.vpce.us-east-1.vpce-svc-uuddlrlrbastrtsvc"), jsii.Number(443)),
// Choose which availability zones to place the VPC endpoint in, based on
// available AZs
Subnets: &SubnetSelection{
AvailabilityZones: []*string{
jsii.String("us-east-1a"),
jsii.String("us-east-1c"),
},
},
})
Per the AWS documentation, not all
VPC endpoint services are available in all AZs. If you specify the parameter lookupSupportedAzs, CDK attempts to discover which
AZs an endpoint service is available in, and will ensure the VPC endpoint is not placed in a subnet that doesn't match those AZs.
These AZs will be stored in cdk.context.json.
var vpc vpc
ec2.NewInterfaceVpcEndpoint(this, jsii.String("VPC Endpoint"), &InterfaceVpcEndpointProps{
Vpc: Vpc,
Service: ec2.NewInterfaceVpcEndpointService(jsii.String("com.amazonaws.vpce.us-east-1.vpce-svc-uuddlrlrbastrtsvc"), jsii.Number(443)),
// Choose which availability zones to place the VPC endpoint in, based on
// available AZs
LookupSupportedAzs: jsii.Boolean(true),
})
Pre-defined AWS services are defined in the InterfaceVpcEndpointAwsService class, and can be used to create VPC endpoints without having to configure name, ports, etc. For example, a Keyspaces endpoint can be created for use in your VPC:
var vpc vpc
ec2.NewInterfaceVpcEndpoint(this, jsii.String("VPC Endpoint"), &InterfaceVpcEndpointProps{
Vpc: Vpc,
Service: ec2.InterfaceVpcEndpointAwsService_KEYSPACES(),
})
Security groups for interface VPC endpoints
By default, interface VPC endpoints create a new security group and all traffic to the endpoint from within the VPC will be automatically allowed.
Use the connections object to allow other traffic to flow to the endpoint:
var myEndpoint interfaceVpcEndpoint
myEndpoint.Connections.AllowDefaultPortFromAnyIpv4()
Alternatively, existing security groups can be used by specifying the securityGroups prop.
VPC endpoint services
A VPC endpoint service enables you to expose a Network Load Balancer(s) as a provider service to consumers, who connect to your service over a VPC endpoint. You can restrict access to your service via allowed principals (anything that extends ArnPrincipal), and require that new connections be manually accepted. You can also enable Contributor Insight rules.
var networkLoadBalancer1 networkLoadBalancer
var networkLoadBalancer2 networkLoadBalancer
ec2.NewVpcEndpointService(this, jsii.String("EndpointService"), &VpcEndpointServiceProps{
VpcEndpointServiceLoadBalancers: []iVpcEndpointServiceLoadBalancer{
networkLoadBalancer1,
networkLoadBalancer2,
},
AcceptanceRequired: jsii.Boolean(true),
AllowedPrincipals: []arnPrincipal{
iam.NewArnPrincipal(jsii.String("arn:aws:iam::123456789012:root")),
},
ContributorInsights: jsii.Boolean(true),
})
You can also include a service principal in the allowedPrincipals property by specifying it as a parameter to the ArnPrincipal constructor.
The resulting VPC endpoint will have an allowlisted principal of type Service, instead of Arn for that item in the list.
var networkLoadBalancer networkLoadBalancer
ec2.NewVpcEndpointService(this, jsii.String("EndpointService"), &VpcEndpointServiceProps{
VpcEndpointServiceLoadBalancers: []iVpcEndpointServiceLoadBalancer{
networkLoadBalancer,
},
AllowedPrincipals: []arnPrincipal{
iam.NewArnPrincipal(jsii.String("ec2.amazonaws.com")),
},
})
Endpoint services support private DNS, which makes it easier for clients to connect to your service by automatically setting up DNS in their VPC. You can enable private DNS on an endpoint service like so:
import "github.com/aws/aws-cdk-go/awscdk"
var zone publicHostedZone
var vpces vpcEndpointService
awscdk.NewVpcEndpointServiceDomainName(this, jsii.String("EndpointDomain"), &VpcEndpointServiceDomainNameProps{
EndpointService: vpces,
DomainName: jsii.String("my-stuff.aws-cdk.dev"),
PublicHostedZone: zone,
})
Note: The domain name must be owned (registered through Route53) by the account the endpoint service is in, or delegated to the account. The VpcEndpointServiceDomainName will handle the AWS side of domain verification, the process for which can be found here
Client VPN endpoint
AWS Client VPN is a managed client-based VPN service that enables you to securely access your AWS resources and resources in your on-premises network. With Client VPN, you can access your resources from any location using an OpenVPN-based VPN client.
Use the addClientVpnEndpoint() method to add a client VPN endpoint to a VPC:
vpc.addClientVpnEndpoint(jsii.String("Endpoint"), &ClientVpnEndpointOptions{
Cidr: jsii.String("10.100.0.0/16"),
ServerCertificateArn: jsii.String("arn:aws:acm:us-east-1:123456789012:certificate/server-certificate-id"),
// Mutual authentication
ClientCertificateArn: jsii.String("arn:aws:acm:us-east-1:123456789012:certificate/client-certificate-id"),
// User-based authentication
UserBasedAuthentication: ec2.ClientVpnUserBasedAuthentication_Federated(samlProvider),
})
The endpoint must use at least one authentication method:
- Mutual authentication with a client certificate
- User-based authentication (directory or federated)
If user-based authentication is used, the self-service portal URL is made available via a CloudFormation output.
By default, a new security group is created, and logging is enabled. Moreover, a rule to authorize all users to the VPC CIDR is created.
To customize authorization rules, set the authorizeAllUsersToVpcCidr prop to false
and use addAuthorizationRule():
endpoint := vpc.addClientVpnEndpoint(jsii.String("Endpoint"), &ClientVpnEndpointOptions{
Cidr: jsii.String("10.100.0.0/16"),
ServerCertificateArn: jsii.String("arn:aws:acm:us-east-1:123456789012:certificate/server-certificate-id"),
UserBasedAuthentication: ec2.ClientVpnUserBasedAuthentication_Federated(samlProvider),
AuthorizeAllUsersToVpcCidr: jsii.Boolean(false),
})
endpoint.AddAuthorizationRule(jsii.String("Rule"), &ClientVpnAuthorizationRuleOptions{
Cidr: jsii.String("10.0.10.0/32"),
GroupId: jsii.String("group-id"),
})
Use addRoute() to configure network routes:
endpoint := vpc.addClientVpnEndpoint(jsii.String("Endpoint"), &ClientVpnEndpointOptions{
Cidr: jsii.String("10.100.0.0/16"),
ServerCertificateArn: jsii.String("arn:aws:acm:us-east-1:123456789012:certificate/server-certificate-id"),
UserBasedAuthentication: ec2.ClientVpnUserBasedAuthentication_Federated(samlProvider),
})
// Client-to-client access
endpoint.AddRoute(jsii.String("Route"), &ClientVpnRouteOptions{
Cidr: jsii.String("10.100.0.0/16"),
Target: ec2.ClientVpnRouteTarget_Local(),
})
Use the connections object of the endpoint to allow traffic to other security groups.
Instances
You can use the Instance class to start up a single EC2 instance. For production setups, we recommend
you use an AutoScalingGroup from the aws-autoscaling module instead, as AutoScalingGroups will take
care of restarting your instance if it ever fails.
var vpc vpc
var instanceType instanceType
// Amazon Linux 2
// Amazon Linux 2
ec2.NewInstance(this, jsii.String("Instance2"), &InstanceProps{
Vpc: Vpc,
InstanceType: InstanceType,
MachineImage: ec2.MachineImage_LatestAmazonLinux2(),
})
// Amazon Linux 2 with kernel 5.x
// Amazon Linux 2 with kernel 5.x
ec2.NewInstance(this, jsii.String("Instance3"), &InstanceProps{
Vpc: Vpc,
InstanceType: InstanceType,
MachineImage: ec2.MachineImage_*LatestAmazonLinux2(&AmazonLinux2ImageSsmParameterProps{
Kernel: ec2.AmazonLinux2Kernel_KERNEL_5_10(),
}),
})
// Amazon Linux 2023
// Amazon Linux 2023
ec2.NewInstance(this, jsii.String("Instance4"), &InstanceProps{
Vpc: Vpc,
InstanceType: InstanceType,
MachineImage: ec2.MachineImage_LatestAmazonLinux2023(),
})
// Graviton 3 Processor
// Graviton 3 Processor
ec2.NewInstance(this, jsii.String("Instance5"), &InstanceProps{
Vpc: Vpc,
InstanceType: ec2.*instanceType_Of(ec2.InstanceClass_C7G, ec2.InstanceSize_LARGE),
MachineImage: ec2.MachineImage_*LatestAmazonLinux2023(&AmazonLinux2023ImageSsmParameterProps{
CpuType: ec2.AmazonLinuxCpuType_ARM_64,
}),
})
Latest Amazon Linux Images
Rather than specifying a specific AMI ID to use, it is possible to specify a SSM
Parameter that contains the AMI ID. AWS publishes a set of public parameters
that contain the latest Amazon Linux AMIs. To make it easier to query a
particular image parameter, the CDK provides a couple of constructs AmazonLinux2ImageSsmParameter,
AmazonLinux2022ImageSsmParameter, & AmazonLinux2023SsmParameter. For example
to use the latest al2023 image:
var vpc vpc
ec2.NewInstance(this, jsii.String("LatestAl2023"), &InstanceProps{
Vpc: Vpc,
InstanceType: ec2.InstanceType_Of(ec2.InstanceClass_C7G, ec2.InstanceSize_LARGE),
MachineImage: ec2.MachineImage_LatestAmazonLinux2023(),
})
Warning Since this retrieves the value from an SSM parameter at deployment time, the value will be resolved each time the stack is deployed. This means that if the parameter contains a different value on your next deployment, the instance will be replaced.
It is also possible to perform the lookup once at synthesis time and then cache the value in CDK context. This way the value will not change on future deployments unless you manually refresh the context.
var vpc vpc
ec2.NewInstance(this, jsii.String("LatestAl2023"), &InstanceProps{
Vpc: Vpc,
InstanceType: ec2.InstanceType_Of(ec2.InstanceClass_C7G, ec2.InstanceSize_LARGE),
MachineImage: ec2.MachineImage_LatestAmazonLinux2023(&AmazonLinux2023ImageSsmParameterProps{
CachedInContext: jsii.Boolean(true),
}),
})
// or
// or
ec2.NewInstance(this, jsii.String("LatestAl2023"), &InstanceProps{
Vpc: Vpc,
InstanceType: ec2.InstanceType_*Of(ec2.InstanceClass_C7G, ec2.InstanceSize_LARGE),
// context cache is turned on by default
MachineImage: ec2.NewAmazonLinux2023ImageSsmParameter(),
})
Kernel Versions
Each Amazon Linux AMI uses a specific kernel version. Most Amazon Linux generations come with an AMI using the "default" kernel and then 1 or more AMIs using a specific kernel version, which may or may not be different from the default kernel version.
For example, Amazon Linux 2 has two different AMIs available from the SSM parameters.
-
/aws/service/ami-amazon-linux-latest/amzn2-ami-hvm-x86_64-ebs- This is the "default" kernel which uses
kernel-4.14
- This is the "default" kernel which uses
-
/aws/service/ami-amazon-linux-latest/amzn2-ami-kernel-5.10-hvm-x86_64-ebs
If a new Amazon Linux generation AMI is published with a new kernel version,
then a new SSM parameter will be created with the new version
(e.g. /aws/service/ami-amazon-linux-latest/amzn2-ami-kernel-5.15-hvm-x86_64-ebs),
but the "default" AMI may or may not be updated.
If you would like to make sure you always have the latest kernel version, then either specify the specific latest kernel version or opt-in to using the CDK latest kernel version.
var vpc vpc
ec2.NewInstance(this, jsii.String("LatestAl2023"), &InstanceProps{
Vpc: Vpc,
InstanceType: ec2.InstanceType_Of(ec2.InstanceClass_C7G, ec2.InstanceSize_LARGE),
// context cache is turned on by default
MachineImage: ec2.NewAmazonLinux2023ImageSsmParameter(&AmazonLinux2023ImageSsmParameterProps{
Kernel: ec2.AmazonLinux2023Kernel_KERNEL_6_1(),
}),
})
CDK managed latest
var vpc vpc
ec2.NewInstance(this, jsii.String("LatestAl2023"), &InstanceProps{
Vpc: Vpc,
InstanceType: ec2.InstanceType_Of(ec2.InstanceClass_C7G, ec2.InstanceSize_LARGE),
// context cache is turned on by default
MachineImage: ec2.NewAmazonLinux2023ImageSsmParameter(&AmazonLinux2023ImageSsmParameterProps{
Kernel: ec2.AmazonLinux2023Kernel_CDK_LATEST(),
}),
})
// or
// or
ec2.NewInstance(this, jsii.String("LatestAl2023"), &InstanceProps{
Vpc: Vpc,
InstanceType: ec2.InstanceType_*Of(ec2.InstanceClass_C7G, ec2.InstanceSize_LARGE),
MachineImage: ec2.MachineImage_LatestAmazonLinux2023(),
})
When using the CDK managed latest version, when a new kernel version is made
available the LATEST will be updated to point to the new kernel version. You
then would be required to update the newest CDK version for it to take effect.
Configuring Instances using CloudFormation Init (cfn-init)
CloudFormation Init allows you to configure your instances by writing files to them, installing software
packages, starting services and running arbitrary commands. By default, if any of the instance setup
commands throw an error; the deployment will fail and roll back to the previously known good state.
The following documentation also applies to AutoScalingGroups.
For the full set of capabilities of this system, see the documentation for
AWS::CloudFormation::Init.
Here is an example of applying some configuration to an instance:
var vpc vpc
var instanceType instanceType
var machineImage iMachineImage
ec2.NewInstance(this, jsii.String("Instance"), &InstanceProps{
Vpc: Vpc,
InstanceType: InstanceType,
MachineImage: MachineImage,
// Showing the most complex setup, if you have simpler requirements
// you can use `CloudFormationInit.fromElements()`.
Init: ec2.CloudFormationInit_FromConfigSets(&ConfigSetProps{
ConfigSets: map[string][]*string{
// Applies the configs below in this order
"default": []*string{
jsii.String("yumPreinstall"),
jsii.String("config"),
},
},
Configs: map[string]initConfig{
"yumPreinstall": ec2.NewInitConfig([]InitElement{
ec2.InitPackage_yum(jsii.String("git")),
}),
"config": ec2.NewInitConfig([]InitElement{
ec2.InitFile_fromObject(jsii.String("/etc/stack.json"), map[string]interface{}{
"stackId": awscdk.*stack_of(this).stackId,
"stackName": awscdk.*stack_of(this).stackName,
"region": awscdk.*stack_of(this).region,
}),
ec2.InitGroup_fromName(jsii.String("my-group")),
ec2.InitUser_fromName(jsii.String("my-user")),
ec2.InitPackage_rpm(jsii.String("http://mirrors.ukfast.co.uk/sites/dl.fedoraproject.org/pub/epel/8/Everything/x86_64/Packages/r/rubygem-git-1.5.0-2.el8.noarch.rpm")),
}),
},
}),
InitOptions: &ApplyCloudFormationInitOptions{
// Optional, which configsets to activate (['default'] by default)
ConfigSets: []*string{
jsii.String("default"),
},
// Optional, how long the installation is expected to take (5 minutes by default)
Timeout: awscdk.Duration_Minutes(jsii.Number(30)),
// Optional, whether to include the --url argument when running cfn-init and cfn-signal commands (false by default)
IncludeUrl: jsii.Boolean(true),
// Optional, whether to include the --role argument when running cfn-init and cfn-signal commands (false by default)
IncludeRole: jsii.Boolean(true),
},
})
InitCommand can not be used to start long-running processes. At deploy time,
cfn-init will always wait for the process to exit before continuing, causing
the CloudFormation deployment to fail because the signal hasn't been received
within the expected timeout.
Instead, you should install a service configuration file onto your machine InitFile,
and then use InitService to start it.
If your Linux OS is using SystemD (like Amazon Linux 2 or higher), the CDK has
helpers to create a long-running service using CFN Init. You can create a
SystemD-compatible config file using InitService.systemdConfigFile(), and
start it immediately. The following examples shows how to start a trivial Python
3 web server:
var vpc vpc
var instanceType instanceType
ec2.NewInstance(this, jsii.String("Instance"), &InstanceProps{
Vpc: Vpc,
InstanceType: InstanceType,
MachineImage: ec2.MachineImage_LatestAmazonLinux2023(),
Init: ec2.CloudFormationInit_FromElements(ec2.InitService_SystemdConfigFile(jsii.String("simpleserver"), &SystemdConfigFileOptions{
Command: jsii.String("/usr/bin/python3 -m http.server 8080"),
Cwd: jsii.String("/var/www/html"),
}), ec2.InitService_Enable(jsii.String("simpleserver"), &InitServiceOptions{
ServiceManager: ec2.ServiceManager_SYSTEMD,
}), ec2.InitFile_FromString(jsii.String("/var/www/html/index.html"), jsii.String("Hello! It's working!"))),
})
You can have services restarted after the init process has made changes to the system.
To do that, instantiate an InitServiceRestartHandle and pass it to the config elements
that need to trigger the restart and the service itself. For example, the following
config writes a config file for nginx, extracts an archive to the root directory, and then
restarts nginx so that it picks up the new config and files:
var myBucket bucket
handle := ec2.NewInitServiceRestartHandle()
ec2.CloudFormationInit_FromElements(ec2.InitFile_FromString(jsii.String("/etc/nginx/nginx.conf"), jsii.String("..."), &InitFileOptions{
ServiceRestartHandles: []initServiceRestartHandle{
handle,
},
}), ec2.InitSource_FromS3Object(jsii.String("/var/www/html"), myBucket, jsii.String("html.zip"), &InitSourceOptions{
ServiceRestartHandles: []*initServiceRestartHandle{
handle,
},
}), ec2.InitService_Enable(jsii.String("nginx"), &InitServiceOptions{
ServiceRestartHandle: handle,
}))
You can use the environmentVariables or environmentFiles parameters to specify environment variables
for your services:
ec2.NewInitConfig([]initElement{
ec2.InitFile_FromString(jsii.String("/myvars.env"), jsii.String("VAR_FROM_FILE=\"VAR_FROM_FILE\"")),
ec2.InitService_SystemdConfigFile(jsii.String("myapp"), &SystemdConfigFileOptions{
Command: jsii.String("/usr/bin/python3 -m http.server 8080"),
Cwd: jsii.String("/var/www/html"),
EnvironmentVariables: map[string]*string{
"MY_VAR": jsii.String("MY_VAR"),
},
EnvironmentFiles: []*string{
jsii.String("/myvars.env"),
},
}),
})
Bastion Hosts
A bastion host functions as an instance used to access servers and resources in a VPC without open up the complete VPC on a network level. You can use bastion hosts using a standard SSH connection targeting port 22 on the host. As an alternative, you can connect the SSH connection feature of AWS Systems Manager Session Manager, which does not need an opened security group. (https://aws.amazon.com/about-aws/whats-new/2019/07/session-manager-launches-tunneling-support-for-ssh-and-scp/)
A default bastion host for use via SSM can be configured like:
host := ec2.NewBastionHostLinux(this, jsii.String("BastionHost"), &BastionHostLinuxProps{
Vpc: Vpc,
})
If you want to connect from the internet using SSH, you need to place the host into a public subnet. You can then configure allowed source hosts.
host := ec2.NewBastionHostLinux(this, jsii.String("BastionHost"), &BastionHostLinuxProps{
Vpc: Vpc,
SubnetSelection: &SubnetSelection{
SubnetType: ec2.SubnetType_PUBLIC,
},
})
host.AllowSshAccessFrom(ec2.Peer_Ipv4(jsii.String("1.2.3.4/32")))
As there are no SSH public keys deployed on this machine, you need to use EC2 Instance Connect
with the command aws ec2-instance-connect send-ssh-public-key to provide your SSH public key.
EBS volume for the bastion host can be encrypted like:
host := ec2.NewBastionHostLinux(this, jsii.String("BastionHost"), &BastionHostLinuxProps{
Vpc: Vpc,
BlockDevices: []blockDevice{
&blockDevice{
DeviceName: jsii.String("/dev/sdh"),
Volume: ec2.BlockDeviceVolume_Ebs(jsii.Number(10), &EbsDeviceOptions{
Encrypted: jsii.Boolean(true),
}),
},
},
})
Placement Group
Specify placementGroup to enable the placement group support:
var instanceType instanceType
pg := ec2.NewPlacementGroup(this, jsii.String("test-pg"), &PlacementGroupProps{
Strategy: ec2.PlacementGroupStrategy_SPREAD,
})
ec2.NewInstance(this, jsii.String("Instance"), &InstanceProps{
Vpc: Vpc,
InstanceType: InstanceType,
MachineImage: ec2.MachineImage_LatestAmazonLinux2023(),
PlacementGroup: pg,
})
Block Devices
To add EBS block device mappings, specify the blockDevices property. The following example sets the EBS-backed
root device (/dev/sda1) size to 50 GiB, and adds another EBS-backed device mapped to /dev/sdm that is 100 GiB in
size:
var vpc vpc
var instanceType instanceType
var machineImage iMachineImage
ec2.NewInstance(this, jsii.String("Instance"), &InstanceProps{
Vpc: Vpc,
InstanceType: InstanceType,
MachineImage: MachineImage,
// ...
BlockDevices: []blockDevice{
&blockDevice{
DeviceName: jsii.String("/dev/sda1"),
Volume: ec2.BlockDeviceVolume_Ebs(jsii.Number(50)),
},
&blockDevice{
DeviceName: jsii.String("/dev/sdm"),
Volume: ec2.BlockDeviceVolume_*Ebs(jsii.Number(100)),
},
},
})
It is also possible to encrypt the block devices. In this example we will create an customer managed key encrypted EBS-backed root device:
import "github.com/aws/aws-cdk-go/awscdk"
var vpc vpc
var instanceType instanceType
var machineImage iMachineImage
kmsKey := awscdk.NewKey(this, jsii.String("KmsKey"))
ec2.NewInstance(this, jsii.String("Instance"), &InstanceProps{
Vpc: Vpc,
InstanceType: InstanceType,
MachineImage: MachineImage,
// ...
BlockDevices: []blockDevice{
&blockDevice{
DeviceName: jsii.String("/dev/sda1"),
Volume: ec2.BlockDeviceVolume_Ebs(jsii.Number(50), &EbsDeviceOptions{
Encrypted: jsii.Boolean(true),
KmsKey: kmsKey,
}),
},
},
})
To specify the throughput value for gp3 volumes, use the throughput property:
var vpc vpc
var instanceType instanceType
var machineImage iMachineImage
ec2.NewInstance(this, jsii.String("Instance"), &InstanceProps{
Vpc: Vpc,
InstanceType: InstanceType,
MachineImage: MachineImage,
// ...
BlockDevices: []blockDevice{
&blockDevice{
DeviceName: jsii.String("/dev/sda1"),
Volume: ec2.BlockDeviceVolume_Ebs(jsii.Number(100), &EbsDeviceOptions{
VolumeType: ec2.EbsDeviceVolumeType_GP3,
Throughput: jsii.Number(250),
}),
},
},
})
EBS Optimized Instances
An Amazon EBS–optimized instance uses an optimized configuration stack and provides additional, dedicated capacity for Amazon EBS I/O. This optimization provides the best performance for your EBS volumes by minimizing contention between Amazon EBS I/O and other traffic from your instance.
Depending on the instance type, this features is enabled by default while others require explicit activation. Please refer to the documentation for details.
var vpc vpc
var instanceType instanceType
var machineImage iMachineImage
ec2.NewInstance(this, jsii.String("Instance"), &InstanceProps{
Vpc: Vpc,
InstanceType: InstanceType,
MachineImage: MachineImage,
EbsOptimized: jsii.Boolean(true),
BlockDevices: []blockDevice{
&blockDevice{
DeviceName: jsii.String("/dev/xvda"),
Volume: ec2.BlockDeviceVolume_Ebs(jsii.Number(8)),
},
},
})
Volumes
Whereas a BlockDeviceVolume is an EBS volume that is created and destroyed as part of the creation and destruction of a specific instance. A Volume is for when you want an EBS volume separate from any particular instance. A Volume is an EBS block device that can be attached to, or detached from, any instance at any time. Some types of Volumes can also be attached to multiple instances at the same time to allow you to have shared storage between those instances.
A notable restriction is that a Volume can only be attached to instances in the same availability zone as the Volume itself.
The following demonstrates how to create a 500 GiB encrypted Volume in the us-west-2a availability zone, and give a role the ability to attach that Volume to a specific instance:
var instance instance
var role role
volume := ec2.NewVolume(this, jsii.String("Volume"), &VolumeProps{
AvailabilityZone: jsii.String("us-west-2a"),
Size: awscdk.Size_Gibibytes(jsii.Number(500)),
Encrypted: jsii.Boolean(true),
})
volume.grantAttachVolume(role, []iInstance{
instance,
})
Instances Attaching Volumes to Themselves
If you need to grant an instance the ability to attach/detach an EBS volume to/from itself, then using grantAttachVolume and grantDetachVolume as outlined above
will lead to an unresolvable circular reference between the instance role and the instance. In this case, use grantAttachVolumeByResourceTag and grantDetachVolumeByResourceTag as follows:
var instance instance
var volume volume
attachGrant := volume.grantAttachVolumeByResourceTag(instance.GrantPrincipal, []construct{
instance,
})
detachGrant := volume.grantDetachVolumeByResourceTag(instance.GrantPrincipal, []construct{
instance,
})
Attaching Volumes
The Amazon EC2 documentation for Linux Instances and Windows Instances contains information on how to attach and detach your Volumes to/from instances, and how to format them for use.
The following is a sample skeleton of EC2 UserData that can be used to attach a Volume to the Linux instance that it is running on:
var instance instance
var volume volume
volume.grantAttachVolumeByResourceTag(instance.GrantPrincipal, []construct{
instance,
})
targetDevice := "/dev/xvdz"
instance.UserData.AddCommands(jsii.String("TOKEN=$(curl -SsfX PUT \"http://169.254.169.254/latest/api/token\" -H \"X-aws-ec2-metadata-token-ttl-seconds: 21600\")"), jsii.String("INSTANCE_ID=$(curl -SsfH \"X-aws-ec2-metadata-token: $TOKEN\" http://169.254.169.254/latest/meta-data/instance-id)"),
// Attach the volume to /dev/xvdz
fmt.Sprintf("aws --region %v ec2 attach-volume --volume-id %v --instance-id $INSTANCE_ID --device %v", awscdk.stack_Of(this).Region, volume.VolumeId, targetDevice),
// Wait until the volume has attached
fmt.Sprintf("while ! test -e %v; do sleep 1; done", targetDevice))
Tagging Volumes
You can configure tag propagation on volume creation.
var vpc vpc
var instanceType instanceType
var machineImage iMachineImage
ec2.NewInstance(this, jsii.String("Instance"), &InstanceProps{
Vpc: Vpc,
MachineImage: MachineImage,
InstanceType: InstanceType,
PropagateTagsToVolumeOnCreation: jsii.Boolean(true),
})
Throughput on GP3 Volumes
You can specify the throughput of a GP3 volume from 125 (default) to 1000.
ec2.NewVolume(this, jsii.String("Volume"), &VolumeProps{
AvailabilityZone: jsii.String("us-east-1a"),
Size: awscdk.Size_Gibibytes(jsii.Number(125)),
VolumeType: ec2.EbsDeviceVolumeType_GP3,
Throughput: jsii.Number(125),
})
Configuring Instance Metadata Service (IMDS)
Toggling IMDSv1
You can configure EC2 Instance Metadata Service options to either allow both IMDSv1 and IMDSv2 or enforce IMDSv2 when interacting with the IMDS.
To do this for a single Instance, you can use the requireImdsv2 property.
The example below demonstrates IMDSv2 being required on a single Instance:
var vpc vpc
var instanceType instanceType
var machineImage iMachineImage
ec2.NewInstance(this, jsii.String("Instance"), &InstanceProps{
Vpc: Vpc,
InstanceType: InstanceType,
MachineImage: MachineImage,
// ...
RequireImdsv2: jsii.Boolean(true),
})
You can also use the either the InstanceRequireImdsv2Aspect for EC2 instances or the LaunchTemplateRequireImdsv2Aspect for EC2 launch templates
to apply the operation to multiple instances or launch templates, respectively.
The following example demonstrates how to use the InstanceRequireImdsv2Aspect to require IMDSv2 for all EC2 instances in a stack:
aspect := ec2.NewInstanceRequireImdsv2Aspect()
awscdk.Aspects_Of(this).Add(aspect)
Associating a Public IP Address with an Instance
All subnets have an attribute that determines whether instances launched into that subnet are assigned a public IPv4 address. This attribute is set to true by default for default public subnets. Thus, an EC2 instance launched into a default public subnet will be assigned a public IPv4 address. Nondefault public subnets have this attribute set to false by default and any EC2 instance launched into a nondefault public subnet will not be assigned a public IPv4 address automatically. To automatically assign a public IPv4 address to an instance launched into a nondefault public subnet, you can set the associatePublicIpAddress property on the Instance construct to true. Alternatively, to not automatically assign a public IPv4 address to an instance launched into a default public subnet, you can set associatePublicIpAddress to false. Including this property, removing this property, or updating the value of this property on an existing instance will result in replacement of the instance.
vpc := ec2.NewVpc(this, jsii.String("VPC"), &VpcProps{
Cidr: jsii.String("10.0.0.0/16"),
NatGateways: jsii.Number(0),
MaxAzs: jsii.Number(3),
SubnetConfiguration: []subnetConfiguration{
&subnetConfiguration{
Name: jsii.String("public-subnet-1"),
SubnetType: ec2.SubnetType_PUBLIC,
CidrMask: jsii.Number(24),
},
},
})
instance := ec2.NewInstance(this, jsii.String("Instance"), &InstanceProps{
Vpc: Vpc,
VpcSubnets: &SubnetSelection{
SubnetGroupName: jsii.String("public-subnet-1"),
},
InstanceType: ec2.InstanceType_Of(ec2.InstanceClass_T3, ec2.InstanceSize_NANO),
MachineImage: ec2.NewAmazonLinuxImage(&AmazonLinuxImageProps{
Generation: ec2.AmazonLinuxGeneration_AMAZON_LINUX_2,
}),
DetailedMonitoring: jsii.Boolean(true),
AssociatePublicIpAddress: jsii.Boolean(true),
})
Specifying a key pair
To allow SSH access to an EC2 instance by default, a Key Pair must be specified. Key pairs can
be provided with the keyPair property to instances and launch templates. You can create a
key pair for an instance like this:
var vpc vpc
var instanceType instanceType
keyPair := ec2.NewKeyPair(this, jsii.String("KeyPair"), &KeyPairProps{
Type: ec2.KeyPairType_ED25519,
Format: ec2.KeyPairFormat_PEM,
})
instance := ec2.NewInstance(this, jsii.String("Instance"), &InstanceProps{
Vpc: Vpc,
InstanceType: InstanceType,
MachineImage: ec2.MachineImage_LatestAmazonLinux2023(),
// Use the custom key pair
KeyPair: KeyPair,
})
When a new EC2 Key Pair is created (without imported material), the private key material is automatically stored in Systems Manager Parameter Store. This can be retrieved from the key pair construct:
keyPair := ec2.NewKeyPair(this, jsii.String("KeyPair"))
privateKey := keyPair.privateKey
If you already have an SSH key that you wish to use in EC2, that can be provided when constructing the
KeyPair. If public key material is provided, the key pair is considered "imported" and there
will not be any data automatically stored in Systems Manager Parameter Store and the type property
cannot be specified for the key pair.
keyPair := ec2.NewKeyPair(this, jsii.String("KeyPair"), &KeyPairProps{
PublicKeyMaterial: jsii.String("ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIB7jpNzG+YG0s+xIGWbxrxIZiiozHOEuzIJacvASP0mq"),
})
Using an existing EC2 Key Pair
If you already have an EC2 Key Pair created outside of the CDK, you can import that key to your CDK stack.
You can import it purely by name:
keyPair := ec2.KeyPair_FromKeyPairName(this, jsii.String("KeyPair"), jsii.String("the-keypair-name"))
Or by specifying additional attributes:
keyPair := ec2.KeyPair_FromKeyPairAttributes(this, jsii.String("KeyPair"), &KeyPairAttributes{
KeyPairName: jsii.String("the-keypair-name"),
Type: ec2.KeyPairType_RSA,
})
Using IPv6 IPs
Instances can be given IPv6 IPs by launching them into a subnet of a dual stack VPC.
vpc := ec2.NewVpc(this, jsii.String("Ip6VpcDualStack"), &VpcProps{
IpProtocol: ec2.IpProtocol_DUAL_STACK,
SubnetConfiguration: []subnetConfiguration{
&subnetConfiguration{
Name: jsii.String("Public"),
SubnetType: ec2.SubnetType_PUBLIC,
MapPublicIpOnLaunch: jsii.Boolean(true),
},
&subnetConfiguration{
Name: jsii.String("Private"),
SubnetType: ec2.SubnetType_PRIVATE_ISOLATED,
},
},
})
instance := ec2.NewInstance(this, jsii.String("MyInstance"), &InstanceProps{
InstanceType: ec2.InstanceType_Of(ec2.InstanceClass_T2, ec2.InstanceSize_MICRO),
MachineImage: ec2.MachineImage_LatestAmazonLinux2(),
Vpc: vpc,
VpcSubnets: &SubnetSelection{
SubnetType: ec2.SubnetType_PUBLIC,
},
AllowAllIpv6Outbound: jsii.Boolean(true),
})
instance.Connections.AllowFrom(ec2.Peer_AnyIpv6(), ec2.Port_AllIcmpV6(), jsii.String("allow ICMPv6"))
Note to set mapPublicIpOnLaunch to true in the subnetConfiguration.
Additionally, IPv6 support varies by instance type. Most instance types have IPv6 support with exception of m1-m3, c1, g2, and t1.micro. A full list can be found here: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html#AvailableIpPerENI.
Specifying the IPv6 Address
If you want to specify the number of IPv6 addresses to assign to the instance, you can use the ipv6AddresseCount property:
// dual stack VPC
var vpc vpc
instance := ec2.NewInstance(this, jsii.String("MyInstance"), &InstanceProps{
InstanceType: ec2.InstanceType_Of(ec2.InstanceClass_M5, ec2.InstanceSize_LARGE),
MachineImage: ec2.MachineImage_LatestAmazonLinux2(),
Vpc: vpc,
VpcSubnets: &SubnetSelection{
SubnetType: ec2.SubnetType_PUBLIC,
},
// Assign 2 IPv6 addresses to the instance
Ipv6AddressCount: jsii.Number(2),
})
Credit configuration modes for burstable instances
You can set the credit configuration mode for burstable instances (T2, T3, T3a and T4g instance types):
var vpc vpc
instance := ec2.NewInstance(this, jsii.String("Instance"), &InstanceProps{
InstanceType: ec2.InstanceType_Of(ec2.InstanceClass_T3, ec2.InstanceSize_MICRO),
MachineImage: ec2.MachineImage_LatestAmazonLinux2(),
Vpc: vpc,
CreditSpecification: ec2.CpuCredits_STANDARD,
})
It is also possible to set the credit configuration mode for NAT instances.
natInstanceProvider := ec2.NatProvider_Instance(&NatInstanceProps{
InstanceType: ec2.InstanceType_Of(ec2.InstanceClass_T4G, ec2.InstanceSize_LARGE),
MachineImage: ec2.NewAmazonLinuxImage(),
CreditSpecification: ec2.CpuCredits_UNLIMITED,
})
ec2.NewVpc(this, jsii.String("VPC"), &VpcProps{
NatGatewayProvider: natInstanceProvider,
})
Note: CpuCredits.UNLIMITED mode is not supported for T3 instances that are launched on a Dedicated Host.
Shutdown behavior
You can specify the behavior of the instance when you initiate shutdown from the instance (using the operating system command for system shutdown).
var vpc vpc
ec2.NewInstance(this, jsii.String("Instance"), &InstanceProps{
Vpc: Vpc,
InstanceType: ec2.InstanceType_Of(ec2.InstanceClass_T3, ec2.InstanceSize_NANO),
MachineImage: ec2.NewAmazonLinuxImage(&AmazonLinuxImageProps{
Generation: ec2.AmazonLinuxGeneration_AMAZON_LINUX_2,
}),
InstanceInitiatedShutdownBehavior: ec2.InstanceInitiatedShutdownBehavior_TERMINATE,
})
Enabling Nitro Enclaves
You can enable AWS Nitro Enclaves for
your EC2 instances by setting the enclaveEnabled property to true. Nitro Enclaves is a feature of
AWS Nitro System that enables creating isolated and highly constrained CPU environments known as enclaves.
var vpc vpc
instance := ec2.NewInstance(this, jsii.String("Instance"), &InstanceProps{
InstanceType: ec2.InstanceType_Of(ec2.InstanceClass_M5, ec2.InstanceSize_XLARGE),
MachineImage: ec2.NewAmazonLinuxImage(),
Vpc: vpc,
EnclaveEnabled: jsii.Boolean(true),
})
NOTE: You must use an instance type and operating system that support Nitro Enclaves. For more information, see Requirements.
Enabling Instance Hibernation
You can enable Instance Hibernation for
your EC2 instances by setting the hibernationEnabled property to true. Instance Hibernation saves the
instance's in-memory (RAM) state when an instance is stopped, and restores that state when the instance is started.
var vpc vpc
instance := ec2.NewInstance(this, jsii.String("Instance"), &InstanceProps{
InstanceType: ec2.InstanceType_Of(ec2.InstanceClass_M5, ec2.InstanceSize_XLARGE),
MachineImage: ec2.NewAmazonLinuxImage(),
Vpc: vpc,
HibernationEnabled: jsii.Boolean(true),
BlockDevices: []blockDevice{
&blockDevice{
DeviceName: jsii.String("/dev/xvda"),
Volume: ec2.BlockDeviceVolume_Ebs(jsii.Number(30), &EbsDeviceOptions{
VolumeType: ec2.EbsDeviceVolumeType_GP3,
Encrypted: jsii.Boolean(true),
DeleteOnTermination: jsii.Boolean(true),
}),
},
},
})
NOTE: You must use an instance and a volume that meet the requirements for hibernation. For more information, see Prerequisites for Amazon EC2 instance hibernation.
VPC Flow Logs
VPC Flow Logs is a feature that enables you to capture information about the IP traffic going to and from network interfaces in your VPC. Flow log data can be published to Amazon CloudWatch Logs and Amazon S3. After you've created a flow log, you can retrieve and view its data in the chosen destination. (https://docs.aws.amazon.com/vpc/latest/userguide/flow-logs.html).
By default, a flow log will be created with CloudWatch Logs as the destination.
You can create a flow log like this:
var vpc vpc
ec2.NewFlowLog(this, jsii.String("FlowLog"), &FlowLogProps{
ResourceType: ec2.FlowLogResourceType_FromVpc(vpc),
})
Or you can add a Flow Log to a VPC by using the addFlowLog method like this:
vpc := ec2.NewVpc(this, jsii.String("Vpc"))
vpc.addFlowLog(jsii.String("FlowLog"))
You can also add multiple flow logs with different destinations.
vpc := ec2.NewVpc(this, jsii.String("Vpc"))
vpc.addFlowLog(jsii.String("FlowLogS3"), &FlowLogOptions{
Destination: ec2.FlowLogDestination_ToS3(),
})
// Only reject traffic and interval every minute.
vpc.addFlowLog(jsii.String("FlowLogCloudWatch"), &FlowLogOptions{
TrafficType: ec2.FlowLogTrafficType_REJECT,
MaxAggregationInterval: ec2.FlowLogMaxAggregationInterval_ONE_MINUTE,
})
To create a Transit Gateway flow log, you can use the fromTransitGatewayId method:
var tgw cfnTransitGateway
ec2.NewFlowLog(this, jsii.String("TransitGatewayFlowLog"), &FlowLogProps{
ResourceType: ec2.FlowLogResourceType_FromTransitGatewayId(tgw.ref),
})
To create a Transit Gateway Attachment flow log, you can use the fromTransitGatewayAttachmentId method:
var tgwAttachment cfnTransitGatewayAttachment
ec2.NewFlowLog(this, jsii.String("TransitGatewayAttachmentFlowLog"), &FlowLogProps{
ResourceType: ec2.FlowLogResourceType_FromTransitGatewayAttachmentId(tgwAttachment.ref),
})
For flow logs targeting TransitGateway and TransitGatewayAttachment, specifying the trafficType is not possible.
Custom Formatting
You can also custom format flow logs.
vpc := ec2.NewVpc(this, jsii.String("Vpc"))
vpc.addFlowLog(jsii.String("FlowLog"), &FlowLogOptions{
LogFormat: []logFormat{
ec2.*logFormat_DST_PORT(),
ec2.*logFormat_SRC_PORT(),
},
})
// If you just want to add a field to the default field
vpc.addFlowLog(jsii.String("FlowLog"), &FlowLogOptions{
LogFormat: []*logFormat{
ec2.*logFormat_VERSION(),
ec2.*logFormat_ALL_DEFAULT_FIELDS(),
},
})
// If AWS CDK does not support the new fields
vpc.addFlowLog(jsii.String("FlowLog"), &FlowLogOptions{
LogFormat: []*logFormat{
ec2.*logFormat_SRC_PORT(),
ec2.*logFormat_Custom(jsii.String("${new-field}")),
},
})
By default, the CDK will create the necessary resources for the destination. For the CloudWatch Logs destination it will create a CloudWatch Logs Log Group as well as the IAM role with the necessary permissions to publish to the log group. In the case of an S3 destination, it will create the S3 bucket.
If you want to customize any of the destination resources you can provide your own as part of the destination.
CloudWatch Logs
var vpc vpc
logGroup := logs.NewLogGroup(this, jsii.String("MyCustomLogGroup"))
role := iam.NewRole(this, jsii.String("MyCustomRole"), &RoleProps{
AssumedBy: iam.NewServicePrincipal(jsii.String("vpc-flow-logs.amazonaws.com")),
})
ec2.NewFlowLog(this, jsii.String("FlowLog"), &FlowLogProps{
ResourceType: ec2.FlowLogResourceType_FromVpc(vpc),
Destination: ec2.FlowLogDestination_ToCloudWatchLogs(logGroup, role),
})
S3
var vpc vpc
bucket := s3.NewBucket(this, jsii.String("MyCustomBucket"))
ec2.NewFlowLog(this, jsii.String("FlowLog"), &FlowLogProps{
ResourceType: ec2.FlowLogResourceType_FromVpc(vpc),
Destination: ec2.FlowLogDestination_ToS3(bucket),
})
ec2.NewFlowLog(this, jsii.String("FlowLogWithKeyPrefix"), &FlowLogProps{
ResourceType: ec2.FlowLogResourceType_*FromVpc(vpc),
Destination: ec2.FlowLogDestination_*ToS3(bucket, jsii.String("prefix/")),
})
Kinesis Data Firehose
import firehose "github.com/aws/aws-cdk-go/awscdk"
var vpc vpc
var deliveryStream cfnDeliveryStream
vpc.addFlowLog(jsii.String("FlowLogsKinesisDataFirehose"), &FlowLogOptions{
Destination: ec2.FlowLogDestination_ToKinesisDataFirehoseDestination(deliveryStream.AttrArn),
})
When the S3 destination is configured, AWS will automatically create an S3 bucket policy
that allows the service to write logs to the bucket. This makes it impossible to later update
that bucket policy. To have CDK create the bucket policy so that future updates can be made,
the @aws-cdk/aws-s3:createDefaultLoggingPolicy feature flag can be used. This can be set
in the cdk.json file.
{
"context": {
"@aws-cdk/aws-s3:createDefaultLoggingPolicy": true
}
}
User Data
User data enables you to run a script when your instances start up. In order to configure these scripts you can add commands directly to the script or you can use the UserData's convenience functions to aid in the creation of your script.
A user data could be configured to run a script found in an asset through the following:
import "github.com/aws/aws-cdk-go/awscdk"
var instance instance
asset := awscdk.NewAsset(this, jsii.String("Asset"), &AssetProps{
Path: jsii.String("./configure.sh"),
})
localPath := instance.UserData.AddS3DownloadCommand(&S3DownloadOptions{
Bucket: asset.Bucket,
BucketKey: asset.S3ObjectKey,
Region: jsii.String("us-east-1"),
})
instance.UserData.AddExecuteFileCommand(&ExecuteFileOptions{
FilePath: localPath,
Arguments: jsii.String("--verbose -y"),
})
asset.GrantRead(instance.Role)
Persisting user data
By default, EC2 UserData is run once on only the first time that an instance is started. It is possible to make the user data script run on every start of the instance.
When creating a Windows UserData you can use the persist option to set whether or not to add
<persist>true</persist> to the user data script. it can be used as follows:
windowsUserData := ec2.UserData_ForWindows(&WindowsUserDataOptions{
Persist: jsii.Boolean(true),
})
For a Linux instance, this can be accomplished by using a Multipart user data to configure cloud-config as detailed in: https://aws.amazon.com/premiumsupport/knowledge-center/execute-user-data-ec2/
Multipart user data
In addition, to above the MultipartUserData can be used to change instance startup behavior. Multipart user data are composed
from separate parts forming archive. The most common parts are scripts executed during instance set-up. However, there are other
kinds, too.
The advantage of multipart archive is in flexibility when it's needed to add additional parts or to use specialized parts to
fine tune instance startup. Some services (like AWS Batch) support only MultipartUserData.
The parts can be executed at different moment of instance start-up and can serve a different purpose. This is controlled by contentType property.
For common scripts, text/x-shellscript; charset="utf-8" can be used as content type.
In order to create archive the MultipartUserData has to be instantiated. Than, user can add parts to multipart archive using addPart. The MultipartBody contains methods supporting creation of body parts.
If the very custom part is required, it can be created using MultipartUserData.fromRawBody, in this case full control over content type,
transfer encoding, and body properties is given to the user.
Below is an example for creating multipart user data with single body part responsible for installing awscli and configuring maximum size
of storage used by Docker containers:
bootHookConf := ec2.UserData_ForLinux()
bootHookConf.AddCommands(jsii.String("cloud-init-per once docker_options echo 'OPTIONS=\"${OPTIONS} --storage-opt dm.basesize=40G\"' >> /etc/sysconfig/docker"))
setupCommands := ec2.UserData_ForLinux()
setupCommands.AddCommands(jsii.String("sudo yum install awscli && echo Packages installed らと > /var/tmp/setup"))
multipartUserData := ec2.NewMultipartUserData()
// The docker has to be configured at early stage, so content type is overridden to boothook
multipartUserData.AddPart(ec2.MultipartBody_FromUserData(bootHookConf, jsii.String("text/cloud-boothook; charset=\"us-ascii\"")))
// Execute the rest of setup
multipartUserData.AddPart(ec2.MultipartBody_FromUserData(setupCommands))
ec2.NewLaunchTemplate(this, jsii.String(""), &LaunchTemplateProps{
UserData: multipartUserData,
BlockDevices: []blockDevice{
},
})
For more information see Specifying Multiple User Data Blocks Using a MIME Multi Part Archive
Using add*Command on MultipartUserData
To use the add*Command methods, that are inherited from the UserData interface, on MultipartUserData you must add a part
to the MultipartUserData and designate it as the receiver for these methods. This is accomplished by using the addUserDataPart()
method on MultipartUserData with the makeDefault argument set to true:
multipartUserData := ec2.NewMultipartUserData()
commandsUserData := ec2.UserData_ForLinux()
multipartUserData.AddUserDataPart(commandsUserData, ec2.MultipartBody_SHELL_SCRIPT(), jsii.Boolean(true))
// Adding commands to the multipartUserData adds them to commandsUserData, and vice-versa.
multipartUserData.AddCommands(jsii.String("touch /root/multi.txt"))
commandsUserData.AddCommands(jsii.String("touch /root/userdata.txt"))
When used on an EC2 instance, the above multipartUserData will create both multi.txt and userdata.txt in /root.
Importing existing subnet
To import an existing Subnet, call Subnet.fromSubnetAttributes() or
Subnet.fromSubnetId(). Only if you supply the subnet's Availability Zone
and Route Table Ids when calling Subnet.fromSubnetAttributes() will you be
able to use the CDK features that use these values (such as selecting one
subnet per AZ).
Importing an existing subnet looks like this:
// Supply all properties
subnet1 := ec2.Subnet_FromSubnetAttributes(this, jsii.String("SubnetFromAttributes"), &SubnetAttributes{
SubnetId: jsii.String("s-1234"),
AvailabilityZone: jsii.String("pub-az-4465"),
RouteTableId: jsii.String("rt-145"),
})
// Supply only subnet id
subnet2 := ec2.Subnet_FromSubnetId(this, jsii.String("SubnetFromId"), jsii.String("s-1234"))
Launch Templates
A Launch Template is a standardized template that contains the configuration information to launch an instance. They can be used when launching instances on their own, through Amazon EC2 Auto Scaling, EC2 Fleet, and Spot Fleet. Launch templates enable you to store launch parameters so that you do not have to specify them every time you launch an instance. For information on Launch Templates please see the official documentation.
The following demonstrates how to create a launch template with an Amazon Machine Image, security group, and an instance profile.
var vpc vpc
role := iam.NewRole(this, jsii.String("Role"), &RoleProps{
AssumedBy: iam.NewServicePrincipal(jsii.String("ec2.amazonaws.com")),
})
instanceProfile := iam.NewInstanceProfile(this, jsii.String("InstanceProfile"), &InstanceProfileProps{
Role: Role,
})
template := ec2.NewLaunchTemplate(this, jsii.String("LaunchTemplate"), &LaunchTemplateProps{
LaunchTemplateName: jsii.String("MyTemplateV1"),
VersionDescription: jsii.String("This is my v1 template"),
MachineImage: ec2.MachineImage_LatestAmazonLinux2023(),
SecurityGroup: ec2.NewSecurityGroup(this, jsii.String("LaunchTemplateSG"), &SecurityGroupProps{
Vpc: vpc,
}),
InstanceProfile: InstanceProfile,
})
And the following demonstrates how to enable metadata options support.
ec2.NewLaunchTemplate(this, jsii.String("LaunchTemplate"), &LaunchTemplateProps{
HttpEndpoint: jsii.Boolean(true),
HttpProtocolIpv6: jsii.Boolean(true),
HttpPutResponseHopLimit: jsii.Number(1),
HttpTokens: ec2.LaunchTemplateHttpTokens_REQUIRED,
InstanceMetadataTags: jsii.Boolean(true),
})
And the following demonstrates how to add one or more security groups to launch template.
var vpc vpc
sg1 := ec2.NewSecurityGroup(this, jsii.String("sg1"), &SecurityGroupProps{
Vpc: vpc,
})
sg2 := ec2.NewSecurityGroup(this, jsii.String("sg2"), &SecurityGroupProps{
Vpc: vpc,
})
launchTemplate := ec2.NewLaunchTemplate(this, jsii.String("LaunchTemplate"), &LaunchTemplateProps{
MachineImage: ec2.MachineImage_LatestAmazonLinux2023(),
SecurityGroup: sg1,
})
launchTemplate.AddSecurityGroup(sg2)
To use AWS Systems Manager parameters instead of AMI IDs in launch templates and resolve the AMI IDs at instance launch time:
launchTemplate := ec2.NewLaunchTemplate(this, jsii.String("LaunchTemplate"), &LaunchTemplateProps{
MachineImage: ec2.MachineImage_ResolveSsmParameterAtLaunch(jsii.String("parameterName")),
})
Please note this feature does not support Launch Configurations.
Detailed Monitoring
The following demonstrates how to enable Detailed Monitoring for an EC2 instance. Keep in mind that Detailed Monitoring results in additional charges.
var vpc vpc
var instanceType instanceType
ec2.NewInstance(this, jsii.String("Instance1"), &InstanceProps{
Vpc: Vpc,
InstanceType: InstanceType,
MachineImage: ec2.MachineImage_LatestAmazonLinux2023(),
DetailedMonitoring: jsii.Boolean(true),
})
Connecting to your instances using SSM Session Manager
SSM Session Manager makes it possible to connect to your instances from the AWS Console, without preparing SSH keys.
To do so, you need to:
- Use an image with SSM agent installed and configured. Many images come with SSM Agent preinstalled, otherwise you may need to manually put instructions to install SSM Agent into your instance's UserData or use EC2 Init).
- Create the instance with
ssmSessionPermissions: true.
If these conditions are met, you can connect to the instance from the EC2 Console. Example:
var vpc vpc
var instanceType instanceType
ec2.NewInstance(this, jsii.String("Instance1"), &InstanceProps{
Vpc: Vpc,
InstanceType: InstanceType,
// Amazon Linux 2023 comes with SSM Agent by default
MachineImage: ec2.MachineImage_LatestAmazonLinux2023(),
// Turn on SSM
SsmSessionPermissions: jsii.Boolean(true),
})
Managed Prefix Lists
Create and manage customer-managed prefix lists. If you don't specify anything in this construct, it will manage IPv4 addresses.
You can also create an empty Prefix List with only the maximum number of entries specified, as shown in the following code. If nothing is specified, maxEntries=1.
ec2.NewPrefixList(this, jsii.String("EmptyPrefixList"), &PrefixListProps{
MaxEntries: jsii.Number(100),
})
maxEntries can also be omitted as follows. In this case maxEntries: 2, will be set.
ec2.NewPrefixList(this, jsii.String("PrefixList"), &PrefixListProps{
Entries: []entryProperty{
&entryProperty{
Cidr: jsii.String("10.0.0.1/32"),
},
&entryProperty{
Cidr: jsii.String("10.0.0.2/32"),
Description: jsii.String("sample1"),
},
},
})
For more information see Work with customer-managed prefix lists
Documentation
¶
Index ¶
- func AmazonLinux2022ImageSsmParameter_SsmParameterName(props *AmazonLinux2022ImageSsmParameterProps) *string
- func AmazonLinux2023ImageSsmParameter_SsmParameterName(props *AmazonLinux2023ImageSsmParameterProps) *string
- func AmazonLinux2ImageSsmParameter_SsmParameterName(props *AmazonLinux2ImageSsmParameterProps) *string
- func AmazonLinuxImage_SsmParameterName(props *AmazonLinuxImageProps) *string
- func BastionHostLinux_IsConstruct(x interface{}) *bool
- func BastionHostLinux_IsOwnedResource(construct constructs.IConstruct) *bool
- func BastionHostLinux_IsResource(construct constructs.IConstruct) *bool
- func CfnCapacityReservationFleet_CFN_RESOURCE_TYPE_NAME() *string
- func CfnCapacityReservationFleet_IsCfnElement(x interface{}) *bool
- func CfnCapacityReservationFleet_IsCfnResource(x interface{}) *bool
- func CfnCapacityReservationFleet_IsConstruct(x interface{}) *bool
- func CfnCapacityReservation_CFN_RESOURCE_TYPE_NAME() *string
- func CfnCapacityReservation_IsCfnElement(x interface{}) *bool
- func CfnCapacityReservation_IsCfnResource(x interface{}) *bool
- func CfnCapacityReservation_IsConstruct(x interface{}) *bool
- func CfnCarrierGateway_CFN_RESOURCE_TYPE_NAME() *string
- func CfnCarrierGateway_IsCfnElement(x interface{}) *bool
- func CfnCarrierGateway_IsCfnResource(x interface{}) *bool
- func CfnCarrierGateway_IsConstruct(x interface{}) *bool
- func CfnClientVpnAuthorizationRule_CFN_RESOURCE_TYPE_NAME() *string
- func CfnClientVpnAuthorizationRule_IsCfnElement(x interface{}) *bool
- func CfnClientVpnAuthorizationRule_IsCfnResource(x interface{}) *bool
- func CfnClientVpnAuthorizationRule_IsConstruct(x interface{}) *bool
- func CfnClientVpnEndpoint_CFN_RESOURCE_TYPE_NAME() *string
- func CfnClientVpnEndpoint_IsCfnElement(x interface{}) *bool
- func CfnClientVpnEndpoint_IsCfnResource(x interface{}) *bool
- func CfnClientVpnEndpoint_IsConstruct(x interface{}) *bool
- func CfnClientVpnRoute_CFN_RESOURCE_TYPE_NAME() *string
- func CfnClientVpnRoute_IsCfnElement(x interface{}) *bool
- func CfnClientVpnRoute_IsCfnResource(x interface{}) *bool
- func CfnClientVpnRoute_IsConstruct(x interface{}) *bool
- func CfnClientVpnTargetNetworkAssociation_CFN_RESOURCE_TYPE_NAME() *string
- func CfnClientVpnTargetNetworkAssociation_IsCfnElement(x interface{}) *bool
- func CfnClientVpnTargetNetworkAssociation_IsCfnResource(x interface{}) *bool
- func CfnClientVpnTargetNetworkAssociation_IsConstruct(x interface{}) *bool
- func CfnCustomerGateway_CFN_RESOURCE_TYPE_NAME() *string
- func CfnCustomerGateway_IsCfnElement(x interface{}) *bool
- func CfnCustomerGateway_IsCfnResource(x interface{}) *bool
- func CfnCustomerGateway_IsConstruct(x interface{}) *bool
- func CfnDHCPOptions_CFN_RESOURCE_TYPE_NAME() *string
- func CfnDHCPOptions_IsCfnElement(x interface{}) *bool
- func CfnDHCPOptions_IsCfnResource(x interface{}) *bool
- func CfnDHCPOptions_IsConstruct(x interface{}) *bool
- func CfnEC2Fleet_CFN_RESOURCE_TYPE_NAME() *string
- func CfnEC2Fleet_IsCfnElement(x interface{}) *bool
- func CfnEC2Fleet_IsCfnResource(x interface{}) *bool
- func CfnEC2Fleet_IsConstruct(x interface{}) *bool
- func CfnEIPAssociation_CFN_RESOURCE_TYPE_NAME() *string
- func CfnEIPAssociation_IsCfnElement(x interface{}) *bool
- func CfnEIPAssociation_IsCfnResource(x interface{}) *bool
- func CfnEIPAssociation_IsConstruct(x interface{}) *bool
- func CfnEIP_CFN_RESOURCE_TYPE_NAME() *string
- func CfnEIP_IsCfnElement(x interface{}) *bool
- func CfnEIP_IsCfnResource(x interface{}) *bool
- func CfnEIP_IsConstruct(x interface{}) *bool
- func CfnEgressOnlyInternetGateway_CFN_RESOURCE_TYPE_NAME() *string
- func CfnEgressOnlyInternetGateway_IsCfnElement(x interface{}) *bool
- func CfnEgressOnlyInternetGateway_IsCfnResource(x interface{}) *bool
- func CfnEgressOnlyInternetGateway_IsConstruct(x interface{}) *bool
- func CfnEnclaveCertificateIamRoleAssociation_CFN_RESOURCE_TYPE_NAME() *string
- func CfnEnclaveCertificateIamRoleAssociation_IsCfnElement(x interface{}) *bool
- func CfnEnclaveCertificateIamRoleAssociation_IsCfnResource(x interface{}) *bool
- func CfnEnclaveCertificateIamRoleAssociation_IsConstruct(x interface{}) *bool
- func CfnFlowLog_CFN_RESOURCE_TYPE_NAME() *string
- func CfnFlowLog_IsCfnElement(x interface{}) *bool
- func CfnFlowLog_IsCfnResource(x interface{}) *bool
- func CfnFlowLog_IsConstruct(x interface{}) *bool
- func CfnGatewayRouteTableAssociation_CFN_RESOURCE_TYPE_NAME() *string
- func CfnGatewayRouteTableAssociation_IsCfnElement(x interface{}) *bool
- func CfnGatewayRouteTableAssociation_IsCfnResource(x interface{}) *bool
- func CfnGatewayRouteTableAssociation_IsConstruct(x interface{}) *bool
- func CfnHost_CFN_RESOURCE_TYPE_NAME() *string
- func CfnHost_IsCfnElement(x interface{}) *bool
- func CfnHost_IsCfnResource(x interface{}) *bool
- func CfnHost_IsConstruct(x interface{}) *bool
- func CfnIPAMAllocation_CFN_RESOURCE_TYPE_NAME() *string
- func CfnIPAMAllocation_IsCfnElement(x interface{}) *bool
- func CfnIPAMAllocation_IsCfnResource(x interface{}) *bool
- func CfnIPAMAllocation_IsConstruct(x interface{}) *bool
- func CfnIPAMPoolCidr_CFN_RESOURCE_TYPE_NAME() *string
- func CfnIPAMPoolCidr_IsCfnElement(x interface{}) *bool
- func CfnIPAMPoolCidr_IsCfnResource(x interface{}) *bool
- func CfnIPAMPoolCidr_IsConstruct(x interface{}) *bool
- func CfnIPAMPool_CFN_RESOURCE_TYPE_NAME() *string
- func CfnIPAMPool_IsCfnElement(x interface{}) *bool
- func CfnIPAMPool_IsCfnResource(x interface{}) *bool
- func CfnIPAMPool_IsConstruct(x interface{}) *bool
- func CfnIPAMResourceDiscoveryAssociation_CFN_RESOURCE_TYPE_NAME() *string
- func CfnIPAMResourceDiscoveryAssociation_IsCfnElement(x interface{}) *bool
- func CfnIPAMResourceDiscoveryAssociation_IsCfnResource(x interface{}) *bool
- func CfnIPAMResourceDiscoveryAssociation_IsConstruct(x interface{}) *bool
- func CfnIPAMResourceDiscovery_CFN_RESOURCE_TYPE_NAME() *string
- func CfnIPAMResourceDiscovery_IsCfnElement(x interface{}) *bool
- func CfnIPAMResourceDiscovery_IsCfnResource(x interface{}) *bool
- func CfnIPAMResourceDiscovery_IsConstruct(x interface{}) *bool
- func CfnIPAMScope_CFN_RESOURCE_TYPE_NAME() *string
- func CfnIPAMScope_IsCfnElement(x interface{}) *bool
- func CfnIPAMScope_IsCfnResource(x interface{}) *bool
- func CfnIPAMScope_IsConstruct(x interface{}) *bool
- func CfnIPAM_CFN_RESOURCE_TYPE_NAME() *string
- func CfnIPAM_IsCfnElement(x interface{}) *bool
- func CfnIPAM_IsCfnResource(x interface{}) *bool
- func CfnIPAM_IsConstruct(x interface{}) *bool
- func CfnInstanceConnectEndpoint_CFN_RESOURCE_TYPE_NAME() *string
- func CfnInstanceConnectEndpoint_IsCfnElement(x interface{}) *bool
- func CfnInstanceConnectEndpoint_IsCfnResource(x interface{}) *bool
- func CfnInstanceConnectEndpoint_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 CfnInternetGateway_CFN_RESOURCE_TYPE_NAME() *string
- func CfnInternetGateway_IsCfnElement(x interface{}) *bool
- func CfnInternetGateway_IsCfnResource(x interface{}) *bool
- func CfnInternetGateway_IsConstruct(x interface{}) *bool
- func CfnKeyPair_CFN_RESOURCE_TYPE_NAME() *string
- func CfnKeyPair_IsCfnElement(x interface{}) *bool
- func CfnKeyPair_IsCfnResource(x interface{}) *bool
- func CfnKeyPair_IsConstruct(x interface{}) *bool
- func CfnLaunchTemplate_CFN_RESOURCE_TYPE_NAME() *string
- func CfnLaunchTemplate_IsCfnElement(x interface{}) *bool
- func CfnLaunchTemplate_IsCfnResource(x interface{}) *bool
- func CfnLaunchTemplate_IsConstruct(x interface{}) *bool
- func CfnLocalGatewayRouteTableVPCAssociation_CFN_RESOURCE_TYPE_NAME() *string
- func CfnLocalGatewayRouteTableVPCAssociation_IsCfnElement(x interface{}) *bool
- func CfnLocalGatewayRouteTableVPCAssociation_IsCfnResource(x interface{}) *bool
- func CfnLocalGatewayRouteTableVPCAssociation_IsConstruct(x interface{}) *bool
- func CfnLocalGatewayRouteTableVirtualInterfaceGroupAssociation_CFN_RESOURCE_TYPE_NAME() *string
- func CfnLocalGatewayRouteTableVirtualInterfaceGroupAssociation_IsCfnElement(x interface{}) *bool
- func CfnLocalGatewayRouteTableVirtualInterfaceGroupAssociation_IsCfnResource(x interface{}) *bool
- func CfnLocalGatewayRouteTableVirtualInterfaceGroupAssociation_IsConstruct(x interface{}) *bool
- func CfnLocalGatewayRouteTable_CFN_RESOURCE_TYPE_NAME() *string
- func CfnLocalGatewayRouteTable_IsCfnElement(x interface{}) *bool
- func CfnLocalGatewayRouteTable_IsCfnResource(x interface{}) *bool
- func CfnLocalGatewayRouteTable_IsConstruct(x interface{}) *bool
- func CfnLocalGatewayRoute_CFN_RESOURCE_TYPE_NAME() *string
- func CfnLocalGatewayRoute_IsCfnElement(x interface{}) *bool
- func CfnLocalGatewayRoute_IsCfnResource(x interface{}) *bool
- func CfnLocalGatewayRoute_IsConstruct(x interface{}) *bool
- func CfnNatGateway_CFN_RESOURCE_TYPE_NAME() *string
- func CfnNatGateway_IsCfnElement(x interface{}) *bool
- func CfnNatGateway_IsCfnResource(x interface{}) *bool
- func CfnNatGateway_IsConstruct(x interface{}) *bool
- func CfnNetworkAclEntry_CFN_RESOURCE_TYPE_NAME() *string
- func CfnNetworkAclEntry_IsCfnElement(x interface{}) *bool
- func CfnNetworkAclEntry_IsCfnResource(x interface{}) *bool
- func CfnNetworkAclEntry_IsConstruct(x interface{}) *bool
- func CfnNetworkAcl_CFN_RESOURCE_TYPE_NAME() *string
- func CfnNetworkAcl_IsCfnElement(x interface{}) *bool
- func CfnNetworkAcl_IsCfnResource(x interface{}) *bool
- func CfnNetworkAcl_IsConstruct(x interface{}) *bool
- func CfnNetworkInsightsAccessScopeAnalysis_CFN_RESOURCE_TYPE_NAME() *string
- func CfnNetworkInsightsAccessScopeAnalysis_IsCfnElement(x interface{}) *bool
- func CfnNetworkInsightsAccessScopeAnalysis_IsCfnResource(x interface{}) *bool
- func CfnNetworkInsightsAccessScopeAnalysis_IsConstruct(x interface{}) *bool
- func CfnNetworkInsightsAccessScope_CFN_RESOURCE_TYPE_NAME() *string
- func CfnNetworkInsightsAccessScope_IsCfnElement(x interface{}) *bool
- func CfnNetworkInsightsAccessScope_IsCfnResource(x interface{}) *bool
- func CfnNetworkInsightsAccessScope_IsConstruct(x interface{}) *bool
- func CfnNetworkInsightsAnalysis_CFN_RESOURCE_TYPE_NAME() *string
- func CfnNetworkInsightsAnalysis_IsCfnElement(x interface{}) *bool
- func CfnNetworkInsightsAnalysis_IsCfnResource(x interface{}) *bool
- func CfnNetworkInsightsAnalysis_IsConstruct(x interface{}) *bool
- func CfnNetworkInsightsPath_CFN_RESOURCE_TYPE_NAME() *string
- func CfnNetworkInsightsPath_IsCfnElement(x interface{}) *bool
- func CfnNetworkInsightsPath_IsCfnResource(x interface{}) *bool
- func CfnNetworkInsightsPath_IsConstruct(x interface{}) *bool
- func CfnNetworkInterfaceAttachment_CFN_RESOURCE_TYPE_NAME() *string
- func CfnNetworkInterfaceAttachment_IsCfnElement(x interface{}) *bool
- func CfnNetworkInterfaceAttachment_IsCfnResource(x interface{}) *bool
- func CfnNetworkInterfaceAttachment_IsConstruct(x interface{}) *bool
- func CfnNetworkInterfacePermission_CFN_RESOURCE_TYPE_NAME() *string
- func CfnNetworkInterfacePermission_IsCfnElement(x interface{}) *bool
- func CfnNetworkInterfacePermission_IsCfnResource(x interface{}) *bool
- func CfnNetworkInterfacePermission_IsConstruct(x interface{}) *bool
- func CfnNetworkInterface_CFN_RESOURCE_TYPE_NAME() *string
- func CfnNetworkInterface_IsCfnElement(x interface{}) *bool
- func CfnNetworkInterface_IsCfnResource(x interface{}) *bool
- func CfnNetworkInterface_IsConstruct(x interface{}) *bool
- func CfnNetworkPerformanceMetricSubscription_CFN_RESOURCE_TYPE_NAME() *string
- func CfnNetworkPerformanceMetricSubscription_IsCfnElement(x interface{}) *bool
- func CfnNetworkPerformanceMetricSubscription_IsCfnResource(x interface{}) *bool
- func CfnNetworkPerformanceMetricSubscription_IsConstruct(x interface{}) *bool
- func CfnPlacementGroup_CFN_RESOURCE_TYPE_NAME() *string
- func CfnPlacementGroup_IsCfnElement(x interface{}) *bool
- func CfnPlacementGroup_IsCfnResource(x interface{}) *bool
- func CfnPlacementGroup_IsConstruct(x interface{}) *bool
- func CfnPrefixList_CFN_RESOURCE_TYPE_NAME() *string
- func CfnPrefixList_IsCfnElement(x interface{}) *bool
- func CfnPrefixList_IsCfnResource(x interface{}) *bool
- func CfnPrefixList_IsConstruct(x interface{}) *bool
- func CfnRouteTable_CFN_RESOURCE_TYPE_NAME() *string
- func CfnRouteTable_IsCfnElement(x interface{}) *bool
- func CfnRouteTable_IsCfnResource(x interface{}) *bool
- func CfnRouteTable_IsConstruct(x interface{}) *bool
- func CfnRoute_CFN_RESOURCE_TYPE_NAME() *string
- func CfnRoute_IsCfnElement(x interface{}) *bool
- func CfnRoute_IsCfnResource(x interface{}) *bool
- func CfnRoute_IsConstruct(x interface{}) *bool
- func CfnSecurityGroupEgress_CFN_RESOURCE_TYPE_NAME() *string
- func CfnSecurityGroupEgress_IsCfnElement(x interface{}) *bool
- func CfnSecurityGroupEgress_IsCfnResource(x interface{}) *bool
- func CfnSecurityGroupEgress_IsConstruct(x interface{}) *bool
- func CfnSecurityGroupIngress_CFN_RESOURCE_TYPE_NAME() *string
- func CfnSecurityGroupIngress_IsCfnElement(x interface{}) *bool
- func CfnSecurityGroupIngress_IsCfnResource(x interface{}) *bool
- func CfnSecurityGroupIngress_IsConstruct(x interface{}) *bool
- func CfnSecurityGroup_CFN_RESOURCE_TYPE_NAME() *string
- func CfnSecurityGroup_IsCfnElement(x interface{}) *bool
- func CfnSecurityGroup_IsCfnResource(x interface{}) *bool
- func CfnSecurityGroup_IsConstruct(x interface{}) *bool
- func CfnSnapshotBlockPublicAccess_CFN_RESOURCE_TYPE_NAME() *string
- func CfnSnapshotBlockPublicAccess_IsCfnElement(x interface{}) *bool
- func CfnSnapshotBlockPublicAccess_IsCfnResource(x interface{}) *bool
- func CfnSnapshotBlockPublicAccess_IsConstruct(x interface{}) *bool
- func CfnSpotFleet_CFN_RESOURCE_TYPE_NAME() *string
- func CfnSpotFleet_IsCfnElement(x interface{}) *bool
- func CfnSpotFleet_IsCfnResource(x interface{}) *bool
- func CfnSpotFleet_IsConstruct(x interface{}) *bool
- func CfnSubnetCidrBlock_CFN_RESOURCE_TYPE_NAME() *string
- func CfnSubnetCidrBlock_IsCfnElement(x interface{}) *bool
- func CfnSubnetCidrBlock_IsCfnResource(x interface{}) *bool
- func CfnSubnetCidrBlock_IsConstruct(x interface{}) *bool
- func CfnSubnetNetworkAclAssociation_CFN_RESOURCE_TYPE_NAME() *string
- func CfnSubnetNetworkAclAssociation_IsCfnElement(x interface{}) *bool
- func CfnSubnetNetworkAclAssociation_IsCfnResource(x interface{}) *bool
- func CfnSubnetNetworkAclAssociation_IsConstruct(x interface{}) *bool
- func CfnSubnetRouteTableAssociation_CFN_RESOURCE_TYPE_NAME() *string
- func CfnSubnetRouteTableAssociation_IsCfnElement(x interface{}) *bool
- func CfnSubnetRouteTableAssociation_IsCfnResource(x interface{}) *bool
- func CfnSubnetRouteTableAssociation_IsConstruct(x interface{}) *bool
- func CfnSubnet_CFN_RESOURCE_TYPE_NAME() *string
- func CfnSubnet_IsCfnElement(x interface{}) *bool
- func CfnSubnet_IsCfnResource(x interface{}) *bool
- func CfnSubnet_IsConstruct(x interface{}) *bool
- func CfnTrafficMirrorFilterRule_CFN_RESOURCE_TYPE_NAME() *string
- func CfnTrafficMirrorFilterRule_IsCfnElement(x interface{}) *bool
- func CfnTrafficMirrorFilterRule_IsCfnResource(x interface{}) *bool
- func CfnTrafficMirrorFilterRule_IsConstruct(x interface{}) *bool
- func CfnTrafficMirrorFilter_CFN_RESOURCE_TYPE_NAME() *string
- func CfnTrafficMirrorFilter_IsCfnElement(x interface{}) *bool
- func CfnTrafficMirrorFilter_IsCfnResource(x interface{}) *bool
- func CfnTrafficMirrorFilter_IsConstruct(x interface{}) *bool
- func CfnTrafficMirrorSession_CFN_RESOURCE_TYPE_NAME() *string
- func CfnTrafficMirrorSession_IsCfnElement(x interface{}) *bool
- func CfnTrafficMirrorSession_IsCfnResource(x interface{}) *bool
- func CfnTrafficMirrorSession_IsConstruct(x interface{}) *bool
- func CfnTrafficMirrorTarget_CFN_RESOURCE_TYPE_NAME() *string
- func CfnTrafficMirrorTarget_IsCfnElement(x interface{}) *bool
- func CfnTrafficMirrorTarget_IsCfnResource(x interface{}) *bool
- func CfnTrafficMirrorTarget_IsConstruct(x interface{}) *bool
- func CfnTransitGatewayAttachment_CFN_RESOURCE_TYPE_NAME() *string
- func CfnTransitGatewayAttachment_IsCfnElement(x interface{}) *bool
- func CfnTransitGatewayAttachment_IsCfnResource(x interface{}) *bool
- func CfnTransitGatewayAttachment_IsConstruct(x interface{}) *bool
- func CfnTransitGatewayConnect_CFN_RESOURCE_TYPE_NAME() *string
- func CfnTransitGatewayConnect_IsCfnElement(x interface{}) *bool
- func CfnTransitGatewayConnect_IsCfnResource(x interface{}) *bool
- func CfnTransitGatewayConnect_IsConstruct(x interface{}) *bool
- func CfnTransitGatewayMulticastDomainAssociation_CFN_RESOURCE_TYPE_NAME() *string
- func CfnTransitGatewayMulticastDomainAssociation_IsCfnElement(x interface{}) *bool
- func CfnTransitGatewayMulticastDomainAssociation_IsCfnResource(x interface{}) *bool
- func CfnTransitGatewayMulticastDomainAssociation_IsConstruct(x interface{}) *bool
- func CfnTransitGatewayMulticastDomain_CFN_RESOURCE_TYPE_NAME() *string
- func CfnTransitGatewayMulticastDomain_IsCfnElement(x interface{}) *bool
- func CfnTransitGatewayMulticastDomain_IsCfnResource(x interface{}) *bool
- func CfnTransitGatewayMulticastDomain_IsConstruct(x interface{}) *bool
- func CfnTransitGatewayMulticastGroupMember_CFN_RESOURCE_TYPE_NAME() *string
- func CfnTransitGatewayMulticastGroupMember_IsCfnElement(x interface{}) *bool
- func CfnTransitGatewayMulticastGroupMember_IsCfnResource(x interface{}) *bool
- func CfnTransitGatewayMulticastGroupMember_IsConstruct(x interface{}) *bool
- func CfnTransitGatewayMulticastGroupSource_CFN_RESOURCE_TYPE_NAME() *string
- func CfnTransitGatewayMulticastGroupSource_IsCfnElement(x interface{}) *bool
- func CfnTransitGatewayMulticastGroupSource_IsCfnResource(x interface{}) *bool
- func CfnTransitGatewayMulticastGroupSource_IsConstruct(x interface{}) *bool
- func CfnTransitGatewayPeeringAttachment_CFN_RESOURCE_TYPE_NAME() *string
- func CfnTransitGatewayPeeringAttachment_IsCfnElement(x interface{}) *bool
- func CfnTransitGatewayPeeringAttachment_IsCfnResource(x interface{}) *bool
- func CfnTransitGatewayPeeringAttachment_IsConstruct(x interface{}) *bool
- func CfnTransitGatewayRouteTableAssociation_CFN_RESOURCE_TYPE_NAME() *string
- func CfnTransitGatewayRouteTableAssociation_IsCfnElement(x interface{}) *bool
- func CfnTransitGatewayRouteTableAssociation_IsCfnResource(x interface{}) *bool
- func CfnTransitGatewayRouteTableAssociation_IsConstruct(x interface{}) *bool
- func CfnTransitGatewayRouteTablePropagation_CFN_RESOURCE_TYPE_NAME() *string
- func CfnTransitGatewayRouteTablePropagation_IsCfnElement(x interface{}) *bool
- func CfnTransitGatewayRouteTablePropagation_IsCfnResource(x interface{}) *bool
- func CfnTransitGatewayRouteTablePropagation_IsConstruct(x interface{}) *bool
- func CfnTransitGatewayRouteTable_CFN_RESOURCE_TYPE_NAME() *string
- func CfnTransitGatewayRouteTable_IsCfnElement(x interface{}) *bool
- func CfnTransitGatewayRouteTable_IsCfnResource(x interface{}) *bool
- func CfnTransitGatewayRouteTable_IsConstruct(x interface{}) *bool
- func CfnTransitGatewayRoute_CFN_RESOURCE_TYPE_NAME() *string
- func CfnTransitGatewayRoute_IsCfnElement(x interface{}) *bool
- func CfnTransitGatewayRoute_IsCfnResource(x interface{}) *bool
- func CfnTransitGatewayRoute_IsConstruct(x interface{}) *bool
- func CfnTransitGatewayVpcAttachment_CFN_RESOURCE_TYPE_NAME() *string
- func CfnTransitGatewayVpcAttachment_IsCfnElement(x interface{}) *bool
- func CfnTransitGatewayVpcAttachment_IsCfnResource(x interface{}) *bool
- func CfnTransitGatewayVpcAttachment_IsConstruct(x interface{}) *bool
- func CfnTransitGateway_CFN_RESOURCE_TYPE_NAME() *string
- func CfnTransitGateway_IsCfnElement(x interface{}) *bool
- func CfnTransitGateway_IsCfnResource(x interface{}) *bool
- func CfnTransitGateway_IsConstruct(x interface{}) *bool
- func CfnVPCCidrBlock_CFN_RESOURCE_TYPE_NAME() *string
- func CfnVPCCidrBlock_IsCfnElement(x interface{}) *bool
- func CfnVPCCidrBlock_IsCfnResource(x interface{}) *bool
- func CfnVPCCidrBlock_IsConstruct(x interface{}) *bool
- func CfnVPCDHCPOptionsAssociation_CFN_RESOURCE_TYPE_NAME() *string
- func CfnVPCDHCPOptionsAssociation_IsCfnElement(x interface{}) *bool
- func CfnVPCDHCPOptionsAssociation_IsCfnResource(x interface{}) *bool
- func CfnVPCDHCPOptionsAssociation_IsConstruct(x interface{}) *bool
- func CfnVPCEndpointConnectionNotification_CFN_RESOURCE_TYPE_NAME() *string
- func CfnVPCEndpointConnectionNotification_IsCfnElement(x interface{}) *bool
- func CfnVPCEndpointConnectionNotification_IsCfnResource(x interface{}) *bool
- func CfnVPCEndpointConnectionNotification_IsConstruct(x interface{}) *bool
- func CfnVPCEndpointServicePermissions_CFN_RESOURCE_TYPE_NAME() *string
- func CfnVPCEndpointServicePermissions_IsCfnElement(x interface{}) *bool
- func CfnVPCEndpointServicePermissions_IsCfnResource(x interface{}) *bool
- func CfnVPCEndpointServicePermissions_IsConstruct(x interface{}) *bool
- func CfnVPCEndpointService_CFN_RESOURCE_TYPE_NAME() *string
- func CfnVPCEndpointService_IsCfnElement(x interface{}) *bool
- func CfnVPCEndpointService_IsCfnResource(x interface{}) *bool
- func CfnVPCEndpointService_IsConstruct(x interface{}) *bool
- func CfnVPCEndpoint_CFN_RESOURCE_TYPE_NAME() *string
- func CfnVPCEndpoint_IsCfnElement(x interface{}) *bool
- func CfnVPCEndpoint_IsCfnResource(x interface{}) *bool
- func CfnVPCEndpoint_IsConstruct(x interface{}) *bool
- func CfnVPCGatewayAttachment_CFN_RESOURCE_TYPE_NAME() *string
- func CfnVPCGatewayAttachment_IsCfnElement(x interface{}) *bool
- func CfnVPCGatewayAttachment_IsCfnResource(x interface{}) *bool
- func CfnVPCGatewayAttachment_IsConstruct(x interface{}) *bool
- func CfnVPCPeeringConnection_CFN_RESOURCE_TYPE_NAME() *string
- func CfnVPCPeeringConnection_IsCfnElement(x interface{}) *bool
- func CfnVPCPeeringConnection_IsCfnResource(x interface{}) *bool
- func CfnVPCPeeringConnection_IsConstruct(x interface{}) *bool
- func CfnVPC_CFN_RESOURCE_TYPE_NAME() *string
- func CfnVPC_IsCfnElement(x interface{}) *bool
- func CfnVPC_IsCfnResource(x interface{}) *bool
- func CfnVPC_IsConstruct(x interface{}) *bool
- func CfnVPNConnectionRoute_CFN_RESOURCE_TYPE_NAME() *string
- func CfnVPNConnectionRoute_IsCfnElement(x interface{}) *bool
- func CfnVPNConnectionRoute_IsCfnResource(x interface{}) *bool
- func CfnVPNConnectionRoute_IsConstruct(x interface{}) *bool
- func CfnVPNConnection_CFN_RESOURCE_TYPE_NAME() *string
- func CfnVPNConnection_IsCfnElement(x interface{}) *bool
- func CfnVPNConnection_IsCfnResource(x interface{}) *bool
- func CfnVPNConnection_IsConstruct(x interface{}) *bool
- func CfnVPNGatewayRoutePropagation_CFN_RESOURCE_TYPE_NAME() *string
- func CfnVPNGatewayRoutePropagation_IsCfnElement(x interface{}) *bool
- func CfnVPNGatewayRoutePropagation_IsCfnResource(x interface{}) *bool
- func CfnVPNGatewayRoutePropagation_IsConstruct(x interface{}) *bool
- func CfnVPNGateway_CFN_RESOURCE_TYPE_NAME() *string
- func CfnVPNGateway_IsCfnElement(x interface{}) *bool
- func CfnVPNGateway_IsCfnResource(x interface{}) *bool
- func CfnVPNGateway_IsConstruct(x interface{}) *bool
- func CfnVerifiedAccessEndpoint_CFN_RESOURCE_TYPE_NAME() *string
- func CfnVerifiedAccessEndpoint_IsCfnElement(x interface{}) *bool
- func CfnVerifiedAccessEndpoint_IsCfnResource(x interface{}) *bool
- func CfnVerifiedAccessEndpoint_IsConstruct(x interface{}) *bool
- func CfnVerifiedAccessGroup_CFN_RESOURCE_TYPE_NAME() *string
- func CfnVerifiedAccessGroup_IsCfnElement(x interface{}) *bool
- func CfnVerifiedAccessGroup_IsCfnResource(x interface{}) *bool
- func CfnVerifiedAccessGroup_IsConstruct(x interface{}) *bool
- func CfnVerifiedAccessInstance_CFN_RESOURCE_TYPE_NAME() *string
- func CfnVerifiedAccessInstance_IsCfnElement(x interface{}) *bool
- func CfnVerifiedAccessInstance_IsCfnResource(x interface{}) *bool
- func CfnVerifiedAccessInstance_IsConstruct(x interface{}) *bool
- func CfnVerifiedAccessTrustProvider_CFN_RESOURCE_TYPE_NAME() *string
- func CfnVerifiedAccessTrustProvider_IsCfnElement(x interface{}) *bool
- func CfnVerifiedAccessTrustProvider_IsCfnResource(x interface{}) *bool
- func CfnVerifiedAccessTrustProvider_IsConstruct(x interface{}) *bool
- func CfnVolumeAttachment_CFN_RESOURCE_TYPE_NAME() *string
- func CfnVolumeAttachment_IsCfnElement(x interface{}) *bool
- func CfnVolumeAttachment_IsCfnResource(x interface{}) *bool
- func CfnVolumeAttachment_IsConstruct(x interface{}) *bool
- func CfnVolume_CFN_RESOURCE_TYPE_NAME() *string
- func CfnVolume_IsCfnElement(x interface{}) *bool
- func CfnVolume_IsCfnResource(x interface{}) *bool
- func CfnVolume_IsConstruct(x interface{}) *bool
- func ClientVpnAuthorizationRule_IsConstruct(x interface{}) *bool
- func ClientVpnAuthorizationRule_IsOwnedResource(construct constructs.IConstruct) *bool
- func ClientVpnAuthorizationRule_IsResource(construct constructs.IConstruct) *bool
- func ClientVpnEndpoint_IsConstruct(x interface{}) *bool
- func ClientVpnEndpoint_IsOwnedResource(construct constructs.IConstruct) *bool
- func ClientVpnEndpoint_IsResource(construct constructs.IConstruct) *bool
- func ClientVpnRoute_IsConstruct(x interface{}) *bool
- func ClientVpnRoute_IsOwnedResource(construct constructs.IConstruct) *bool
- func ClientVpnRoute_IsResource(construct constructs.IConstruct) *bool
- func FlowLog_IsConstruct(x interface{}) *bool
- func FlowLog_IsOwnedResource(construct constructs.IConstruct) *bool
- func FlowLog_IsResource(construct constructs.IConstruct) *bool
- func GatewayVpcEndpoint_IsConstruct(x interface{}) *bool
- func GatewayVpcEndpoint_IsOwnedResource(construct constructs.IConstruct) *bool
- func GatewayVpcEndpoint_IsResource(construct constructs.IConstruct) *bool
- func Instance_IsConstruct(x interface{}) *bool
- func Instance_IsOwnedResource(construct constructs.IConstruct) *bool
- func Instance_IsResource(construct constructs.IConstruct) *bool
- func InterfaceVpcEndpoint_IsConstruct(x interface{}) *bool
- func InterfaceVpcEndpoint_IsOwnedResource(construct constructs.IConstruct) *bool
- func InterfaceVpcEndpoint_IsResource(construct constructs.IConstruct) *bool
- func KeyPair_IsConstruct(x interface{}) *bool
- func KeyPair_IsOwnedResource(construct constructs.IConstruct) *bool
- func KeyPair_IsResource(construct constructs.IConstruct) *bool
- func LaunchTemplateSpecialVersions_DEFAULT_VERSION() *string
- func LaunchTemplateSpecialVersions_LATEST_VERSION() *string
- func LaunchTemplate_IsConstruct(x interface{}) *bool
- func LaunchTemplate_IsOwnedResource(construct constructs.IConstruct) *bool
- func LaunchTemplate_IsResource(construct constructs.IConstruct) *bool
- func MultipartBody_CLOUD_BOOTHOOK() *string
- func MultipartBody_SHELL_SCRIPT() *string
- func NatInstanceProviderV2_DEFAULT_USER_DATA_COMMANDS() *[]*string
- func NetworkAclEntry_IsConstruct(x interface{}) *bool
- func NetworkAclEntry_IsOwnedResource(construct constructs.IConstruct) *bool
- func NetworkAclEntry_IsResource(construct constructs.IConstruct) *bool
- func NetworkAcl_IsConstruct(x interface{}) *bool
- func NetworkAcl_IsOwnedResource(construct constructs.IConstruct) *bool
- func NetworkAcl_IsResource(construct constructs.IConstruct) *bool
- func NewAclCidr_Override(a AclCidr)
- func NewAclTraffic_Override(a AclTraffic)
- func NewAmazonLinux2022ImageSsmParameter_Override(a AmazonLinux2022ImageSsmParameter, ...)
- func NewAmazonLinux2022Kernel_Override(a AmazonLinux2022Kernel, version *string)
- func NewAmazonLinux2023ImageSsmParameter_Override(a AmazonLinux2023ImageSsmParameter, ...)
- func NewAmazonLinux2023Kernel_Override(a AmazonLinux2023Kernel, version *string)
- func NewAmazonLinux2ImageSsmParameter_Override(a AmazonLinux2ImageSsmParameter, props *AmazonLinux2ImageSsmParameterProps)
- func NewAmazonLinux2Kernel_Override(a AmazonLinux2Kernel, version *string)
- func NewAmazonLinuxImageSsmParameterBase_Override(a AmazonLinuxImageSsmParameterBase, ...)
- func NewAmazonLinuxImage_Override(a AmazonLinuxImage, props *AmazonLinuxImageProps)
- func NewBastionHostLinux_Override(b BastionHostLinux, scope constructs.Construct, id *string, ...)
- func NewBlockDeviceVolume_Override(b BlockDeviceVolume, ebsDevice *EbsDeviceProps, virtualName *string)
- func NewCfnCapacityReservationFleet_Override(c CfnCapacityReservationFleet, scope constructs.Construct, id *string, ...)
- func NewCfnCapacityReservation_Override(c CfnCapacityReservation, scope constructs.Construct, id *string, ...)
- func NewCfnCarrierGateway_Override(c CfnCarrierGateway, scope constructs.Construct, id *string, ...)
- func NewCfnClientVpnAuthorizationRule_Override(c CfnClientVpnAuthorizationRule, scope constructs.Construct, id *string, ...)
- func NewCfnClientVpnEndpoint_Override(c CfnClientVpnEndpoint, scope constructs.Construct, id *string, ...)
- func NewCfnClientVpnRoute_Override(c CfnClientVpnRoute, scope constructs.Construct, id *string, ...)
- func NewCfnClientVpnTargetNetworkAssociation_Override(c CfnClientVpnTargetNetworkAssociation, scope constructs.Construct, id *string, ...)
- func NewCfnCustomerGateway_Override(c CfnCustomerGateway, scope constructs.Construct, id *string, ...)
- func NewCfnDHCPOptions_Override(c CfnDHCPOptions, scope constructs.Construct, id *string, ...)
- func NewCfnEC2Fleet_Override(c CfnEC2Fleet, scope constructs.Construct, id *string, props *CfnEC2FleetProps)
- func NewCfnEIPAssociation_Override(c CfnEIPAssociation, scope constructs.Construct, id *string, ...)
- func NewCfnEIP_Override(c CfnEIP, scope constructs.Construct, id *string, props *CfnEIPProps)
- func NewCfnEgressOnlyInternetGateway_Override(c CfnEgressOnlyInternetGateway, scope constructs.Construct, id *string, ...)
- func NewCfnEnclaveCertificateIamRoleAssociation_Override(c CfnEnclaveCertificateIamRoleAssociation, scope constructs.Construct, ...)
- func NewCfnFlowLog_Override(c CfnFlowLog, scope constructs.Construct, id *string, props *CfnFlowLogProps)
- func NewCfnGatewayRouteTableAssociation_Override(c CfnGatewayRouteTableAssociation, scope constructs.Construct, id *string, ...)
- func NewCfnHost_Override(c CfnHost, scope constructs.Construct, id *string, props *CfnHostProps)
- func NewCfnIPAMAllocation_Override(c CfnIPAMAllocation, scope constructs.Construct, id *string, ...)
- func NewCfnIPAMPoolCidr_Override(c CfnIPAMPoolCidr, scope constructs.Construct, id *string, ...)
- func NewCfnIPAMPool_Override(c CfnIPAMPool, scope constructs.Construct, id *string, props *CfnIPAMPoolProps)
- func NewCfnIPAMResourceDiscoveryAssociation_Override(c CfnIPAMResourceDiscoveryAssociation, scope constructs.Construct, id *string, ...)
- func NewCfnIPAMResourceDiscovery_Override(c CfnIPAMResourceDiscovery, scope constructs.Construct, id *string, ...)
- func NewCfnIPAMScope_Override(c CfnIPAMScope, scope constructs.Construct, id *string, ...)
- func NewCfnIPAM_Override(c CfnIPAM, scope constructs.Construct, id *string, props *CfnIPAMProps)
- func NewCfnInstanceConnectEndpoint_Override(c CfnInstanceConnectEndpoint, scope constructs.Construct, id *string, ...)
- func NewCfnInstance_Override(c CfnInstance, scope constructs.Construct, id *string, props *CfnInstanceProps)
- func NewCfnInternetGateway_Override(c CfnInternetGateway, scope constructs.Construct, id *string, ...)
- func NewCfnKeyPair_Override(c CfnKeyPair, scope constructs.Construct, id *string, props *CfnKeyPairProps)
- func NewCfnLaunchTemplate_Override(c CfnLaunchTemplate, scope constructs.Construct, id *string, ...)
- func NewCfnLocalGatewayRouteTableVPCAssociation_Override(c CfnLocalGatewayRouteTableVPCAssociation, scope constructs.Construct, ...)
- func NewCfnLocalGatewayRouteTableVirtualInterfaceGroupAssociation_Override(c CfnLocalGatewayRouteTableVirtualInterfaceGroupAssociation, ...)
- func NewCfnLocalGatewayRouteTable_Override(c CfnLocalGatewayRouteTable, scope constructs.Construct, id *string, ...)
- func NewCfnLocalGatewayRoute_Override(c CfnLocalGatewayRoute, scope constructs.Construct, id *string, ...)
- func NewCfnNatGateway_Override(c CfnNatGateway, scope constructs.Construct, id *string, ...)
- func NewCfnNetworkAclEntry_Override(c CfnNetworkAclEntry, scope constructs.Construct, id *string, ...)
- func NewCfnNetworkAcl_Override(c CfnNetworkAcl, scope constructs.Construct, id *string, ...)
- func NewCfnNetworkInsightsAccessScopeAnalysis_Override(c CfnNetworkInsightsAccessScopeAnalysis, scope constructs.Construct, ...)
- func NewCfnNetworkInsightsAccessScope_Override(c CfnNetworkInsightsAccessScope, scope constructs.Construct, id *string, ...)
- func NewCfnNetworkInsightsAnalysis_Override(c CfnNetworkInsightsAnalysis, scope constructs.Construct, id *string, ...)
- func NewCfnNetworkInsightsPath_Override(c CfnNetworkInsightsPath, scope constructs.Construct, id *string, ...)
- func NewCfnNetworkInterfaceAttachment_Override(c CfnNetworkInterfaceAttachment, scope constructs.Construct, id *string, ...)
- func NewCfnNetworkInterfacePermission_Override(c CfnNetworkInterfacePermission, scope constructs.Construct, id *string, ...)
- func NewCfnNetworkInterface_Override(c CfnNetworkInterface, scope constructs.Construct, id *string, ...)
- func NewCfnNetworkPerformanceMetricSubscription_Override(c CfnNetworkPerformanceMetricSubscription, scope constructs.Construct, ...)
- func NewCfnPlacementGroup_Override(c CfnPlacementGroup, scope constructs.Construct, id *string, ...)
- func NewCfnPrefixList_Override(c CfnPrefixList, scope constructs.Construct, id *string, ...)
- func NewCfnRouteTable_Override(c CfnRouteTable, scope constructs.Construct, id *string, ...)
- func NewCfnRoute_Override(c CfnRoute, scope constructs.Construct, id *string, props *CfnRouteProps)
- func NewCfnSecurityGroupEgress_Override(c CfnSecurityGroupEgress, scope constructs.Construct, id *string, ...)
- func NewCfnSecurityGroupIngress_Override(c CfnSecurityGroupIngress, scope constructs.Construct, id *string, ...)
- func NewCfnSecurityGroup_Override(c CfnSecurityGroup, scope constructs.Construct, id *string, ...)
- func NewCfnSnapshotBlockPublicAccess_Override(c CfnSnapshotBlockPublicAccess, scope constructs.Construct, id *string, ...)
- func NewCfnSpotFleet_Override(c CfnSpotFleet, scope constructs.Construct, id *string, ...)
- func NewCfnSubnetCidrBlock_Override(c CfnSubnetCidrBlock, scope constructs.Construct, id *string, ...)
- func NewCfnSubnetNetworkAclAssociation_Override(c CfnSubnetNetworkAclAssociation, scope constructs.Construct, id *string, ...)
- func NewCfnSubnetRouteTableAssociation_Override(c CfnSubnetRouteTableAssociation, scope constructs.Construct, id *string, ...)
- func NewCfnSubnet_Override(c CfnSubnet, scope constructs.Construct, id *string, props *CfnSubnetProps)
- func NewCfnTrafficMirrorFilterRule_Override(c CfnTrafficMirrorFilterRule, scope constructs.Construct, id *string, ...)
- func NewCfnTrafficMirrorFilter_Override(c CfnTrafficMirrorFilter, scope constructs.Construct, id *string, ...)
- func NewCfnTrafficMirrorSession_Override(c CfnTrafficMirrorSession, scope constructs.Construct, id *string, ...)
- func NewCfnTrafficMirrorTarget_Override(c CfnTrafficMirrorTarget, scope constructs.Construct, id *string, ...)
- func NewCfnTransitGatewayAttachment_Override(c CfnTransitGatewayAttachment, scope constructs.Construct, id *string, ...)
- func NewCfnTransitGatewayConnect_Override(c CfnTransitGatewayConnect, scope constructs.Construct, id *string, ...)
- func NewCfnTransitGatewayMulticastDomainAssociation_Override(c CfnTransitGatewayMulticastDomainAssociation, scope constructs.Construct, ...)
- func NewCfnTransitGatewayMulticastDomain_Override(c CfnTransitGatewayMulticastDomain, scope constructs.Construct, id *string, ...)
- func NewCfnTransitGatewayMulticastGroupMember_Override(c CfnTransitGatewayMulticastGroupMember, scope constructs.Construct, ...)
- func NewCfnTransitGatewayMulticastGroupSource_Override(c CfnTransitGatewayMulticastGroupSource, scope constructs.Construct, ...)
- func NewCfnTransitGatewayPeeringAttachment_Override(c CfnTransitGatewayPeeringAttachment, scope constructs.Construct, id *string, ...)
- func NewCfnTransitGatewayRouteTableAssociation_Override(c CfnTransitGatewayRouteTableAssociation, scope constructs.Construct, ...)
- func NewCfnTransitGatewayRouteTablePropagation_Override(c CfnTransitGatewayRouteTablePropagation, scope constructs.Construct, ...)
- func NewCfnTransitGatewayRouteTable_Override(c CfnTransitGatewayRouteTable, scope constructs.Construct, id *string, ...)
- func NewCfnTransitGatewayRoute_Override(c CfnTransitGatewayRoute, scope constructs.Construct, id *string, ...)
- func NewCfnTransitGatewayVpcAttachment_Override(c CfnTransitGatewayVpcAttachment, scope constructs.Construct, id *string, ...)
- func NewCfnTransitGateway_Override(c CfnTransitGateway, scope constructs.Construct, id *string, ...)
- func NewCfnVPCCidrBlock_Override(c CfnVPCCidrBlock, scope constructs.Construct, id *string, ...)
- func NewCfnVPCDHCPOptionsAssociation_Override(c CfnVPCDHCPOptionsAssociation, scope constructs.Construct, id *string, ...)
- func NewCfnVPCEndpointConnectionNotification_Override(c CfnVPCEndpointConnectionNotification, scope constructs.Construct, id *string, ...)
- func NewCfnVPCEndpointServicePermissions_Override(c CfnVPCEndpointServicePermissions, scope constructs.Construct, id *string, ...)
- func NewCfnVPCEndpointService_Override(c CfnVPCEndpointService, scope constructs.Construct, id *string, ...)
- func NewCfnVPCEndpoint_Override(c CfnVPCEndpoint, scope constructs.Construct, id *string, ...)
- func NewCfnVPCGatewayAttachment_Override(c CfnVPCGatewayAttachment, scope constructs.Construct, id *string, ...)
- func NewCfnVPCPeeringConnection_Override(c CfnVPCPeeringConnection, scope constructs.Construct, id *string, ...)
- func NewCfnVPC_Override(c CfnVPC, scope constructs.Construct, id *string, props *CfnVPCProps)
- func NewCfnVPNConnectionRoute_Override(c CfnVPNConnectionRoute, scope constructs.Construct, id *string, ...)
- func NewCfnVPNConnection_Override(c CfnVPNConnection, scope constructs.Construct, id *string, ...)
- func NewCfnVPNGatewayRoutePropagation_Override(c CfnVPNGatewayRoutePropagation, scope constructs.Construct, id *string, ...)
- func NewCfnVPNGateway_Override(c CfnVPNGateway, scope constructs.Construct, id *string, ...)
- func NewCfnVerifiedAccessEndpoint_Override(c CfnVerifiedAccessEndpoint, scope constructs.Construct, id *string, ...)
- func NewCfnVerifiedAccessGroup_Override(c CfnVerifiedAccessGroup, scope constructs.Construct, id *string, ...)
- func NewCfnVerifiedAccessInstance_Override(c CfnVerifiedAccessInstance, scope constructs.Construct, id *string, ...)
- func NewCfnVerifiedAccessTrustProvider_Override(c CfnVerifiedAccessTrustProvider, scope constructs.Construct, id *string, ...)
- func NewCfnVolumeAttachment_Override(c CfnVolumeAttachment, scope constructs.Construct, id *string, ...)
- func NewCfnVolume_Override(c CfnVolume, scope constructs.Construct, id *string, props *CfnVolumeProps)
- func NewClientVpnAuthorizationRule_Override(c ClientVpnAuthorizationRule, scope constructs.Construct, id *string, ...)
- func NewClientVpnEndpoint_Override(c ClientVpnEndpoint, scope constructs.Construct, id *string, ...)
- func NewClientVpnRouteTarget_Override(c ClientVpnRouteTarget)
- func NewClientVpnRoute_Override(c ClientVpnRoute, scope constructs.Construct, id *string, ...)
- func NewClientVpnUserBasedAuthentication_Override(c ClientVpnUserBasedAuthentication)
- func NewConnections_Override(c Connections, props *ConnectionsProps)
- func NewFlowLogDestination_Override(f FlowLogDestination)
- func NewFlowLogResourceType_Override(f FlowLogResourceType)
- func NewFlowLog_Override(f FlowLog, scope constructs.Construct, id *string, props *FlowLogProps)
- func NewGatewayVpcEndpointAwsService_Override(g GatewayVpcEndpointAwsService, name *string, prefix *string)
- func NewGatewayVpcEndpoint_Override(g GatewayVpcEndpoint, scope constructs.Construct, id *string, ...)
- func NewGenericLinuxImage_Override(g GenericLinuxImage, amiMap *map[string]*string, props *GenericLinuxImageProps)
- func NewGenericSSMParameterImage_Override(g GenericSSMParameterImage, parameterName *string, os OperatingSystemType, ...)
- func NewGenericWindowsImage_Override(g GenericWindowsImage, amiMap *map[string]*string, ...)
- func NewInitCommandWaitDuration_Override(i InitCommandWaitDuration)
- func NewInitConfig_Override(i InitConfig, elements *[]InitElement)
- func NewInitElement_Override(i InitElement)
- func NewInitFile_Override(i InitFile, fileName *string, options *InitFileOptions)
- func NewInitGroup_Override(i InitGroup, groupName *string, groupId *float64)
- func NewInitPackage_Override(i InitPackage, type_ *string, versions *[]*string, packageName *string, ...)
- func NewInitServiceRestartHandle_Override(i InitServiceRestartHandle)
- func NewInitSource_Override(i InitSource, targetDirectory *string, ...)
- func NewInitUser_Override(i InitUser, userName *string, userOptions *InitUserOptions)
- func NewInstanceRequireImdsv2Aspect_Override(i InstanceRequireImdsv2Aspect, props *InstanceRequireImdsv2AspectProps)
- func NewInstanceType_Override(i InstanceType, instanceTypeIdentifier *string)
- func NewInstance_Override(i Instance, scope constructs.Construct, id *string, props *InstanceProps)
- func NewInterfaceVpcEndpointAwsService_Override(i InterfaceVpcEndpointAwsService, name *string, prefix *string, port *float64, ...)
- func NewInterfaceVpcEndpointService_Override(i InterfaceVpcEndpointService, name *string, port *float64)
- func NewInterfaceVpcEndpoint_Override(i InterfaceVpcEndpoint, scope constructs.Construct, id *string, ...)
- func NewKeyPair_Override(k KeyPair, scope constructs.Construct, id *string, props *KeyPairProps)
- func NewLaunchTemplateRequireImdsv2Aspect_Override(l LaunchTemplateRequireImdsv2Aspect, ...)
- func NewLaunchTemplateSpecialVersions_Override(l LaunchTemplateSpecialVersions)
- func NewLaunchTemplate_Override(l LaunchTemplate, scope constructs.Construct, id *string, ...)
- func NewLogFormat_Override(l LogFormat, value *string)
- func NewLookupMachineImage_Override(l LookupMachineImage, props *LookupMachineImageProps)
- func NewMachineImage_Override(m MachineImage)
- func NewMultipartBody_Override(m MultipartBody)
- func NewMultipartUserData_Override(m MultipartUserData, opts *MultipartUserDataOptions)
- func NewNatGatewayProvider_Override(n NatGatewayProvider, props *NatGatewayProps)
- func NewNatInstanceImage_Override(n NatInstanceImage)
- func NewNatInstanceProviderV2_Override(n NatInstanceProviderV2, props *NatInstanceProps)
- func NewNatInstanceProvider_Override(n NatInstanceProvider, props *NatInstanceProps)deprecated
- func NewNatProvider_Override(n NatProvider)
- func NewNetworkAclEntry_Override(n NetworkAclEntry, scope constructs.Construct, id *string, ...)
- func NewNetworkAcl_Override(n NetworkAcl, scope constructs.Construct, id *string, props *NetworkAclProps)
- func NewPeer_Override(p Peer)
- func NewPlacementGroup_Override(p PlacementGroup, scope constructs.Construct, id *string, ...)
- func NewPort_Override(p Port, props *PortProps)
- func NewPrefixList_Override(p PrefixList, scope constructs.Construct, id *string, props *PrefixListProps)
- func NewPrivateSubnet_Override(p PrivateSubnet, scope constructs.Construct, id *string, ...)
- func NewPublicSubnet_Override(p PublicSubnet, scope constructs.Construct, id *string, ...)
- func NewResolveSsmParameterAtLaunchImage_Override(r ResolveSsmParameterAtLaunchImage, parameterName *string, ...)
- func NewSecurityGroup_Override(s SecurityGroup, scope constructs.Construct, id *string, ...)
- func NewSubnetFilter_Override(s SubnetFilter)
- func NewSubnetNetworkAclAssociation_Override(s SubnetNetworkAclAssociation, scope constructs.Construct, id *string, ...)
- func NewSubnet_Override(s Subnet, scope constructs.Construct, id *string, props *SubnetProps)
- func NewUserData_Override(u UserData)
- func NewVolume_Override(v Volume, scope constructs.Construct, id *string, props *VolumeProps)
- func NewVpcEndpointService_Override(v VpcEndpointService, scope constructs.Construct, id *string, ...)
- func NewVpcEndpoint_Override(v VpcEndpoint, scope constructs.Construct, id *string, ...)
- func NewVpc_Override(v Vpc, scope constructs.Construct, id *string, props *VpcProps)
- func NewVpnConnectionBase_Override(v VpnConnectionBase, scope constructs.Construct, id *string, ...)
- func NewVpnConnection_Override(v VpnConnection, scope constructs.Construct, id *string, ...)
- func NewVpnGateway_Override(v VpnGateway, scope constructs.Construct, id *string, props *VpnGatewayProps)
- func NewWindowsImage_Override(w WindowsImage, version WindowsVersion, props *WindowsImageProps)
- func PlacementGroup_IsConstruct(x interface{}) *bool
- func PlacementGroup_IsOwnedResource(construct constructs.IConstruct) *bool
- func PlacementGroup_IsResource(construct constructs.IConstruct) *bool
- func PrefixList_IsConstruct(x interface{}) *bool
- func PrefixList_IsOwnedResource(construct constructs.IConstruct) *bool
- func PrefixList_IsResource(construct constructs.IConstruct) *bool
- func PrivateSubnet_IsConstruct(x interface{}) *bool
- func PrivateSubnet_IsOwnedResource(construct constructs.IConstruct) *bool
- func PrivateSubnet_IsResource(construct constructs.IConstruct) *bool
- func PrivateSubnet_IsVpcSubnet(x interface{}) *bool
- func PublicSubnet_IsConstruct(x interface{}) *bool
- func PublicSubnet_IsOwnedResource(construct constructs.IConstruct) *bool
- func PublicSubnet_IsResource(construct constructs.IConstruct) *bool
- func PublicSubnet_IsVpcSubnet(x interface{}) *bool
- func SecurityGroup_IsConstruct(x interface{}) *bool
- func SecurityGroup_IsOwnedResource(construct constructs.IConstruct) *bool
- func SecurityGroup_IsResource(construct constructs.IConstruct) *bool
- func SecurityGroup_IsSecurityGroup(x interface{}) *bool
- func SubnetNetworkAclAssociation_IsConstruct(x interface{}) *bool
- func SubnetNetworkAclAssociation_IsOwnedResource(construct constructs.IConstruct) *bool
- func SubnetNetworkAclAssociation_IsResource(construct constructs.IConstruct) *bool
- func Subnet_IsConstruct(x interface{}) *bool
- func Subnet_IsOwnedResource(construct constructs.IConstruct) *bool
- func Subnet_IsResource(construct constructs.IConstruct) *bool
- func Subnet_IsVpcSubnet(x interface{}) *bool
- func Volume_IsConstruct(x interface{}) *bool
- func Volume_IsOwnedResource(construct constructs.IConstruct) *bool
- func Volume_IsResource(construct constructs.IConstruct) *bool
- func VpcEndpointService_DEFAULT_PREFIX() *string
- func VpcEndpointService_IsConstruct(x interface{}) *bool
- func VpcEndpointService_IsOwnedResource(construct constructs.IConstruct) *bool
- func VpcEndpointService_IsResource(construct constructs.IConstruct) *bool
- func VpcEndpoint_IsConstruct(x interface{}) *bool
- func VpcEndpoint_IsOwnedResource(construct constructs.IConstruct) *bool
- func VpcEndpoint_IsResource(construct constructs.IConstruct) *bool
- func Vpc_DEFAULT_CIDR_RANGE() *string
- func Vpc_DEFAULT_SUBNETS() *[]*SubnetConfiguration
- func Vpc_DEFAULT_SUBNETS_NO_NAT() *[]*SubnetConfiguration
- func Vpc_IsConstruct(x interface{}) *bool
- func Vpc_IsOwnedResource(construct constructs.IConstruct) *bool
- func Vpc_IsResource(construct constructs.IConstruct) *bool
- func VpnConnectionBase_IsConstruct(x interface{}) *bool
- func VpnConnectionBase_IsOwnedResource(construct constructs.IConstruct) *bool
- func VpnConnectionBase_IsResource(construct constructs.IConstruct) *bool
- func VpnConnection_IsConstruct(x interface{}) *bool
- func VpnConnection_IsOwnedResource(construct constructs.IConstruct) *bool
- func VpnConnection_IsResource(construct constructs.IConstruct) *bool
- func VpnConnection_MetricAll(metricName *string, props *awscloudwatch.MetricOptions) awscloudwatch.Metric
- func VpnConnection_MetricAllTunnelDataIn(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
- func VpnConnection_MetricAllTunnelDataOut(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
- func VpnConnection_MetricAllTunnelState(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
- func VpnGateway_IsConstruct(x interface{}) *bool
- func VpnGateway_IsOwnedResource(construct constructs.IConstruct) *bool
- func VpnGateway_IsResource(construct constructs.IConstruct) *bool
- type AclCidr
- type AclCidrConfig
- type AclIcmp
- type AclPortRange
- type AclTraffic
- func AclTraffic_AllTraffic() AclTraffic
- func AclTraffic_Icmp(props *AclIcmp) AclTraffic
- func AclTraffic_Icmpv6(props *AclIcmp) AclTraffic
- func AclTraffic_TcpPort(port *float64) AclTraffic
- func AclTraffic_TcpPortRange(startPort *float64, endPort *float64) AclTraffic
- func AclTraffic_UdpPort(port *float64) AclTraffic
- func AclTraffic_UdpPortRange(startPort *float64, endPort *float64) AclTraffic
- type AclTrafficConfig
- type Action
- type AddRouteOptions
- type AddressFamily
- type AllocateCidrRequest
- type AllocateIpv6CidrRequest
- type AllocateVpcIpv6CidrRequest
- type AllocatedSubnet
- type AmazonLinux2022ImageSsmParameter
- type AmazonLinux2022ImageSsmParameterProps
- type AmazonLinux2022Kernel
- type AmazonLinux2023ImageSsmParameter
- type AmazonLinux2023ImageSsmParameterProps
- type AmazonLinux2023Kernel
- type AmazonLinux2ImageSsmParameter
- type AmazonLinux2ImageSsmParameterProps
- type AmazonLinux2Kernel
- type AmazonLinuxCpuType
- type AmazonLinuxEdition
- type AmazonLinuxGeneration
- type AmazonLinuxImage
- type AmazonLinuxImageProps
- type AmazonLinuxImageSsmParameterBase
- type AmazonLinuxImageSsmParameterBaseOptions
- type AmazonLinuxImageSsmParameterBaseProps
- type AmazonLinuxImageSsmParameterCommonOptions
- type AmazonLinuxKernel
- type AmazonLinuxStorage
- type AmazonLinuxVirt
- type ApplyCloudFormationInitOptions
- type AttachInitOptions
- type AwsIpamProps
- type BastionHostLinux
- type BastionHostLinuxProps
- type BlockDevice
- type BlockDeviceVolume
- func BlockDeviceVolume_Ebs(volumeSize *float64, options *EbsDeviceOptions) BlockDeviceVolume
- func BlockDeviceVolume_EbsFromSnapshot(snapshotId *string, options *EbsDeviceSnapshotOptions) BlockDeviceVolume
- func BlockDeviceVolume_Ephemeral(volumeIndex *float64) BlockDeviceVolume
- func NewBlockDeviceVolume(ebsDevice *EbsDeviceProps, virtualName *string) BlockDeviceVolume
- type CfnCapacityReservation
- type CfnCapacityReservationFleet
- type CfnCapacityReservationFleetProps
- type CfnCapacityReservationFleet_InstanceTypeSpecificationProperty
- type CfnCapacityReservationFleet_TagSpecificationProperty
- type CfnCapacityReservationProps
- type CfnCapacityReservation_TagSpecificationProperty
- type CfnCarrierGateway
- type CfnCarrierGatewayProps
- type CfnClientVpnAuthorizationRule
- type CfnClientVpnAuthorizationRuleProps
- type CfnClientVpnEndpoint
- type CfnClientVpnEndpointProps
- type CfnClientVpnEndpoint_CertificateAuthenticationRequestProperty
- type CfnClientVpnEndpoint_ClientAuthenticationRequestProperty
- type CfnClientVpnEndpoint_ClientConnectOptionsProperty
- type CfnClientVpnEndpoint_ClientLoginBannerOptionsProperty
- type CfnClientVpnEndpoint_ConnectionLogOptionsProperty
- type CfnClientVpnEndpoint_DirectoryServiceAuthenticationRequestProperty
- type CfnClientVpnEndpoint_FederatedAuthenticationRequestProperty
- type CfnClientVpnEndpoint_TagSpecificationProperty
- type CfnClientVpnRoute
- type CfnClientVpnRouteProps
- type CfnClientVpnTargetNetworkAssociation
- type CfnClientVpnTargetNetworkAssociationProps
- type CfnCustomerGateway
- type CfnCustomerGatewayProps
- type CfnDHCPOptions
- type CfnDHCPOptionsProps
- type CfnEC2Fleet
- type CfnEC2FleetProps
- type CfnEC2Fleet_AcceleratorCountRequestProperty
- type CfnEC2Fleet_AcceleratorTotalMemoryMiBRequestProperty
- type CfnEC2Fleet_BaselineEbsBandwidthMbpsRequestProperty
- type CfnEC2Fleet_CapacityRebalanceProperty
- type CfnEC2Fleet_CapacityReservationOptionsRequestProperty
- type CfnEC2Fleet_FleetLaunchTemplateConfigRequestProperty
- type CfnEC2Fleet_FleetLaunchTemplateOverridesRequestProperty
- type CfnEC2Fleet_FleetLaunchTemplateSpecificationRequestProperty
- type CfnEC2Fleet_InstanceRequirementsRequestProperty
- type CfnEC2Fleet_MaintenanceStrategiesProperty
- type CfnEC2Fleet_MemoryGiBPerVCpuRequestProperty
- type CfnEC2Fleet_MemoryMiBRequestProperty
- type CfnEC2Fleet_NetworkBandwidthGbpsRequestProperty
- type CfnEC2Fleet_NetworkInterfaceCountRequestProperty
- type CfnEC2Fleet_OnDemandOptionsRequestProperty
- type CfnEC2Fleet_PlacementProperty
- type CfnEC2Fleet_SpotOptionsRequestProperty
- type CfnEC2Fleet_TagSpecificationProperty
- type CfnEC2Fleet_TargetCapacitySpecificationRequestProperty
- type CfnEC2Fleet_TotalLocalStorageGBRequestProperty
- type CfnEC2Fleet_VCpuCountRangeRequestProperty
- type CfnEIP
- type CfnEIPAssociation
- type CfnEIPAssociationProps
- type CfnEIPProps
- type CfnEgressOnlyInternetGateway
- type CfnEgressOnlyInternetGatewayProps
- type CfnEnclaveCertificateIamRoleAssociation
- type CfnEnclaveCertificateIamRoleAssociationProps
- type CfnFlowLog
- type CfnFlowLogProps
- type CfnFlowLog_DestinationOptionsProperty
- type CfnGatewayRouteTableAssociation
- type CfnGatewayRouteTableAssociationProps
- type CfnHost
- type CfnHostProps
- type CfnIPAM
- type CfnIPAMAllocation
- type CfnIPAMAllocationProps
- type CfnIPAMPool
- type CfnIPAMPoolCidr
- type CfnIPAMPoolCidrProps
- type CfnIPAMPoolProps
- type CfnIPAMPool_ProvisionedCidrProperty
- type CfnIPAMPool_SourceResourceProperty
- type CfnIPAMProps
- type CfnIPAMResourceDiscovery
- type CfnIPAMResourceDiscoveryAssociation
- type CfnIPAMResourceDiscoveryAssociationProps
- type CfnIPAMResourceDiscoveryProps
- type CfnIPAMResourceDiscovery_IpamOperatingRegionProperty
- type CfnIPAMScope
- type CfnIPAMScopeProps
- type CfnIPAM_IpamOperatingRegionProperty
- type CfnInstance
- type CfnInstanceConnectEndpoint
- type CfnInstanceConnectEndpointProps
- type CfnInstanceProps
- type CfnInstance_AssociationParameterProperty
- type CfnInstance_BlockDeviceMappingProperty
- type CfnInstance_CpuOptionsProperty
- type CfnInstance_CreditSpecificationProperty
- type CfnInstance_EbsProperty
- type CfnInstance_ElasticGpuSpecificationProperty
- type CfnInstance_ElasticInferenceAcceleratorProperty
- type CfnInstance_EnclaveOptionsProperty
- type CfnInstance_HibernationOptionsProperty
- type CfnInstance_InstanceIpv6AddressProperty
- type CfnInstance_LaunchTemplateSpecificationProperty
- type CfnInstance_LicenseSpecificationProperty
- type CfnInstance_NetworkInterfaceProperty
- type CfnInstance_NoDeviceProperty
- type CfnInstance_PrivateDnsNameOptionsProperty
- type CfnInstance_PrivateIpAddressSpecificationProperty
- type CfnInstance_SsmAssociationProperty
- type CfnInstance_StateProperty
- type CfnInstance_VolumeProperty
- type CfnInternetGateway
- type CfnInternetGatewayProps
- type CfnKeyPair
- type CfnKeyPairProps
- type CfnLaunchTemplate
- type CfnLaunchTemplateProps
- type CfnLaunchTemplate_AcceleratorCountProperty
- type CfnLaunchTemplate_AcceleratorTotalMemoryMiBProperty
- type CfnLaunchTemplate_BaselineEbsBandwidthMbpsProperty
- type CfnLaunchTemplate_BlockDeviceMappingProperty
- type CfnLaunchTemplate_CapacityReservationSpecificationProperty
- type CfnLaunchTemplate_CapacityReservationTargetProperty
- type CfnLaunchTemplate_ConnectionTrackingSpecificationProperty
- type CfnLaunchTemplate_CpuOptionsProperty
- type CfnLaunchTemplate_CreditSpecificationProperty
- type CfnLaunchTemplate_EbsProperty
- type CfnLaunchTemplate_ElasticGpuSpecificationProperty
- type CfnLaunchTemplate_EnaSrdSpecificationProperty
- type CfnLaunchTemplate_EnaSrdUdpSpecificationProperty
- type CfnLaunchTemplate_EnclaveOptionsProperty
- type CfnLaunchTemplate_HibernationOptionsProperty
- type CfnLaunchTemplate_IamInstanceProfileProperty
- type CfnLaunchTemplate_InstanceMarketOptionsProperty
- type CfnLaunchTemplate_InstanceRequirementsProperty
- type CfnLaunchTemplate_Ipv4PrefixSpecificationProperty
- type CfnLaunchTemplate_Ipv6AddProperty
- type CfnLaunchTemplate_Ipv6PrefixSpecificationProperty
- type CfnLaunchTemplate_LaunchTemplateDataProperty
- type CfnLaunchTemplate_LaunchTemplateElasticInferenceAcceleratorProperty
- type CfnLaunchTemplate_LaunchTemplateTagSpecificationProperty
- type CfnLaunchTemplate_LicenseSpecificationProperty
- type CfnLaunchTemplate_MaintenanceOptionsProperty
- type CfnLaunchTemplate_MemoryGiBPerVCpuProperty
- type CfnLaunchTemplate_MemoryMiBProperty
- type CfnLaunchTemplate_MetadataOptionsProperty
- type CfnLaunchTemplate_MonitoringProperty
- type CfnLaunchTemplate_NetworkBandwidthGbpsProperty
- type CfnLaunchTemplate_NetworkInterfaceCountProperty
- type CfnLaunchTemplate_NetworkInterfaceProperty
- type CfnLaunchTemplate_PlacementProperty
- type CfnLaunchTemplate_PrivateDnsNameOptionsProperty
- type CfnLaunchTemplate_PrivateIpAddProperty
- type CfnLaunchTemplate_SpotOptionsProperty
- type CfnLaunchTemplate_TagSpecificationProperty
- type CfnLaunchTemplate_TotalLocalStorageGBProperty
- type CfnLaunchTemplate_VCpuCountProperty
- type CfnLocalGatewayRoute
- type CfnLocalGatewayRouteProps
- type CfnLocalGatewayRouteTable
- type CfnLocalGatewayRouteTableProps
- type CfnLocalGatewayRouteTableVPCAssociation
- type CfnLocalGatewayRouteTableVPCAssociationProps
- type CfnLocalGatewayRouteTableVirtualInterfaceGroupAssociation
- type CfnLocalGatewayRouteTableVirtualInterfaceGroupAssociationProps
- type CfnNatGateway
- type CfnNatGatewayProps
- type CfnNetworkAcl
- type CfnNetworkAclEntry
- type CfnNetworkAclEntryProps
- type CfnNetworkAclEntry_IcmpProperty
- type CfnNetworkAclEntry_PortRangeProperty
- type CfnNetworkAclProps
- type CfnNetworkInsightsAccessScope
- type CfnNetworkInsightsAccessScopeAnalysis
- type CfnNetworkInsightsAccessScopeAnalysisProps
- type CfnNetworkInsightsAccessScopeProps
- type CfnNetworkInsightsAccessScope_AccessScopePathRequestProperty
- type CfnNetworkInsightsAccessScope_PacketHeaderStatementRequestProperty
- type CfnNetworkInsightsAccessScope_PathStatementRequestProperty
- type CfnNetworkInsightsAccessScope_ResourceStatementRequestProperty
- type CfnNetworkInsightsAccessScope_ThroughResourcesStatementRequestProperty
- type CfnNetworkInsightsAnalysis
- type CfnNetworkInsightsAnalysisProps
- type CfnNetworkInsightsAnalysis_AdditionalDetailProperty
- type CfnNetworkInsightsAnalysis_AlternatePathHintProperty
- type CfnNetworkInsightsAnalysis_AnalysisAclRuleProperty
- type CfnNetworkInsightsAnalysis_AnalysisComponentProperty
- type CfnNetworkInsightsAnalysis_AnalysisLoadBalancerListenerProperty
- type CfnNetworkInsightsAnalysis_AnalysisLoadBalancerTargetProperty
- type CfnNetworkInsightsAnalysis_AnalysisPacketHeaderProperty
- type CfnNetworkInsightsAnalysis_AnalysisRouteTableRouteProperty
- type CfnNetworkInsightsAnalysis_AnalysisSecurityGroupRuleProperty
- type CfnNetworkInsightsAnalysis_ExplanationProperty
- type CfnNetworkInsightsAnalysis_PathComponentProperty
- type CfnNetworkInsightsAnalysis_PortRangeProperty
- type CfnNetworkInsightsAnalysis_TransitGatewayRouteTableRouteProperty
- type CfnNetworkInsightsPath
- type CfnNetworkInsightsPathProps
- type CfnNetworkInsightsPath_FilterPortRangeProperty
- type CfnNetworkInsightsPath_PathFilterProperty
- type CfnNetworkInterface
- type CfnNetworkInterfaceAttachment
- type CfnNetworkInterfaceAttachmentProps
- type CfnNetworkInterfaceAttachment_EnaSrdSpecificationProperty
- type CfnNetworkInterfaceAttachment_EnaSrdUdpSpecificationProperty
- type CfnNetworkInterfacePermission
- type CfnNetworkInterfacePermissionProps
- type CfnNetworkInterfaceProps
- type CfnNetworkInterface_ConnectionTrackingSpecificationProperty
- type CfnNetworkInterface_InstanceIpv6AddressProperty
- type CfnNetworkInterface_Ipv4PrefixSpecificationProperty
- type CfnNetworkInterface_Ipv6PrefixSpecificationProperty
- type CfnNetworkInterface_PrivateIpAddressSpecificationProperty
- type CfnNetworkPerformanceMetricSubscription
- type CfnNetworkPerformanceMetricSubscriptionProps
- type CfnPlacementGroup
- type CfnPlacementGroupProps
- type CfnPrefixList
- type CfnPrefixListProps
- type CfnPrefixList_EntryProperty
- type CfnRoute
- type CfnRouteProps
- type CfnRouteTable
- type CfnRouteTableProps
- type CfnSecurityGroup
- type CfnSecurityGroupEgress
- type CfnSecurityGroupEgressProps
- type CfnSecurityGroupIngress
- type CfnSecurityGroupIngressProps
- type CfnSecurityGroupProps
- type CfnSecurityGroup_EgressProperty
- type CfnSecurityGroup_IngressProperty
- type CfnSnapshotBlockPublicAccess
- type CfnSnapshotBlockPublicAccessProps
- type CfnSpotFleet
- type CfnSpotFleetProps
- type CfnSpotFleet_AcceleratorCountRequestProperty
- type CfnSpotFleet_AcceleratorTotalMemoryMiBRequestProperty
- type CfnSpotFleet_BaselineEbsBandwidthMbpsRequestProperty
- type CfnSpotFleet_BlockDeviceMappingProperty
- type CfnSpotFleet_ClassicLoadBalancerProperty
- type CfnSpotFleet_ClassicLoadBalancersConfigProperty
- type CfnSpotFleet_EbsBlockDeviceProperty
- type CfnSpotFleet_FleetLaunchTemplateSpecificationProperty
- type CfnSpotFleet_GroupIdentifierProperty
- type CfnSpotFleet_IamInstanceProfileSpecificationProperty
- type CfnSpotFleet_InstanceIpv6AddressProperty
- type CfnSpotFleet_InstanceNetworkInterfaceSpecificationProperty
- type CfnSpotFleet_InstanceRequirementsRequestProperty
- type CfnSpotFleet_LaunchTemplateConfigProperty
- type CfnSpotFleet_LaunchTemplateOverridesProperty
- type CfnSpotFleet_LoadBalancersConfigProperty
- type CfnSpotFleet_MemoryGiBPerVCpuRequestProperty
- type CfnSpotFleet_MemoryMiBRequestProperty
- type CfnSpotFleet_NetworkBandwidthGbpsRequestProperty
- type CfnSpotFleet_NetworkInterfaceCountRequestProperty
- type CfnSpotFleet_PrivateIpAddressSpecificationProperty
- type CfnSpotFleet_SpotCapacityRebalanceProperty
- type CfnSpotFleet_SpotFleetLaunchSpecificationProperty
- type CfnSpotFleet_SpotFleetMonitoringProperty
- type CfnSpotFleet_SpotFleetRequestConfigDataProperty
- type CfnSpotFleet_SpotFleetTagSpecificationProperty
- type CfnSpotFleet_SpotMaintenanceStrategiesProperty
- type CfnSpotFleet_SpotPlacementProperty
- type CfnSpotFleet_TargetGroupProperty
- type CfnSpotFleet_TargetGroupsConfigProperty
- type CfnSpotFleet_TotalLocalStorageGBRequestProperty
- type CfnSpotFleet_VCpuCountRangeRequestProperty
- type CfnSubnet
- type CfnSubnetCidrBlock
- type CfnSubnetCidrBlockProps
- type CfnSubnetNetworkAclAssociation
- type CfnSubnetNetworkAclAssociationProps
- type CfnSubnetProps
- type CfnSubnetRouteTableAssociation
- type CfnSubnetRouteTableAssociationProps
- type CfnSubnet_PrivateDnsNameOptionsOnLaunchProperty
- type CfnTrafficMirrorFilter
- type CfnTrafficMirrorFilterProps
- type CfnTrafficMirrorFilterRule
- type CfnTrafficMirrorFilterRuleProps
- type CfnTrafficMirrorFilterRule_TrafficMirrorPortRangeProperty
- type CfnTrafficMirrorSession
- type CfnTrafficMirrorSessionProps
- type CfnTrafficMirrorTarget
- type CfnTrafficMirrorTargetProps
- type CfnTransitGateway
- type CfnTransitGatewayAttachment
- type CfnTransitGatewayAttachmentProps
- type CfnTransitGatewayAttachment_OptionsProperty
- type CfnTransitGatewayConnect
- type CfnTransitGatewayConnectProps
- type CfnTransitGatewayConnect_TransitGatewayConnectOptionsProperty
- type CfnTransitGatewayMulticastDomain
- type CfnTransitGatewayMulticastDomainAssociation
- type CfnTransitGatewayMulticastDomainAssociationProps
- type CfnTransitGatewayMulticastDomainProps
- type CfnTransitGatewayMulticastDomain_OptionsProperty
- type CfnTransitGatewayMulticastGroupMember
- type CfnTransitGatewayMulticastGroupMemberProps
- type CfnTransitGatewayMulticastGroupSource
- type CfnTransitGatewayMulticastGroupSourceProps
- type CfnTransitGatewayPeeringAttachment
- type CfnTransitGatewayPeeringAttachmentProps
- type CfnTransitGatewayPeeringAttachment_PeeringAttachmentStatusProperty
- type CfnTransitGatewayProps
- type CfnTransitGatewayRoute
- type CfnTransitGatewayRouteProps
- type CfnTransitGatewayRouteTable
- type CfnTransitGatewayRouteTableAssociation
- type CfnTransitGatewayRouteTableAssociationProps
- type CfnTransitGatewayRouteTablePropagation
- type CfnTransitGatewayRouteTablePropagationProps
- type CfnTransitGatewayRouteTableProps
- type CfnTransitGatewayVpcAttachment
- type CfnTransitGatewayVpcAttachmentProps
- type CfnTransitGatewayVpcAttachment_OptionsProperty
- type CfnVPC
- type CfnVPCCidrBlock
- type CfnVPCCidrBlockProps
- type CfnVPCDHCPOptionsAssociation
- type CfnVPCDHCPOptionsAssociationProps
- type CfnVPCEndpoint
- type CfnVPCEndpointConnectionNotification
- type CfnVPCEndpointConnectionNotificationProps
- type CfnVPCEndpointProps
- type CfnVPCEndpointService
- type CfnVPCEndpointServicePermissions
- type CfnVPCEndpointServicePermissionsProps
- type CfnVPCEndpointServiceProps
- type CfnVPCGatewayAttachment
- type CfnVPCGatewayAttachmentProps
- type CfnVPCPeeringConnection
- type CfnVPCPeeringConnectionProps
- type CfnVPCProps
- type CfnVPNConnection
- type CfnVPNConnectionProps
- type CfnVPNConnectionRoute
- type CfnVPNConnectionRouteProps
- type CfnVPNConnection_VpnTunnelOptionsSpecificationProperty
- type CfnVPNGateway
- type CfnVPNGatewayProps
- type CfnVPNGatewayRoutePropagation
- type CfnVPNGatewayRoutePropagationProps
- type CfnVerifiedAccessEndpoint
- type CfnVerifiedAccessEndpointProps
- type CfnVerifiedAccessEndpoint_LoadBalancerOptionsProperty
- type CfnVerifiedAccessEndpoint_NetworkInterfaceOptionsProperty
- type CfnVerifiedAccessEndpoint_SseSpecificationProperty
- type CfnVerifiedAccessGroup
- type CfnVerifiedAccessGroupProps
- type CfnVerifiedAccessGroup_SseSpecificationProperty
- type CfnVerifiedAccessInstance
- type CfnVerifiedAccessInstanceProps
- type CfnVerifiedAccessInstance_CloudWatchLogsProperty
- type CfnVerifiedAccessInstance_KinesisDataFirehoseProperty
- type CfnVerifiedAccessInstance_S3Property
- type CfnVerifiedAccessInstance_VerifiedAccessLogsProperty
- type CfnVerifiedAccessInstance_VerifiedAccessTrustProviderProperty
- type CfnVerifiedAccessTrustProvider
- type CfnVerifiedAccessTrustProviderProps
- type CfnVerifiedAccessTrustProvider_DeviceOptionsProperty
- type CfnVerifiedAccessTrustProvider_OidcOptionsProperty
- type CfnVerifiedAccessTrustProvider_SseSpecificationProperty
- type CfnVolume
- type CfnVolumeAttachment
- type CfnVolumeAttachmentProps
- type CfnVolumeProps
- type ClientVpnAuthorizationRule
- type ClientVpnAuthorizationRuleOptions
- type ClientVpnAuthorizationRuleProps
- type ClientVpnEndpoint
- type ClientVpnEndpointAttributes
- type ClientVpnEndpointOptions
- type ClientVpnEndpointProps
- type ClientVpnRoute
- type ClientVpnRouteOptions
- type ClientVpnRouteProps
- type ClientVpnRouteTarget
- type ClientVpnSessionTimeout
- type ClientVpnUserBasedAuthentication
- type CloudFormationInit
- type CommonNetworkAclEntryOptions
- type ConfigSetProps
- type ConfigureNatOptions
- type ConnectionRule
- type Connections
- type ConnectionsProps
- type CpuCredits
- type CreateIpv6CidrBlocksRequest
- type DefaultInstanceTenancy
- type DestinationOptions
- type EbsDeviceOptions
- type EbsDeviceOptionsBase
- type EbsDeviceProps
- type EbsDeviceSnapshotOptions
- type EbsDeviceVolumeType
- type EnableVpnGatewayOptions
- type ExecuteFileOptions
- type FlowLog
- type FlowLogDestination
- func FlowLogDestination_ToCloudWatchLogs(logGroup awslogs.ILogGroup, iamRole awsiam.IRole) FlowLogDestination
- func FlowLogDestination_ToKinesisDataFirehoseDestination(deliveryStreamArn *string) FlowLogDestination
- func FlowLogDestination_ToS3(bucket awss3.IBucket, keyPrefix *string, options *S3DestinationOptions) FlowLogDestination
- type FlowLogDestinationConfig
- type FlowLogDestinationType
- type FlowLogFileFormat
- type FlowLogMaxAggregationInterval
- type FlowLogOptions
- type FlowLogProps
- type FlowLogResourceType
- func FlowLogResourceType_FromNetworkInterfaceId(id *string) FlowLogResourceType
- func FlowLogResourceType_FromSubnet(subnet ISubnet) FlowLogResourceType
- func FlowLogResourceType_FromTransitGatewayAttachmentId(id *string) FlowLogResourceType
- func FlowLogResourceType_FromTransitGatewayId(id *string) FlowLogResourceType
- func FlowLogResourceType_FromVpc(vpc IVpc) FlowLogResourceType
- type FlowLogTrafficType
- type GatewayConfig
- type GatewayVpcEndpoint
- type GatewayVpcEndpointAwsService
- func GatewayVpcEndpointAwsService_DYNAMODB() GatewayVpcEndpointAwsService
- func GatewayVpcEndpointAwsService_S3() GatewayVpcEndpointAwsService
- func GatewayVpcEndpointAwsService_S3_EXPRESS() GatewayVpcEndpointAwsService
- func NewGatewayVpcEndpointAwsService(name *string, prefix *string) GatewayVpcEndpointAwsService
- type GatewayVpcEndpointOptions
- type GatewayVpcEndpointProps
- type GenericLinuxImage
- type GenericLinuxImageProps
- type GenericSSMParameterImage
- type GenericWindowsImage
- type GenericWindowsImageProps
- type IClientVpnConnectionHandler
- type IClientVpnEndpoint
- type IConnectable
- type IFlowLog
- type IGatewayVpcEndpoint
- type IGatewayVpcEndpointService
- type IInstance
- type IInterfaceVpcEndpoint
- type IInterfaceVpcEndpointService
- type IIpAddresses
- type IIpv6Addresses
- type IKeyPair
- type ILaunchTemplate
- type IMachineImage
- func MachineImage_FromSsmParameter(parameterName *string, options *SsmParameterImageOptions) IMachineImage
- func MachineImage_GenericLinux(amiMap *map[string]*string, props *GenericLinuxImageProps) IMachineImage
- func MachineImage_GenericWindows(amiMap *map[string]*string, props *GenericWindowsImageProps) IMachineImage
- func MachineImage_LatestAmazonLinux(props *AmazonLinuxImageProps) IMachineImage
- func MachineImage_LatestAmazonLinux2(props *AmazonLinux2ImageSsmParameterProps) IMachineImage
- func MachineImage_LatestAmazonLinux2022(props *AmazonLinux2022ImageSsmParameterProps) IMachineImage
- func MachineImage_LatestAmazonLinux2023(props *AmazonLinux2023ImageSsmParameterProps) IMachineImage
- func MachineImage_LatestWindows(version WindowsVersion, props *WindowsImageProps) IMachineImage
- func MachineImage_Lookup(props *LookupMachineImageProps) IMachineImage
- func MachineImage_ResolveSsmParameterAtLaunch(parameterName *string, options *SsmParameterImageOptions) IMachineImage
- type INetworkAcl
- type INetworkAclEntry
- type IPeer
- type IPlacementGroup
- type IPrefixList
- type IPrivateSubnet
- type IPublicSubnet
- type IRouteTable
- type ISecurityGroup
- func SecurityGroup_FromLookupById(scope constructs.Construct, id *string, securityGroupId *string) ISecurityGroup
- func SecurityGroup_FromLookupByName(scope constructs.Construct, id *string, securityGroupName *string, vpc IVpc) ISecurityGroup
- func SecurityGroup_FromSecurityGroupId(scope constructs.Construct, id *string, securityGroupId *string, ...) ISecurityGroup
- type ISubnet
- func PrivateSubnet_FromSubnetAttributes(scope constructs.Construct, id *string, attrs *SubnetAttributes) ISubnet
- func PrivateSubnet_FromSubnetId(scope constructs.Construct, id *string, subnetId *string) ISubnet
- func PublicSubnet_FromSubnetAttributes(scope constructs.Construct, id *string, attrs *SubnetAttributes) ISubnet
- func PublicSubnet_FromSubnetId(scope constructs.Construct, id *string, subnetId *string) ISubnet
- func Subnet_FromSubnetAttributes(scope constructs.Construct, id *string, attrs *SubnetAttributes) ISubnet
- func Subnet_FromSubnetId(scope constructs.Construct, id *string, subnetId *string) ISubnet
- type ISubnetNetworkAclAssociation
- type IVolume
- type IVpc
- type IVpcEndpoint
- type IVpcEndpointService
- type IVpcEndpointServiceLoadBalancer
- type IVpnConnection
- type IVpnGateway
- type InitCommand
- type InitCommandOptions
- type InitCommandWaitDuration
- type InitConfig
- type InitElement
- type InitFile
- func InitFile_FromAsset(targetFileName *string, path *string, options *InitFileAssetOptions) InitFile
- func InitFile_FromExistingAsset(targetFileName *string, asset awss3assets.Asset, options *InitFileOptions) InitFile
- func InitFile_FromFileInline(targetFileName *string, sourceFileName *string, options *InitFileOptions) InitFile
- func InitFile_FromObject(fileName *string, obj *map[string]interface{}, options *InitFileOptions) InitFile
- func InitFile_FromS3Object(fileName *string, bucket awss3.IBucket, key *string, options *InitFileOptions) InitFile
- func InitFile_FromString(fileName *string, content *string, options *InitFileOptions) InitFile
- func InitFile_FromUrl(fileName *string, url *string, options *InitFileOptions) InitFile
- func InitFile_Symlink(fileName *string, target *string, options *InitFileOptions) InitFile
- func InitService_SystemdConfigFile(serviceName *string, options *SystemdConfigFileOptions) InitFile
- type InitFileAssetOptions
- type InitFileOptions
- type InitGroup
- type InitPackage
- func InitPackage_Apt(packageName *string, options *NamedPackageOptions) InitPackage
- func InitPackage_Msi(location *string, options *LocationPackageOptions) InitPackage
- func InitPackage_Python(packageName *string, options *NamedPackageOptions) InitPackage
- func InitPackage_Rpm(location *string, options *LocationPackageOptions) InitPackage
- func InitPackage_RubyGem(gemName *string, options *NamedPackageOptions) InitPackage
- func InitPackage_Yum(packageName *string, options *NamedPackageOptions) InitPackage
- func NewInitPackage(type_ *string, versions *[]*string, packageName *string, ...) InitPackage
- type InitService
- type InitServiceOptions
- type InitServiceRestartHandle
- type InitSource
- func InitSource_FromAsset(targetDirectory *string, path *string, options *InitSourceAssetOptions) InitSource
- func InitSource_FromExistingAsset(targetDirectory *string, asset awss3assets.Asset, options *InitSourceOptions) InitSource
- func InitSource_FromGitHub(targetDirectory *string, owner *string, repo *string, refSpec *string, ...) InitSource
- func InitSource_FromS3Object(targetDirectory *string, bucket awss3.IBucket, key *string, ...) InitSource
- func InitSource_FromUrl(targetDirectory *string, url *string, options *InitSourceOptions) InitSource
- type InitSourceAssetOptions
- type InitSourceOptions
- type InitUser
- type InitUserOptions
- type Instance
- type InstanceArchitecture
- type InstanceClass
- type InstanceInitiatedShutdownBehavior
- type InstanceProps
- type InstanceRequireImdsv2Aspect
- type InstanceRequireImdsv2AspectProps
- type InstanceSize
- type InstanceType
- type InterfaceVpcEndpoint
- type InterfaceVpcEndpointAttributes
- type InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_ACCESS_ANALYZER() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_ACCOUNT_MANAGEMENT() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_AIRFLOW_API() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_AIRFLOW_API_FIPS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_AIRFLOW_ENV() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_AIRFLOW_ENV_FIPS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_AIRFLOW_OPS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_APIGATEWAY() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_APPCONFIG() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_APPCONFIGDATA() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_APPLICATION_AUTOSCALING() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_APPLICATION_MIGRATION_SERVICE() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_APPSTREAM_API() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_APPSTREAM_STREAMING() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_APP_MESH() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_APP_MESH_ENVOY_MANAGEMENT() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_APP_MESH_OPS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_APP_RUNNER() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_APP_RUNNER_REQUESTS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_APP_SYNC() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_ATHENA() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_AUDIT_MANAGER() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_AUTOSCALING() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_AUTOSCALING_PLANS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_B2B_DATA_INTERCHANGE() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_BACKUP() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_BACKUP_GATEWAY() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_BATCH() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_BEDROCK() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_BEDROCK_AGENT() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_BEDROCK_AGENT_RUNTIME() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_BEDROCK_RUNTIME() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_BILLING_AND_COST_MANAGEMENT_FREETIER() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_BILLING_AND_COST_MANAGEMENT_TAX() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_BILLING_CONDUCTOR() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_BRAKET() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_CLEAN_ROOMS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_CLEAN_ROOMS_ML() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_CLOUDFORMATION() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_CLOUDHSM() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_CLOUDTRAIL() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_CLOUDWATCH() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_CLOUDWATCH_APPLICATION_INSIGHTS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_CLOUDWATCH_APPLICATION_SIGNALS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_CLOUDWATCH_EVENTS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_CLOUDWATCH_EVIDENTLY() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_CLOUDWATCH_EVIDENTLY_DATAPLANE() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_CLOUDWATCH_LOGS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_CLOUDWATCH_MONITORING() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_CLOUDWATCH_NETWORK_MONITOR() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_CLOUDWATCH_RUM() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_CLOUDWATCH_RUM_DATAPLANE() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_CLOUDWATCH_SYNTHETICS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_CLOUD_CONTROL_API() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_CLOUD_CONTROL_API_FIPS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_CLOUD_DIRECTORY() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_CLOUD_MAP_DATA_SERVICE_DISCOVERY() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_CLOUD_MAP_DATA_SERVICE_DISCOVERY_FIPS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_CLOUD_MAP_SERVICE_DISCOVERY() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_CLOUD_MAP_SERVICE_DISCOVERY_FIPS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_CODEARTIFACT_API() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_CODEARTIFACT_REPOSITORIES() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_CODEBUILD() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_CODEBUILD_FIPS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_CODECATALYST() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_CODECATALYST_GIT() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_CODECATALYST_PACKAGES() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_CODECOMMIT() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_CODECOMMIT_FIPS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_CODECOMMIT_GIT() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_CODECOMMIT_GIT_FIPS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_CODEDEPLOY() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_CODEDEPLOY_COMMANDS_SECURE() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_CODEGURU_PROFILER() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_CODEGURU_REVIEWER() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_CODEPIPELINE() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_CODESTAR_CONNECTIONS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_CODEWHISPERER() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_CODE_CONNECTIONS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_COMPREHEND() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_COMPREHEND_MEDICAL() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_CONFIG() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_CONNECT_APP_INTEGRATIONS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_CONNECT_CASES() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_CONNECT_CONNECT_CAMPAIGNS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_CONNECT_PROFILE() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_CONNECT_VOICEID() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_CONNECT_WISDOM() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_CONTROL_CATALOG() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_COST_EXPLORER() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_DATABASE_MIGRATION_SERVICE() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_DATABASE_MIGRATION_SERVICE_FIPS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_DATASYNC() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_DATAZONE() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_DATA_EXCHANGE() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_DATA_EXPORTS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_DEADLINE_CLOUD_MANAGEMENT() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_DEADLINE_CLOUD_SCHEDULING() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_DEVOPS_GURU() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_DIRECTORY_SERVICE() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_EBS_DIRECT() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_EC2() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_EC2_MESSAGES() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_ECR() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_ECR_DOCKER() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_ECS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_ECS_AGENT() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_ECS_TELEMETRY() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_EKS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_EKS_AUTH() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_ELASTICACHE() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_ELASTICACHE_FIPS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_ELASTIC_BEANSTALK() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_ELASTIC_BEANSTALK_HEALTH() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_ELASTIC_DISASTER_RECOVERY() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_ELASTIC_FILESYSTEM() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_ELASTIC_FILESYSTEM_FIPS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_ELASTIC_INFERENCE_RUNTIME() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_ELASTIC_LOAD_BALANCING() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_ELEMENTAL_MEDIACONNECT() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_EMAIL_SMTP() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_EMR() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_EMR_EKS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_EMR_SERVERLESS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_EMR_SERVERLESS_LIVY() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_EMR_WAL() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_ENTITY_RESOLUTION() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_EVENTBRIDGE() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_EVENTBRIDGE_SCHEMA_REGISTRY() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_FAULT_INJECTION_SIMULATOR() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_FINSPACE() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_FINSPACE_API() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_FORECAST() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_FORECAST_FIPS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_FORECAST_QUERY() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_FORECAST_QUERY_FIPS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_FRAUD_DETECTOR() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_FSX() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_FSX_FIPS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_GLUE() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_GLUE_DATABREW() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_GRAFANA() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_GRAFANA_WORKSPACE() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_GROUNDSTATION() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_GUARDDUTY_DATA() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_GUARDDUTY_DATA_FIPS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_HEALTHLAKE() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_HEALTH_IMAGING() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_HEALTH_IMAGING_DICOM() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_HEALTH_IMAGING_RUNTIME() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_IAM() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_IAM_IDENTITY_CENTER() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_IAM_ROLES_ANYWHERE() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_IMAGE_BUILDER() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_INSPECTOR() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_INSPECTOR_SCAN() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_IOT_CORE() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_IOT_CORE_CREDENTIALS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_IOT_CORE_DEVICE_ADVISOR() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_IOT_CORE_FLEETHUB_API() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_IOT_CORE_FOR_LORAWAN() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_IOT_FLEETWISE() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_IOT_GREENGRASS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_IOT_LORAWAN_CUPS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_IOT_LORAWAN_LNS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_IOT_ROBORUNNER() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_IOT_SITEWISE_API() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_IOT_SITEWISE_DATA() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_IOT_TWINMAKER_API() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_IOT_TWINMAKER_DATA() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_KENDRA() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_KENDRA_RANKING() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_KEYSPACES() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_KEYSPACES_FIPS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_KINESIS_FIREHOSE() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_KINESIS_STREAMS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_KINESIS_STREAMS_FIPS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_KMS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_KMS_FIPS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_LAKE_FORMATION() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_LAMBDA() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_LAUNCH_WIZARD() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_LEX_MODELS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_LEX_RUNTIME() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_LICENSE_MANAGER() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_LICENSE_MANAGER_FIPS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_LICENSE_MANAGER_LINUX_SUBSCRIPTIONS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_LICENSE_MANAGER_LINUX_SUBSCRIPTIONS_FIPS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_LICENSE_MANAGER_USER_SUBSCRIPTIONS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_LOOKOUT_EQUIPMENT() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_LOOKOUT_METRICS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_LOOKOUT_VISION() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_MACIE() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_MAINFRAME_MODERNIZATION() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_MAINFRAME_MODERNIZATION_APP_TEST() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_MANAGED_BLOCKCHAIN_BITCOIN_MAINNET() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_MANAGED_BLOCKCHAIN_BITCOIN_TESTNET() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_MANAGED_BLOCKCHAIN_QUERY() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_MANAGEMENT_CONSOLE() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_MANAGEMENT_CONSOLE_SIGNIN() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_MEMORY_DB() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_MEMORY_DB_FIPS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_MIGRATIONHUB_ORCHESTRATOR() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_MIGRATIONHUB_REFACTOR_SPACES() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_MIGRATIONHUB_STRATEGY() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_NEPTUNE_ANALYTICS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_NETWORK_FIREWALL() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_NETWORK_FIREWALL_FIPS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_NIMBLE_STUDIO() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_OMICS_ANALYTICS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_OMICS_CONTROL_STORAGE() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_OMICS_STORAGE() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_OMICS_TAGS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_OMICS_WORKFLOWS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_ORGANIZATIONS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_ORGANIZATIONS_FIPS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_OUTPOSTS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_PANORAMA() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_PARALLEL_COMPUTING_SERVICE() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_PARALLEL_COMPUTING_SERVICE_FIPS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_PAYMENT_CRYPTOGRAPHY_CONTROLPLANE() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_PAYMENT_CRYTOGRAPHY_DATAPLANE() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_PERSONALIZE() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_PERSONALIZE_EVENTS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_PERSONALIZE_RUNTIME() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_PINPOINT() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_PINPOINT_SMS_VOICE_V2() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_PINPOINT_V1() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_PIPES() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_PIPES_DATA() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_PIPES_FIPS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_POLLY() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_PRIVATE_5G() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_PRIVATE_CERTIFICATE_AUTHORITY() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_PRIVATE_CERTIFICATE_AUTHORITY_CONNECTOR_AD() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_PRIVATE_CERTIFICATE_AUTHORITY_CONNECTOR_SCEP() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_PROMETHEUS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_PROMETHEUS_WORKSPACES() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_PROTON() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_QLDB() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_QUICKSIGHT_WEBSITE() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_Q_BUSSINESS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_Q_DEVELOPER() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_Q_DEVELOPER_CODE_WHISPERER() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_Q_DEVELOPER_QAPPS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_Q_USER_SUBSCRIPTIONS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_RDS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_RDS_DATA() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_RDS_PERFORMANCE_INSIGHTS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_RDS_PERFORMANCE_INSIGHTS_FIPS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_RECYCLE_BIN() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_REDSHIFT() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_REDSHIFT_DATA() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_REDSHIFT_DATA_FIPS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_REDSHIFT_FIPS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_REDSHIFT_SERVERLESS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_REDSHIFT_SERVERLESS_FIPS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_REKOGNITION() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_REKOGNITION_FIPS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_REKOGNITION_STREAMING() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_REKOGNITION_STREAMING_FIPS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_REPOST_SPACE() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_RESOURCE_ACCESS_MANAGER() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_ROBOMAKER() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_S3() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_S3_MULTI_REGION_ACCESS_POINTS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_S3_OUTPOSTS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_SAGEMAKER_API() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_SAGEMAKER_FEATURESTORE_RUNTIME() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_SAGEMAKER_GEOSPATIAL() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_SAGEMAKER_METRICS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_SAGEMAKER_NOTEBOOK() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_SAGEMAKER_RUNTIME() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_SAGEMAKER_RUNTIME_FIPS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_SAGEMAKER_STUDIO() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_SECRETS_MANAGER() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_SECURITYHUB() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_SERVER_MIGRATION_SERVICE() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_SERVER_MIGRATION_SERVICE_AWSCONNECTOR() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_SERVER_MIGRATION_SERVICE_FIPS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_SERVICE_CATALOG() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_SERVICE_CATALOG_APPREGISTRY() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_SES() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_SIMSPACE_WEAVER() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_SNOW_DEVICE_MANAGEMENT() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_SNS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_SQS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_SSM() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_SSM_CONTACTS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_SSM_FIPS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_SSM_INCIDENTS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_SSM_MESSAGES() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_SSM_QUICK_SETUP() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_STEP_FUNCTIONS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_STEP_FUNCTIONS_SYNC() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_STORAGE_GATEWAY() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_STS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_SUPPLY_CHAIN() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_SWF() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_SWF_FIPS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_TELCO_NETWORK_BUILDER() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_TEXTRACT() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_TEXTRACT_FIPS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_TIMESTREAM_INFLUXDB() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_TIMESTREAM_INFLUXDB_FIPS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_TRANSCRIBE() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_TRANSCRIBE_STREAMING() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_TRANSFER() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_TRANSFER_SERVER() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_TRANSLATE() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_TRUSTED_ADVISOR() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_VERIFIED_PERMISSIONS() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_VPC_LATTICE() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_WELL_ARCHITECTED_TOOL() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_WORKSPACES() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_WORKSPACES_THIN_CLIENT() InterfaceVpcEndpointAwsService
- func InterfaceVpcEndpointAwsService_XRAY() InterfaceVpcEndpointAwsService
- func NewInterfaceVpcEndpointAwsService(name *string, prefix *string, port *float64, ...) InterfaceVpcEndpointAwsService
- type InterfaceVpcEndpointAwsServiceProps
- type InterfaceVpcEndpointOptions
- type InterfaceVpcEndpointProps
- type InterfaceVpcEndpointService
- type IpAddresses
- type IpProtocol
- type Ipv6Addresses
- type KeyPair
- type KeyPairAttributes
- type KeyPairFormat
- type KeyPairProps
- type KeyPairType
- type LaunchTemplate
- type LaunchTemplateAttributes
- type LaunchTemplateHttpTokens
- type LaunchTemplateProps
- type LaunchTemplateRequireImdsv2Aspect
- type LaunchTemplateRequireImdsv2AspectProps
- type LaunchTemplateSpecialVersions
- type LaunchTemplateSpotOptions
- type LinuxUserDataOptions
- type LocationPackageOptions
- type LogFormat
- func LogFormat_ACCOUNT_ID() LogFormat
- func LogFormat_ACTION() LogFormat
- func LogFormat_ALL_DEFAULT_FIELDS() LogFormat
- func LogFormat_AZ_ID() LogFormat
- func LogFormat_BYTES() LogFormat
- func LogFormat_Custom(formatString *string) LogFormat
- func LogFormat_DST_ADDR() LogFormat
- func LogFormat_DST_PORT() LogFormat
- func LogFormat_ECS_CLUSTER_ARN() LogFormat
- func LogFormat_ECS_CLUSTER_NAME() LogFormat
- func LogFormat_ECS_CONTAINER_ID() LogFormat
- func LogFormat_ECS_CONTAINER_INSTANCE_ARN() LogFormat
- func LogFormat_ECS_CONTAINER_INSTANCE_ID() LogFormat
- func LogFormat_ECS_SECOND_CONTAINER_ID() LogFormat
- func LogFormat_ECS_SERVICE_NAME() LogFormat
- func LogFormat_ECS_TASK_ARN() LogFormat
- func LogFormat_ECS_TASK_DEFINITION_ARN() LogFormat
- func LogFormat_ECS_TASK_ID() LogFormat
- func LogFormat_END_TIMESTAMP() LogFormat
- func LogFormat_FLOW_DIRECTION() LogFormat
- func LogFormat_Field(field *string) LogFormat
- func LogFormat_INSTANCE_ID() LogFormat
- func LogFormat_INTERFACE_ID() LogFormat
- func LogFormat_LOG_STATUS() LogFormat
- func LogFormat_PACKETS() LogFormat
- func LogFormat_PKT_DST_ADDR() LogFormat
- func LogFormat_PKT_DST_AWS_SERVICE() LogFormat
- func LogFormat_PKT_SRC_ADDR() LogFormat
- func LogFormat_PKT_SRC_AWS_SERVICE() LogFormat
- func LogFormat_PROTOCOL() LogFormat
- func LogFormat_REGION() LogFormat
- func LogFormat_SRC_ADDR() LogFormat
- func LogFormat_SRC_PORT() LogFormat
- func LogFormat_START_TIMESTAMP() LogFormat
- func LogFormat_SUBLOCATION_ID() LogFormat
- func LogFormat_SUBLOCATION_TYPE() LogFormat
- func LogFormat_SUBNET_ID() LogFormat
- func LogFormat_TCP_FLAGS() LogFormat
- func LogFormat_TRAFFIC_PATH() LogFormat
- func LogFormat_TRAFFIC_TYPE() LogFormat
- func LogFormat_VERSION() LogFormat
- func LogFormat_VPC_ID() LogFormat
- func NewLogFormat(value *string) LogFormat
- type LookupMachineImage
- type LookupMachineImageProps
- type MachineImage
- type MachineImageConfig
- type MultipartBody
- type MultipartBodyOptions
- type MultipartUserData
- type MultipartUserDataOptions
- type NamedPackageOptions
- type NatGatewayProps
- type NatGatewayProvider
- type NatInstanceImage
- type NatInstanceProps
- type NatInstanceProviderdeprecated
- func NatGatewayProvider_Instance(props *NatInstanceProps) NatInstanceProviderdeprecated
- func NatInstanceProviderV2_Instance(props *NatInstanceProps) NatInstanceProviderdeprecated
- func NatInstanceProvider_Instance(props *NatInstanceProps) NatInstanceProviderdeprecated
- func NatProvider_Instance(props *NatInstanceProps) NatInstanceProviderdeprecated
- func NewNatInstanceProvider(props *NatInstanceProps) NatInstanceProviderdeprecated
- type NatInstanceProviderV2
- func NatGatewayProvider_InstanceV2(props *NatInstanceProps) NatInstanceProviderV2
- func NatInstanceProviderV2_InstanceV2(props *NatInstanceProps) NatInstanceProviderV2
- func NatInstanceProvider_InstanceV2(props *NatInstanceProps) NatInstanceProviderV2deprecated
- func NatProvider_InstanceV2(props *NatInstanceProps) NatInstanceProviderV2
- func NewNatInstanceProviderV2(props *NatInstanceProps) NatInstanceProviderV2
- type NatProvider
- type NatTrafficDirection
- type NetworkAcl
- type NetworkAclEntry
- type NetworkAclEntryProps
- type NetworkAclProps
- type OperatingSystemType
- type Peer
- type PlacementGroup
- type PlacementGroupProps
- type PlacementGroupSpreadLevel
- type PlacementGroupStrategy
- type Port
- func NewPort(props *PortProps) Port
- func Port_Ah() Port
- func Port_AllIcmp() Port
- func Port_AllIcmpV6() Port
- func Port_AllTcp() Port
- func Port_AllTraffic() Port
- func Port_AllUdp() Port
- func Port_DNS_TCP() Port
- func Port_DNS_UDP() Port
- func Port_Esp() Port
- func Port_HTTP() Port
- func Port_HTTPS() Port
- func Port_IMAP() Port
- func Port_IMAPS() Port
- func Port_IcmpPing() Port
- func Port_IcmpType(type_ *float64) Port
- func Port_IcmpTypeAndCode(type_ *float64, code *float64) Port
- func Port_LDAP() Port
- func Port_MSSQL() Port
- func Port_MYSQL_AURORA() Port
- func Port_NFS() Port
- func Port_POP3() Port
- func Port_POP3S() Port
- func Port_POSTGRES() Port
- func Port_RDP() Port
- func Port_SMB() Port
- func Port_SMTP() Port
- func Port_SSH() Port
- func Port_Tcp(port *float64) Port
- func Port_TcpRange(startPort *float64, endPort *float64) Port
- func Port_Udp(port *float64) Port
- func Port_UdpRange(startPort *float64, endPort *float64) Port
- type PortProps
- type PrefixList
- type PrefixListOptions
- type PrefixListProps
- type PrivateSubnet
- type PrivateSubnetAttributes
- type PrivateSubnetProps
- type Protocol
- type PublicSubnet
- type PublicSubnetAttributes
- type PublicSubnetProps
- type RequestedSubnet
- type ResolveSsmParameterAtLaunchImage
- type RouterType
- type RuleScope
- type S3DestinationOptions
- type S3DownloadOptions
- type SecurityGroup
- type SecurityGroupImportOptions
- type SecurityGroupProps
- type SelectedSubnets
- type ServiceManager
- type SpotInstanceInterruption
- type SpotRequestType
- type SsmParameterImageOptions
- type Subnet
- type SubnetAttributes
- type SubnetConfiguration
- type SubnetFilter
- func SubnetFilter_AvailabilityZones(availabilityZones *[]*string) SubnetFilter
- func SubnetFilter_ByCidrMask(mask *float64) SubnetFilter
- func SubnetFilter_ByCidrRanges(cidrs *[]*string) SubnetFilter
- func SubnetFilter_ByIds(subnetIds *[]*string) SubnetFilter
- func SubnetFilter_ContainsIpAddresses(ipv4addrs *[]*string) SubnetFilter
- func SubnetFilter_OnePerAz() SubnetFilter
- type SubnetIpamOptions
- type SubnetNetworkAclAssociation
- type SubnetNetworkAclAssociationProps
- type SubnetProps
- type SubnetSelection
- type SubnetType
- type SystemdConfigFileOptions
- type TrafficDirection
- type TransportProtocol
- type UserData
- func MultipartUserData_Custom(content *string) UserData
- func MultipartUserData_ForLinux(options *LinuxUserDataOptions) UserData
- func MultipartUserData_ForOperatingSystem(os OperatingSystemType) UserData
- func MultipartUserData_ForWindows(options *WindowsUserDataOptions) UserData
- func UserData_Custom(content *string) UserData
- func UserData_ForLinux(options *LinuxUserDataOptions) UserData
- func UserData_ForOperatingSystem(os OperatingSystemType) UserData
- func UserData_ForWindows(options *WindowsUserDataOptions) UserData
- type Volume
- type VolumeAttributes
- type VolumeProps
- type Vpc
- type VpcAttributes
- type VpcEndpoint
- type VpcEndpointService
- type VpcEndpointServiceProps
- type VpcEndpointType
- type VpcIpamOptions
- type VpcLookupOptions
- type VpcProps
- type VpnConnection
- type VpnConnectionAttributes
- type VpnConnectionBase
- type VpnConnectionOptions
- type VpnConnectionProps
- type VpnConnectionType
- type VpnGateway
- type VpnGatewayProps
- type VpnPort
- type VpnTunnelOption
- type WindowsImage
- type WindowsImageProps
- type WindowsUserDataOptions
- type WindowsVersion
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AmazonLinux2022ImageSsmParameter_SsmParameterName ¶ added in v2.76.0
func AmazonLinux2022ImageSsmParameter_SsmParameterName(props *AmazonLinux2022ImageSsmParameterProps) *string
Generates a SSM Parameter name for a specific amazon linux 2022 AMI.
Example values:
"/aws/service/ami-amazon-linux-latest/al2022-ami-kernel-5.15-x86_64", "/aws/service/ami-amazon-linux-latest/al2022-ami-kernel-default-x86_64", "/aws/service/ami-amazon-linux-latest/al2022-ami-minimal-kernel-5.15-arm64", "/aws/service/ami-amazon-linux-latest/al2022-ami-minimal-kernel-5.15-x86_64", "/aws/service/ami-amazon-linux-latest/al2022-ami-kernel-5.15-arm64", "/aws/service/ami-amazon-linux-latest/al2022-ami-minimal-kernel-default-arm64", "/aws/service/ami-amazon-linux-latest/al2022-ami-minimal-kernel-default-x86_64",
"/aws/service/ami-amazon-linux-latest/al2022-ami-kernel-default-arm64",.
func AmazonLinux2023ImageSsmParameter_SsmParameterName ¶ added in v2.76.0
func AmazonLinux2023ImageSsmParameter_SsmParameterName(props *AmazonLinux2023ImageSsmParameterProps) *string
Generates a SSM Parameter name for a specific amazon linux 2023 AMI.
Example values:
"/aws/service/ami-amazon-linux-latest/al2023-ami-kernel-6.1-arm64", "/aws/service/ami-amazon-linux-latest/al2023-ami-kernel-6.1-x86_64", "/aws/service/ami-amazon-linux-latest/al2023-ami-minimal-kernel-6.1-arm64", "/aws/service/ami-amazon-linux-latest/al2023-ami-minimal-kernel-6.1-x86_64", "/aws/service/ami-amazon-linux-latest/al2023-ami-minimal-kernel-default-arm64", "/aws/service/ami-amazon-linux-latest/al2023-ami-kernel-default-x86_64", "/aws/service/ami-amazon-linux-latest/al2023-ami-minimal-kernel-default-x86_64",
"/aws/service/ami-amazon-linux-latest/al2023-ami-kernel-default-arm64",.
func AmazonLinux2ImageSsmParameter_SsmParameterName ¶ added in v2.76.0
func AmazonLinux2ImageSsmParameter_SsmParameterName(props *AmazonLinux2ImageSsmParameterProps) *string
Generates a SSM Parameter name for a specific amazon linux 2 AMI.
Example values:
"/aws/service/ami-amazon-linux-latest/amzn2-ami-hvm-x86_64-ebs", "/aws/service/ami-amazon-linux-latest/amzn2-ami-hvm-x86_64-gp2", "/aws/service/ami-amazon-linux-latest/amzn2-ami-kernel-5.10-hvm-x86_64-ebs", "/aws/service/ami-amazon-linux-latest/amzn2-ami-hvm-arm64-gp2", "/aws/service/ami-amazon-linux-latest/amzn2-ami-minimal-hvm-arm64-ebs", "/aws/service/ami-amazon-linux-latest/amzn2-ami-kernel-5.10-hvm-arm64-gp2", "/aws/service/ami-amazon-linux-latest/amzn2-ami-kernel-5.10-hvm-x86_64-gp2",
"/aws/service/ami-amazon-linux-latest/amzn2-ami-minimal-hvm-x86_64-ebs".
func AmazonLinuxImage_SsmParameterName ¶
func AmazonLinuxImage_SsmParameterName(props *AmazonLinuxImageProps) *string
Return the SSM parameter name that will contain the Amazon Linux image with the given attributes.
func BastionHostLinux_IsConstruct ¶
func BastionHostLinux_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 BastionHostLinux_IsOwnedResource ¶ added in v2.32.0
func BastionHostLinux_IsOwnedResource(construct constructs.IConstruct) *bool
Returns true if the construct was created by CDK, and false otherwise.
func BastionHostLinux_IsResource ¶
func BastionHostLinux_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource.
func CfnCapacityReservationFleet_CFN_RESOURCE_TYPE_NAME ¶
func CfnCapacityReservationFleet_CFN_RESOURCE_TYPE_NAME() *string
func CfnCapacityReservationFleet_IsCfnElement ¶
func CfnCapacityReservationFleet_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 CfnCapacityReservationFleet_IsCfnResource ¶
func CfnCapacityReservationFleet_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnCapacityReservationFleet_IsConstruct ¶
func CfnCapacityReservationFleet_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 CfnCapacityReservation_CFN_RESOURCE_TYPE_NAME ¶
func CfnCapacityReservation_CFN_RESOURCE_TYPE_NAME() *string
func CfnCapacityReservation_IsCfnElement ¶
func CfnCapacityReservation_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 CfnCapacityReservation_IsCfnResource ¶
func CfnCapacityReservation_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnCapacityReservation_IsConstruct ¶
func CfnCapacityReservation_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 CfnCarrierGateway_CFN_RESOURCE_TYPE_NAME ¶
func CfnCarrierGateway_CFN_RESOURCE_TYPE_NAME() *string
func CfnCarrierGateway_IsCfnElement ¶
func CfnCarrierGateway_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 CfnCarrierGateway_IsCfnResource ¶
func CfnCarrierGateway_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnCarrierGateway_IsConstruct ¶
func CfnCarrierGateway_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 CfnClientVpnAuthorizationRule_CFN_RESOURCE_TYPE_NAME ¶
func CfnClientVpnAuthorizationRule_CFN_RESOURCE_TYPE_NAME() *string
func CfnClientVpnAuthorizationRule_IsCfnElement ¶
func CfnClientVpnAuthorizationRule_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 CfnClientVpnAuthorizationRule_IsCfnResource ¶
func CfnClientVpnAuthorizationRule_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnClientVpnAuthorizationRule_IsConstruct ¶
func CfnClientVpnAuthorizationRule_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 CfnClientVpnEndpoint_CFN_RESOURCE_TYPE_NAME ¶
func CfnClientVpnEndpoint_CFN_RESOURCE_TYPE_NAME() *string
func CfnClientVpnEndpoint_IsCfnElement ¶
func CfnClientVpnEndpoint_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 CfnClientVpnEndpoint_IsCfnResource ¶
func CfnClientVpnEndpoint_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnClientVpnEndpoint_IsConstruct ¶
func CfnClientVpnEndpoint_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 CfnClientVpnRoute_CFN_RESOURCE_TYPE_NAME ¶
func CfnClientVpnRoute_CFN_RESOURCE_TYPE_NAME() *string
func CfnClientVpnRoute_IsCfnElement ¶
func CfnClientVpnRoute_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 CfnClientVpnRoute_IsCfnResource ¶
func CfnClientVpnRoute_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnClientVpnRoute_IsConstruct ¶
func CfnClientVpnRoute_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 CfnClientVpnTargetNetworkAssociation_CFN_RESOURCE_TYPE_NAME ¶
func CfnClientVpnTargetNetworkAssociation_CFN_RESOURCE_TYPE_NAME() *string
func CfnClientVpnTargetNetworkAssociation_IsCfnElement ¶
func CfnClientVpnTargetNetworkAssociation_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 CfnClientVpnTargetNetworkAssociation_IsCfnResource ¶
func CfnClientVpnTargetNetworkAssociation_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnClientVpnTargetNetworkAssociation_IsConstruct ¶
func CfnClientVpnTargetNetworkAssociation_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 CfnCustomerGateway_CFN_RESOURCE_TYPE_NAME ¶
func CfnCustomerGateway_CFN_RESOURCE_TYPE_NAME() *string
func CfnCustomerGateway_IsCfnElement ¶
func CfnCustomerGateway_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 CfnCustomerGateway_IsCfnResource ¶
func CfnCustomerGateway_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnCustomerGateway_IsConstruct ¶
func CfnCustomerGateway_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 CfnDHCPOptions_CFN_RESOURCE_TYPE_NAME ¶
func CfnDHCPOptions_CFN_RESOURCE_TYPE_NAME() *string
func CfnDHCPOptions_IsCfnElement ¶
func CfnDHCPOptions_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 CfnDHCPOptions_IsCfnResource ¶
func CfnDHCPOptions_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnDHCPOptions_IsConstruct ¶
func CfnDHCPOptions_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 CfnEC2Fleet_CFN_RESOURCE_TYPE_NAME ¶
func CfnEC2Fleet_CFN_RESOURCE_TYPE_NAME() *string
func CfnEC2Fleet_IsCfnElement ¶
func CfnEC2Fleet_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 CfnEC2Fleet_IsCfnResource ¶
func CfnEC2Fleet_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnEC2Fleet_IsConstruct ¶
func CfnEC2Fleet_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 CfnEIPAssociation_CFN_RESOURCE_TYPE_NAME ¶
func CfnEIPAssociation_CFN_RESOURCE_TYPE_NAME() *string
func CfnEIPAssociation_IsCfnElement ¶
func CfnEIPAssociation_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 CfnEIPAssociation_IsCfnResource ¶
func CfnEIPAssociation_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnEIPAssociation_IsConstruct ¶
func CfnEIPAssociation_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 CfnEIP_CFN_RESOURCE_TYPE_NAME ¶
func CfnEIP_CFN_RESOURCE_TYPE_NAME() *string
func CfnEIP_IsCfnElement ¶
func CfnEIP_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 CfnEIP_IsCfnResource ¶
func CfnEIP_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnEIP_IsConstruct ¶
func CfnEIP_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 CfnEgressOnlyInternetGateway_CFN_RESOURCE_TYPE_NAME ¶
func CfnEgressOnlyInternetGateway_CFN_RESOURCE_TYPE_NAME() *string
func CfnEgressOnlyInternetGateway_IsCfnElement ¶
func CfnEgressOnlyInternetGateway_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 CfnEgressOnlyInternetGateway_IsCfnResource ¶
func CfnEgressOnlyInternetGateway_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnEgressOnlyInternetGateway_IsConstruct ¶
func CfnEgressOnlyInternetGateway_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 CfnEnclaveCertificateIamRoleAssociation_CFN_RESOURCE_TYPE_NAME ¶
func CfnEnclaveCertificateIamRoleAssociation_CFN_RESOURCE_TYPE_NAME() *string
func CfnEnclaveCertificateIamRoleAssociation_IsCfnElement ¶
func CfnEnclaveCertificateIamRoleAssociation_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 CfnEnclaveCertificateIamRoleAssociation_IsCfnResource ¶
func CfnEnclaveCertificateIamRoleAssociation_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnEnclaveCertificateIamRoleAssociation_IsConstruct ¶
func CfnEnclaveCertificateIamRoleAssociation_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 CfnFlowLog_CFN_RESOURCE_TYPE_NAME ¶
func CfnFlowLog_CFN_RESOURCE_TYPE_NAME() *string
func CfnFlowLog_IsCfnElement ¶
func CfnFlowLog_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 CfnFlowLog_IsCfnResource ¶
func CfnFlowLog_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnFlowLog_IsConstruct ¶
func CfnFlowLog_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 CfnGatewayRouteTableAssociation_CFN_RESOURCE_TYPE_NAME ¶
func CfnGatewayRouteTableAssociation_CFN_RESOURCE_TYPE_NAME() *string
func CfnGatewayRouteTableAssociation_IsCfnElement ¶
func CfnGatewayRouteTableAssociation_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 CfnGatewayRouteTableAssociation_IsCfnResource ¶
func CfnGatewayRouteTableAssociation_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnGatewayRouteTableAssociation_IsConstruct ¶
func CfnGatewayRouteTableAssociation_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 CfnHost_CFN_RESOURCE_TYPE_NAME ¶
func CfnHost_CFN_RESOURCE_TYPE_NAME() *string
func CfnHost_IsCfnElement ¶
func CfnHost_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 CfnHost_IsCfnResource ¶
func CfnHost_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnHost_IsConstruct ¶
func CfnHost_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 CfnIPAMAllocation_CFN_RESOURCE_TYPE_NAME ¶ added in v2.2.0
func CfnIPAMAllocation_CFN_RESOURCE_TYPE_NAME() *string
func CfnIPAMAllocation_IsCfnElement ¶ added in v2.2.0
func CfnIPAMAllocation_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 CfnIPAMAllocation_IsCfnResource ¶ added in v2.2.0
func CfnIPAMAllocation_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnIPAMAllocation_IsConstruct ¶ added in v2.2.0
func CfnIPAMAllocation_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 CfnIPAMPoolCidr_CFN_RESOURCE_TYPE_NAME ¶ added in v2.64.0
func CfnIPAMPoolCidr_CFN_RESOURCE_TYPE_NAME() *string
func CfnIPAMPoolCidr_IsCfnElement ¶ added in v2.64.0
func CfnIPAMPoolCidr_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 CfnIPAMPoolCidr_IsCfnResource ¶ added in v2.64.0
func CfnIPAMPoolCidr_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnIPAMPoolCidr_IsConstruct ¶ added in v2.64.0
func CfnIPAMPoolCidr_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 CfnIPAMPool_CFN_RESOURCE_TYPE_NAME ¶ added in v2.2.0
func CfnIPAMPool_CFN_RESOURCE_TYPE_NAME() *string
func CfnIPAMPool_IsCfnElement ¶ added in v2.2.0
func CfnIPAMPool_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 CfnIPAMPool_IsCfnResource ¶ added in v2.2.0
func CfnIPAMPool_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnIPAMPool_IsConstruct ¶ added in v2.2.0
func CfnIPAMPool_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 CfnIPAMResourceDiscoveryAssociation_CFN_RESOURCE_TYPE_NAME ¶ added in v2.64.0
func CfnIPAMResourceDiscoveryAssociation_CFN_RESOURCE_TYPE_NAME() *string
func CfnIPAMResourceDiscoveryAssociation_IsCfnElement ¶ added in v2.64.0
func CfnIPAMResourceDiscoveryAssociation_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 CfnIPAMResourceDiscoveryAssociation_IsCfnResource ¶ added in v2.64.0
func CfnIPAMResourceDiscoveryAssociation_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnIPAMResourceDiscoveryAssociation_IsConstruct ¶ added in v2.64.0
func CfnIPAMResourceDiscoveryAssociation_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 CfnIPAMResourceDiscovery_CFN_RESOURCE_TYPE_NAME ¶ added in v2.64.0
func CfnIPAMResourceDiscovery_CFN_RESOURCE_TYPE_NAME() *string
func CfnIPAMResourceDiscovery_IsCfnElement ¶ added in v2.64.0
func CfnIPAMResourceDiscovery_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 CfnIPAMResourceDiscovery_IsCfnResource ¶ added in v2.64.0
func CfnIPAMResourceDiscovery_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnIPAMResourceDiscovery_IsConstruct ¶ added in v2.64.0
func CfnIPAMResourceDiscovery_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 CfnIPAMScope_CFN_RESOURCE_TYPE_NAME ¶ added in v2.2.0
func CfnIPAMScope_CFN_RESOURCE_TYPE_NAME() *string
func CfnIPAMScope_IsCfnElement ¶ added in v2.2.0
func CfnIPAMScope_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 CfnIPAMScope_IsCfnResource ¶ added in v2.2.0
func CfnIPAMScope_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnIPAMScope_IsConstruct ¶ added in v2.2.0
func CfnIPAMScope_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 CfnIPAM_CFN_RESOURCE_TYPE_NAME ¶ added in v2.2.0
func CfnIPAM_CFN_RESOURCE_TYPE_NAME() *string
func CfnIPAM_IsCfnElement ¶ added in v2.2.0
func CfnIPAM_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 CfnIPAM_IsCfnResource ¶ added in v2.2.0
func CfnIPAM_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnIPAM_IsConstruct ¶ added in v2.2.0
func CfnIPAM_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 CfnInstanceConnectEndpoint_CFN_RESOURCE_TYPE_NAME ¶ added in v2.97.0
func CfnInstanceConnectEndpoint_CFN_RESOURCE_TYPE_NAME() *string
func CfnInstanceConnectEndpoint_IsCfnElement ¶ added in v2.97.0
func CfnInstanceConnectEndpoint_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 CfnInstanceConnectEndpoint_IsCfnResource ¶ added in v2.97.0
func CfnInstanceConnectEndpoint_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnInstanceConnectEndpoint_IsConstruct ¶ added in v2.97.0
func CfnInstanceConnectEndpoint_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 CfnInternetGateway_CFN_RESOURCE_TYPE_NAME ¶
func CfnInternetGateway_CFN_RESOURCE_TYPE_NAME() *string
func CfnInternetGateway_IsCfnElement ¶
func CfnInternetGateway_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 CfnInternetGateway_IsCfnResource ¶
func CfnInternetGateway_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnInternetGateway_IsConstruct ¶
func CfnInternetGateway_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 CfnKeyPair_CFN_RESOURCE_TYPE_NAME ¶ added in v2.25.0
func CfnKeyPair_CFN_RESOURCE_TYPE_NAME() *string
func CfnKeyPair_IsCfnElement ¶ added in v2.25.0
func CfnKeyPair_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 CfnKeyPair_IsCfnResource ¶ added in v2.25.0
func CfnKeyPair_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnKeyPair_IsConstruct ¶ added in v2.25.0
func CfnKeyPair_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 CfnLaunchTemplate_CFN_RESOURCE_TYPE_NAME ¶
func CfnLaunchTemplate_CFN_RESOURCE_TYPE_NAME() *string
func CfnLaunchTemplate_IsCfnElement ¶
func CfnLaunchTemplate_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 CfnLaunchTemplate_IsCfnResource ¶
func CfnLaunchTemplate_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnLaunchTemplate_IsConstruct ¶
func CfnLaunchTemplate_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 CfnLocalGatewayRouteTableVPCAssociation_CFN_RESOURCE_TYPE_NAME ¶
func CfnLocalGatewayRouteTableVPCAssociation_CFN_RESOURCE_TYPE_NAME() *string
func CfnLocalGatewayRouteTableVPCAssociation_IsCfnElement ¶
func CfnLocalGatewayRouteTableVPCAssociation_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 CfnLocalGatewayRouteTableVPCAssociation_IsCfnResource ¶
func CfnLocalGatewayRouteTableVPCAssociation_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnLocalGatewayRouteTableVPCAssociation_IsConstruct ¶
func CfnLocalGatewayRouteTableVPCAssociation_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 CfnLocalGatewayRouteTableVirtualInterfaceGroupAssociation_CFN_RESOURCE_TYPE_NAME ¶ added in v2.70.0
func CfnLocalGatewayRouteTableVirtualInterfaceGroupAssociation_CFN_RESOURCE_TYPE_NAME() *string
func CfnLocalGatewayRouteTableVirtualInterfaceGroupAssociation_IsCfnElement ¶ added in v2.70.0
func CfnLocalGatewayRouteTableVirtualInterfaceGroupAssociation_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 CfnLocalGatewayRouteTableVirtualInterfaceGroupAssociation_IsCfnResource ¶ added in v2.70.0
func CfnLocalGatewayRouteTableVirtualInterfaceGroupAssociation_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnLocalGatewayRouteTableVirtualInterfaceGroupAssociation_IsConstruct ¶ added in v2.70.0
func CfnLocalGatewayRouteTableVirtualInterfaceGroupAssociation_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 CfnLocalGatewayRouteTable_CFN_RESOURCE_TYPE_NAME ¶ added in v2.70.0
func CfnLocalGatewayRouteTable_CFN_RESOURCE_TYPE_NAME() *string
func CfnLocalGatewayRouteTable_IsCfnElement ¶ added in v2.70.0
func CfnLocalGatewayRouteTable_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 CfnLocalGatewayRouteTable_IsCfnResource ¶ added in v2.70.0
func CfnLocalGatewayRouteTable_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnLocalGatewayRouteTable_IsConstruct ¶ added in v2.70.0
func CfnLocalGatewayRouteTable_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 CfnLocalGatewayRoute_CFN_RESOURCE_TYPE_NAME ¶
func CfnLocalGatewayRoute_CFN_RESOURCE_TYPE_NAME() *string
func CfnLocalGatewayRoute_IsCfnElement ¶
func CfnLocalGatewayRoute_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 CfnLocalGatewayRoute_IsCfnResource ¶
func CfnLocalGatewayRoute_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnLocalGatewayRoute_IsConstruct ¶
func CfnLocalGatewayRoute_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 CfnNatGateway_CFN_RESOURCE_TYPE_NAME ¶
func CfnNatGateway_CFN_RESOURCE_TYPE_NAME() *string
func CfnNatGateway_IsCfnElement ¶
func CfnNatGateway_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 CfnNatGateway_IsCfnResource ¶
func CfnNatGateway_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnNatGateway_IsConstruct ¶
func CfnNatGateway_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 CfnNetworkAclEntry_CFN_RESOURCE_TYPE_NAME ¶
func CfnNetworkAclEntry_CFN_RESOURCE_TYPE_NAME() *string
func CfnNetworkAclEntry_IsCfnElement ¶
func CfnNetworkAclEntry_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 CfnNetworkAclEntry_IsCfnResource ¶
func CfnNetworkAclEntry_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnNetworkAclEntry_IsConstruct ¶
func CfnNetworkAclEntry_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 CfnNetworkAcl_CFN_RESOURCE_TYPE_NAME ¶
func CfnNetworkAcl_CFN_RESOURCE_TYPE_NAME() *string
func CfnNetworkAcl_IsCfnElement ¶
func CfnNetworkAcl_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 CfnNetworkAcl_IsCfnResource ¶
func CfnNetworkAcl_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnNetworkAcl_IsConstruct ¶
func CfnNetworkAcl_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 CfnNetworkInsightsAccessScopeAnalysis_CFN_RESOURCE_TYPE_NAME ¶ added in v2.9.0
func CfnNetworkInsightsAccessScopeAnalysis_CFN_RESOURCE_TYPE_NAME() *string
func CfnNetworkInsightsAccessScopeAnalysis_IsCfnElement ¶ added in v2.9.0
func CfnNetworkInsightsAccessScopeAnalysis_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 CfnNetworkInsightsAccessScopeAnalysis_IsCfnResource ¶ added in v2.9.0
func CfnNetworkInsightsAccessScopeAnalysis_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnNetworkInsightsAccessScopeAnalysis_IsConstruct ¶ added in v2.9.0
func CfnNetworkInsightsAccessScopeAnalysis_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 CfnNetworkInsightsAccessScope_CFN_RESOURCE_TYPE_NAME ¶ added in v2.9.0
func CfnNetworkInsightsAccessScope_CFN_RESOURCE_TYPE_NAME() *string
func CfnNetworkInsightsAccessScope_IsCfnElement ¶ added in v2.9.0
func CfnNetworkInsightsAccessScope_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 CfnNetworkInsightsAccessScope_IsCfnResource ¶ added in v2.9.0
func CfnNetworkInsightsAccessScope_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnNetworkInsightsAccessScope_IsConstruct ¶ added in v2.9.0
func CfnNetworkInsightsAccessScope_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 CfnNetworkInsightsAnalysis_CFN_RESOURCE_TYPE_NAME ¶
func CfnNetworkInsightsAnalysis_CFN_RESOURCE_TYPE_NAME() *string
func CfnNetworkInsightsAnalysis_IsCfnElement ¶
func CfnNetworkInsightsAnalysis_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 CfnNetworkInsightsAnalysis_IsCfnResource ¶
func CfnNetworkInsightsAnalysis_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnNetworkInsightsAnalysis_IsConstruct ¶
func CfnNetworkInsightsAnalysis_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 CfnNetworkInsightsPath_CFN_RESOURCE_TYPE_NAME ¶
func CfnNetworkInsightsPath_CFN_RESOURCE_TYPE_NAME() *string
func CfnNetworkInsightsPath_IsCfnElement ¶
func CfnNetworkInsightsPath_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 CfnNetworkInsightsPath_IsCfnResource ¶
func CfnNetworkInsightsPath_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnNetworkInsightsPath_IsConstruct ¶
func CfnNetworkInsightsPath_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 CfnNetworkInterfaceAttachment_CFN_RESOURCE_TYPE_NAME ¶
func CfnNetworkInterfaceAttachment_CFN_RESOURCE_TYPE_NAME() *string
func CfnNetworkInterfaceAttachment_IsCfnElement ¶
func CfnNetworkInterfaceAttachment_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 CfnNetworkInterfaceAttachment_IsCfnResource ¶
func CfnNetworkInterfaceAttachment_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnNetworkInterfaceAttachment_IsConstruct ¶
func CfnNetworkInterfaceAttachment_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 CfnNetworkInterfacePermission_CFN_RESOURCE_TYPE_NAME ¶
func CfnNetworkInterfacePermission_CFN_RESOURCE_TYPE_NAME() *string
func CfnNetworkInterfacePermission_IsCfnElement ¶
func CfnNetworkInterfacePermission_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 CfnNetworkInterfacePermission_IsCfnResource ¶
func CfnNetworkInterfacePermission_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnNetworkInterfacePermission_IsConstruct ¶
func CfnNetworkInterfacePermission_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 CfnNetworkInterface_CFN_RESOURCE_TYPE_NAME ¶
func CfnNetworkInterface_CFN_RESOURCE_TYPE_NAME() *string
func CfnNetworkInterface_IsCfnElement ¶
func CfnNetworkInterface_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 CfnNetworkInterface_IsCfnResource ¶
func CfnNetworkInterface_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnNetworkInterface_IsConstruct ¶
func CfnNetworkInterface_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 CfnNetworkPerformanceMetricSubscription_CFN_RESOURCE_TYPE_NAME ¶ added in v2.55.0
func CfnNetworkPerformanceMetricSubscription_CFN_RESOURCE_TYPE_NAME() *string
func CfnNetworkPerformanceMetricSubscription_IsCfnElement ¶ added in v2.55.0
func CfnNetworkPerformanceMetricSubscription_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 CfnNetworkPerformanceMetricSubscription_IsCfnResource ¶ added in v2.55.0
func CfnNetworkPerformanceMetricSubscription_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnNetworkPerformanceMetricSubscription_IsConstruct ¶ added in v2.55.0
func CfnNetworkPerformanceMetricSubscription_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 CfnPlacementGroup_CFN_RESOURCE_TYPE_NAME ¶
func CfnPlacementGroup_CFN_RESOURCE_TYPE_NAME() *string
func CfnPlacementGroup_IsCfnElement ¶
func CfnPlacementGroup_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 CfnPlacementGroup_IsCfnResource ¶
func CfnPlacementGroup_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnPlacementGroup_IsConstruct ¶
func CfnPlacementGroup_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 CfnPrefixList_CFN_RESOURCE_TYPE_NAME ¶
func CfnPrefixList_CFN_RESOURCE_TYPE_NAME() *string
func CfnPrefixList_IsCfnElement ¶
func CfnPrefixList_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 CfnPrefixList_IsCfnResource ¶
func CfnPrefixList_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnPrefixList_IsConstruct ¶
func CfnPrefixList_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 CfnRouteTable_CFN_RESOURCE_TYPE_NAME ¶
func CfnRouteTable_CFN_RESOURCE_TYPE_NAME() *string
func CfnRouteTable_IsCfnElement ¶
func CfnRouteTable_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 CfnRouteTable_IsCfnResource ¶
func CfnRouteTable_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnRouteTable_IsConstruct ¶
func CfnRouteTable_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 CfnRoute_CFN_RESOURCE_TYPE_NAME ¶
func CfnRoute_CFN_RESOURCE_TYPE_NAME() *string
func CfnRoute_IsCfnElement ¶
func CfnRoute_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 CfnRoute_IsCfnResource ¶
func CfnRoute_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnRoute_IsConstruct ¶
func CfnRoute_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 CfnSecurityGroupEgress_CFN_RESOURCE_TYPE_NAME ¶
func CfnSecurityGroupEgress_CFN_RESOURCE_TYPE_NAME() *string
func CfnSecurityGroupEgress_IsCfnElement ¶
func CfnSecurityGroupEgress_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 CfnSecurityGroupEgress_IsCfnResource ¶
func CfnSecurityGroupEgress_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnSecurityGroupEgress_IsConstruct ¶
func CfnSecurityGroupEgress_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 CfnSecurityGroupIngress_CFN_RESOURCE_TYPE_NAME ¶
func CfnSecurityGroupIngress_CFN_RESOURCE_TYPE_NAME() *string
func CfnSecurityGroupIngress_IsCfnElement ¶
func CfnSecurityGroupIngress_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 CfnSecurityGroupIngress_IsCfnResource ¶
func CfnSecurityGroupIngress_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnSecurityGroupIngress_IsConstruct ¶
func CfnSecurityGroupIngress_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 CfnSecurityGroup_CFN_RESOURCE_TYPE_NAME ¶
func CfnSecurityGroup_CFN_RESOURCE_TYPE_NAME() *string
func CfnSecurityGroup_IsCfnElement ¶
func CfnSecurityGroup_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 CfnSecurityGroup_IsCfnResource ¶
func CfnSecurityGroup_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnSecurityGroup_IsConstruct ¶
func CfnSecurityGroup_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 CfnSnapshotBlockPublicAccess_CFN_RESOURCE_TYPE_NAME ¶ added in v2.116.0
func CfnSnapshotBlockPublicAccess_CFN_RESOURCE_TYPE_NAME() *string
func CfnSnapshotBlockPublicAccess_IsCfnElement ¶ added in v2.116.0
func CfnSnapshotBlockPublicAccess_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 CfnSnapshotBlockPublicAccess_IsCfnResource ¶ added in v2.116.0
func CfnSnapshotBlockPublicAccess_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnSnapshotBlockPublicAccess_IsConstruct ¶ added in v2.116.0
func CfnSnapshotBlockPublicAccess_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 CfnSpotFleet_CFN_RESOURCE_TYPE_NAME ¶
func CfnSpotFleet_CFN_RESOURCE_TYPE_NAME() *string
func CfnSpotFleet_IsCfnElement ¶
func CfnSpotFleet_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 CfnSpotFleet_IsCfnResource ¶
func CfnSpotFleet_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnSpotFleet_IsConstruct ¶
func CfnSpotFleet_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 CfnSubnetCidrBlock_CFN_RESOURCE_TYPE_NAME ¶
func CfnSubnetCidrBlock_CFN_RESOURCE_TYPE_NAME() *string
func CfnSubnetCidrBlock_IsCfnElement ¶
func CfnSubnetCidrBlock_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 CfnSubnetCidrBlock_IsCfnResource ¶
func CfnSubnetCidrBlock_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnSubnetCidrBlock_IsConstruct ¶
func CfnSubnetCidrBlock_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 CfnSubnetNetworkAclAssociation_CFN_RESOURCE_TYPE_NAME ¶
func CfnSubnetNetworkAclAssociation_CFN_RESOURCE_TYPE_NAME() *string
func CfnSubnetNetworkAclAssociation_IsCfnElement ¶
func CfnSubnetNetworkAclAssociation_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 CfnSubnetNetworkAclAssociation_IsCfnResource ¶
func CfnSubnetNetworkAclAssociation_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnSubnetNetworkAclAssociation_IsConstruct ¶
func CfnSubnetNetworkAclAssociation_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 CfnSubnetRouteTableAssociation_CFN_RESOURCE_TYPE_NAME ¶
func CfnSubnetRouteTableAssociation_CFN_RESOURCE_TYPE_NAME() *string
func CfnSubnetRouteTableAssociation_IsCfnElement ¶
func CfnSubnetRouteTableAssociation_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 CfnSubnetRouteTableAssociation_IsCfnResource ¶
func CfnSubnetRouteTableAssociation_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnSubnetRouteTableAssociation_IsConstruct ¶
func CfnSubnetRouteTableAssociation_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 CfnSubnet_CFN_RESOURCE_TYPE_NAME ¶
func CfnSubnet_CFN_RESOURCE_TYPE_NAME() *string
func CfnSubnet_IsCfnElement ¶
func CfnSubnet_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 CfnSubnet_IsCfnResource ¶
func CfnSubnet_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnSubnet_IsConstruct ¶
func CfnSubnet_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 CfnTrafficMirrorFilterRule_CFN_RESOURCE_TYPE_NAME ¶
func CfnTrafficMirrorFilterRule_CFN_RESOURCE_TYPE_NAME() *string
func CfnTrafficMirrorFilterRule_IsCfnElement ¶
func CfnTrafficMirrorFilterRule_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 CfnTrafficMirrorFilterRule_IsCfnResource ¶
func CfnTrafficMirrorFilterRule_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnTrafficMirrorFilterRule_IsConstruct ¶
func CfnTrafficMirrorFilterRule_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 CfnTrafficMirrorFilter_CFN_RESOURCE_TYPE_NAME ¶
func CfnTrafficMirrorFilter_CFN_RESOURCE_TYPE_NAME() *string
func CfnTrafficMirrorFilter_IsCfnElement ¶
func CfnTrafficMirrorFilter_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 CfnTrafficMirrorFilter_IsCfnResource ¶
func CfnTrafficMirrorFilter_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnTrafficMirrorFilter_IsConstruct ¶
func CfnTrafficMirrorFilter_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 CfnTrafficMirrorSession_CFN_RESOURCE_TYPE_NAME ¶
func CfnTrafficMirrorSession_CFN_RESOURCE_TYPE_NAME() *string
func CfnTrafficMirrorSession_IsCfnElement ¶
func CfnTrafficMirrorSession_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 CfnTrafficMirrorSession_IsCfnResource ¶
func CfnTrafficMirrorSession_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnTrafficMirrorSession_IsConstruct ¶
func CfnTrafficMirrorSession_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 CfnTrafficMirrorTarget_CFN_RESOURCE_TYPE_NAME ¶
func CfnTrafficMirrorTarget_CFN_RESOURCE_TYPE_NAME() *string
func CfnTrafficMirrorTarget_IsCfnElement ¶
func CfnTrafficMirrorTarget_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 CfnTrafficMirrorTarget_IsCfnResource ¶
func CfnTrafficMirrorTarget_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnTrafficMirrorTarget_IsConstruct ¶
func CfnTrafficMirrorTarget_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 CfnTransitGatewayAttachment_CFN_RESOURCE_TYPE_NAME ¶
func CfnTransitGatewayAttachment_CFN_RESOURCE_TYPE_NAME() *string
func CfnTransitGatewayAttachment_IsCfnElement ¶
func CfnTransitGatewayAttachment_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 CfnTransitGatewayAttachment_IsCfnResource ¶
func CfnTransitGatewayAttachment_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnTransitGatewayAttachment_IsConstruct ¶
func CfnTransitGatewayAttachment_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 CfnTransitGatewayConnect_CFN_RESOURCE_TYPE_NAME ¶
func CfnTransitGatewayConnect_CFN_RESOURCE_TYPE_NAME() *string
func CfnTransitGatewayConnect_IsCfnElement ¶
func CfnTransitGatewayConnect_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 CfnTransitGatewayConnect_IsCfnResource ¶
func CfnTransitGatewayConnect_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnTransitGatewayConnect_IsConstruct ¶
func CfnTransitGatewayConnect_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 CfnTransitGatewayMulticastDomainAssociation_CFN_RESOURCE_TYPE_NAME ¶
func CfnTransitGatewayMulticastDomainAssociation_CFN_RESOURCE_TYPE_NAME() *string
func CfnTransitGatewayMulticastDomainAssociation_IsCfnElement ¶
func CfnTransitGatewayMulticastDomainAssociation_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 CfnTransitGatewayMulticastDomainAssociation_IsCfnResource ¶
func CfnTransitGatewayMulticastDomainAssociation_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnTransitGatewayMulticastDomainAssociation_IsConstruct ¶
func CfnTransitGatewayMulticastDomainAssociation_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 CfnTransitGatewayMulticastDomain_CFN_RESOURCE_TYPE_NAME ¶
func CfnTransitGatewayMulticastDomain_CFN_RESOURCE_TYPE_NAME() *string
func CfnTransitGatewayMulticastDomain_IsCfnElement ¶
func CfnTransitGatewayMulticastDomain_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 CfnTransitGatewayMulticastDomain_IsCfnResource ¶
func CfnTransitGatewayMulticastDomain_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnTransitGatewayMulticastDomain_IsConstruct ¶
func CfnTransitGatewayMulticastDomain_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 CfnTransitGatewayMulticastGroupMember_CFN_RESOURCE_TYPE_NAME ¶
func CfnTransitGatewayMulticastGroupMember_CFN_RESOURCE_TYPE_NAME() *string
func CfnTransitGatewayMulticastGroupMember_IsCfnElement ¶
func CfnTransitGatewayMulticastGroupMember_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 CfnTransitGatewayMulticastGroupMember_IsCfnResource ¶
func CfnTransitGatewayMulticastGroupMember_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnTransitGatewayMulticastGroupMember_IsConstruct ¶
func CfnTransitGatewayMulticastGroupMember_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 CfnTransitGatewayMulticastGroupSource_CFN_RESOURCE_TYPE_NAME ¶
func CfnTransitGatewayMulticastGroupSource_CFN_RESOURCE_TYPE_NAME() *string
func CfnTransitGatewayMulticastGroupSource_IsCfnElement ¶
func CfnTransitGatewayMulticastGroupSource_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 CfnTransitGatewayMulticastGroupSource_IsCfnResource ¶
func CfnTransitGatewayMulticastGroupSource_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnTransitGatewayMulticastGroupSource_IsConstruct ¶
func CfnTransitGatewayMulticastGroupSource_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 CfnTransitGatewayPeeringAttachment_CFN_RESOURCE_TYPE_NAME ¶
func CfnTransitGatewayPeeringAttachment_CFN_RESOURCE_TYPE_NAME() *string
func CfnTransitGatewayPeeringAttachment_IsCfnElement ¶
func CfnTransitGatewayPeeringAttachment_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 CfnTransitGatewayPeeringAttachment_IsCfnResource ¶
func CfnTransitGatewayPeeringAttachment_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnTransitGatewayPeeringAttachment_IsConstruct ¶
func CfnTransitGatewayPeeringAttachment_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 CfnTransitGatewayRouteTableAssociation_CFN_RESOURCE_TYPE_NAME ¶
func CfnTransitGatewayRouteTableAssociation_CFN_RESOURCE_TYPE_NAME() *string
func CfnTransitGatewayRouteTableAssociation_IsCfnElement ¶
func CfnTransitGatewayRouteTableAssociation_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 CfnTransitGatewayRouteTableAssociation_IsCfnResource ¶
func CfnTransitGatewayRouteTableAssociation_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnTransitGatewayRouteTableAssociation_IsConstruct ¶
func CfnTransitGatewayRouteTableAssociation_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 CfnTransitGatewayRouteTablePropagation_CFN_RESOURCE_TYPE_NAME ¶
func CfnTransitGatewayRouteTablePropagation_CFN_RESOURCE_TYPE_NAME() *string
func CfnTransitGatewayRouteTablePropagation_IsCfnElement ¶
func CfnTransitGatewayRouteTablePropagation_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 CfnTransitGatewayRouteTablePropagation_IsCfnResource ¶
func CfnTransitGatewayRouteTablePropagation_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnTransitGatewayRouteTablePropagation_IsConstruct ¶
func CfnTransitGatewayRouteTablePropagation_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 CfnTransitGatewayRouteTable_CFN_RESOURCE_TYPE_NAME ¶
func CfnTransitGatewayRouteTable_CFN_RESOURCE_TYPE_NAME() *string
func CfnTransitGatewayRouteTable_IsCfnElement ¶
func CfnTransitGatewayRouteTable_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 CfnTransitGatewayRouteTable_IsCfnResource ¶
func CfnTransitGatewayRouteTable_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnTransitGatewayRouteTable_IsConstruct ¶
func CfnTransitGatewayRouteTable_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 CfnTransitGatewayRoute_CFN_RESOURCE_TYPE_NAME ¶
func CfnTransitGatewayRoute_CFN_RESOURCE_TYPE_NAME() *string
func CfnTransitGatewayRoute_IsCfnElement ¶
func CfnTransitGatewayRoute_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 CfnTransitGatewayRoute_IsCfnResource ¶
func CfnTransitGatewayRoute_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnTransitGatewayRoute_IsConstruct ¶
func CfnTransitGatewayRoute_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 CfnTransitGatewayVpcAttachment_CFN_RESOURCE_TYPE_NAME ¶
func CfnTransitGatewayVpcAttachment_CFN_RESOURCE_TYPE_NAME() *string
func CfnTransitGatewayVpcAttachment_IsCfnElement ¶
func CfnTransitGatewayVpcAttachment_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 CfnTransitGatewayVpcAttachment_IsCfnResource ¶
func CfnTransitGatewayVpcAttachment_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnTransitGatewayVpcAttachment_IsConstruct ¶
func CfnTransitGatewayVpcAttachment_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 CfnTransitGateway_CFN_RESOURCE_TYPE_NAME ¶
func CfnTransitGateway_CFN_RESOURCE_TYPE_NAME() *string
func CfnTransitGateway_IsCfnElement ¶
func CfnTransitGateway_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 CfnTransitGateway_IsCfnResource ¶
func CfnTransitGateway_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnTransitGateway_IsConstruct ¶
func CfnTransitGateway_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 CfnVPCCidrBlock_CFN_RESOURCE_TYPE_NAME ¶
func CfnVPCCidrBlock_CFN_RESOURCE_TYPE_NAME() *string
func CfnVPCCidrBlock_IsCfnElement ¶
func CfnVPCCidrBlock_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 CfnVPCCidrBlock_IsCfnResource ¶
func CfnVPCCidrBlock_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnVPCCidrBlock_IsConstruct ¶
func CfnVPCCidrBlock_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 CfnVPCDHCPOptionsAssociation_CFN_RESOURCE_TYPE_NAME ¶
func CfnVPCDHCPOptionsAssociation_CFN_RESOURCE_TYPE_NAME() *string
func CfnVPCDHCPOptionsAssociation_IsCfnElement ¶
func CfnVPCDHCPOptionsAssociation_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 CfnVPCDHCPOptionsAssociation_IsCfnResource ¶
func CfnVPCDHCPOptionsAssociation_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnVPCDHCPOptionsAssociation_IsConstruct ¶
func CfnVPCDHCPOptionsAssociation_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 CfnVPCEndpointConnectionNotification_CFN_RESOURCE_TYPE_NAME ¶
func CfnVPCEndpointConnectionNotification_CFN_RESOURCE_TYPE_NAME() *string
func CfnVPCEndpointConnectionNotification_IsCfnElement ¶
func CfnVPCEndpointConnectionNotification_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 CfnVPCEndpointConnectionNotification_IsCfnResource ¶
func CfnVPCEndpointConnectionNotification_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnVPCEndpointConnectionNotification_IsConstruct ¶
func CfnVPCEndpointConnectionNotification_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 CfnVPCEndpointServicePermissions_CFN_RESOURCE_TYPE_NAME ¶
func CfnVPCEndpointServicePermissions_CFN_RESOURCE_TYPE_NAME() *string
func CfnVPCEndpointServicePermissions_IsCfnElement ¶
func CfnVPCEndpointServicePermissions_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 CfnVPCEndpointServicePermissions_IsCfnResource ¶
func CfnVPCEndpointServicePermissions_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnVPCEndpointServicePermissions_IsConstruct ¶
func CfnVPCEndpointServicePermissions_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 CfnVPCEndpointService_CFN_RESOURCE_TYPE_NAME ¶
func CfnVPCEndpointService_CFN_RESOURCE_TYPE_NAME() *string
func CfnVPCEndpointService_IsCfnElement ¶
func CfnVPCEndpointService_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 CfnVPCEndpointService_IsCfnResource ¶
func CfnVPCEndpointService_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnVPCEndpointService_IsConstruct ¶
func CfnVPCEndpointService_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 CfnVPCEndpoint_CFN_RESOURCE_TYPE_NAME ¶
func CfnVPCEndpoint_CFN_RESOURCE_TYPE_NAME() *string
func CfnVPCEndpoint_IsCfnElement ¶
func CfnVPCEndpoint_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 CfnVPCEndpoint_IsCfnResource ¶
func CfnVPCEndpoint_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnVPCEndpoint_IsConstruct ¶
func CfnVPCEndpoint_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 CfnVPCGatewayAttachment_CFN_RESOURCE_TYPE_NAME ¶
func CfnVPCGatewayAttachment_CFN_RESOURCE_TYPE_NAME() *string
func CfnVPCGatewayAttachment_IsCfnElement ¶
func CfnVPCGatewayAttachment_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 CfnVPCGatewayAttachment_IsCfnResource ¶
func CfnVPCGatewayAttachment_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnVPCGatewayAttachment_IsConstruct ¶
func CfnVPCGatewayAttachment_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 CfnVPCPeeringConnection_CFN_RESOURCE_TYPE_NAME ¶
func CfnVPCPeeringConnection_CFN_RESOURCE_TYPE_NAME() *string
func CfnVPCPeeringConnection_IsCfnElement ¶
func CfnVPCPeeringConnection_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 CfnVPCPeeringConnection_IsCfnResource ¶
func CfnVPCPeeringConnection_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnVPCPeeringConnection_IsConstruct ¶
func CfnVPCPeeringConnection_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 CfnVPC_CFN_RESOURCE_TYPE_NAME ¶
func CfnVPC_CFN_RESOURCE_TYPE_NAME() *string
func CfnVPC_IsCfnElement ¶
func CfnVPC_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 CfnVPC_IsCfnResource ¶
func CfnVPC_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnVPC_IsConstruct ¶
func CfnVPC_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 CfnVPNConnectionRoute_CFN_RESOURCE_TYPE_NAME ¶
func CfnVPNConnectionRoute_CFN_RESOURCE_TYPE_NAME() *string
func CfnVPNConnectionRoute_IsCfnElement ¶
func CfnVPNConnectionRoute_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 CfnVPNConnectionRoute_IsCfnResource ¶
func CfnVPNConnectionRoute_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnVPNConnectionRoute_IsConstruct ¶
func CfnVPNConnectionRoute_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 CfnVPNConnection_CFN_RESOURCE_TYPE_NAME ¶
func CfnVPNConnection_CFN_RESOURCE_TYPE_NAME() *string
func CfnVPNConnection_IsCfnElement ¶
func CfnVPNConnection_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 CfnVPNConnection_IsCfnResource ¶
func CfnVPNConnection_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnVPNConnection_IsConstruct ¶
func CfnVPNConnection_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 CfnVPNGatewayRoutePropagation_CFN_RESOURCE_TYPE_NAME ¶
func CfnVPNGatewayRoutePropagation_CFN_RESOURCE_TYPE_NAME() *string
func CfnVPNGatewayRoutePropagation_IsCfnElement ¶
func CfnVPNGatewayRoutePropagation_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 CfnVPNGatewayRoutePropagation_IsCfnResource ¶
func CfnVPNGatewayRoutePropagation_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnVPNGatewayRoutePropagation_IsConstruct ¶
func CfnVPNGatewayRoutePropagation_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 CfnVPNGateway_CFN_RESOURCE_TYPE_NAME ¶
func CfnVPNGateway_CFN_RESOURCE_TYPE_NAME() *string
func CfnVPNGateway_IsCfnElement ¶
func CfnVPNGateway_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 CfnVPNGateway_IsCfnResource ¶
func CfnVPNGateway_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnVPNGateway_IsConstruct ¶
func CfnVPNGateway_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 CfnVerifiedAccessEndpoint_CFN_RESOURCE_TYPE_NAME ¶ added in v2.80.0
func CfnVerifiedAccessEndpoint_CFN_RESOURCE_TYPE_NAME() *string
func CfnVerifiedAccessEndpoint_IsCfnElement ¶ added in v2.80.0
func CfnVerifiedAccessEndpoint_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 CfnVerifiedAccessEndpoint_IsCfnResource ¶ added in v2.80.0
func CfnVerifiedAccessEndpoint_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnVerifiedAccessEndpoint_IsConstruct ¶ added in v2.80.0
func CfnVerifiedAccessEndpoint_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 CfnVerifiedAccessGroup_CFN_RESOURCE_TYPE_NAME ¶ added in v2.80.0
func CfnVerifiedAccessGroup_CFN_RESOURCE_TYPE_NAME() *string
func CfnVerifiedAccessGroup_IsCfnElement ¶ added in v2.80.0
func CfnVerifiedAccessGroup_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 CfnVerifiedAccessGroup_IsCfnResource ¶ added in v2.80.0
func CfnVerifiedAccessGroup_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnVerifiedAccessGroup_IsConstruct ¶ added in v2.80.0
func CfnVerifiedAccessGroup_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 CfnVerifiedAccessInstance_CFN_RESOURCE_TYPE_NAME ¶ added in v2.79.0
func CfnVerifiedAccessInstance_CFN_RESOURCE_TYPE_NAME() *string
func CfnVerifiedAccessInstance_IsCfnElement ¶ added in v2.79.0
func CfnVerifiedAccessInstance_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 CfnVerifiedAccessInstance_IsCfnResource ¶ added in v2.79.0
func CfnVerifiedAccessInstance_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnVerifiedAccessInstance_IsConstruct ¶ added in v2.79.0
func CfnVerifiedAccessInstance_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 CfnVerifiedAccessTrustProvider_CFN_RESOURCE_TYPE_NAME ¶ added in v2.80.0
func CfnVerifiedAccessTrustProvider_CFN_RESOURCE_TYPE_NAME() *string
func CfnVerifiedAccessTrustProvider_IsCfnElement ¶ added in v2.80.0
func CfnVerifiedAccessTrustProvider_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 CfnVerifiedAccessTrustProvider_IsCfnResource ¶ added in v2.80.0
func CfnVerifiedAccessTrustProvider_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnVerifiedAccessTrustProvider_IsConstruct ¶ added in v2.80.0
func CfnVerifiedAccessTrustProvider_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 CfnVolumeAttachment_CFN_RESOURCE_TYPE_NAME ¶
func CfnVolumeAttachment_CFN_RESOURCE_TYPE_NAME() *string
func CfnVolumeAttachment_IsCfnElement ¶
func CfnVolumeAttachment_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 CfnVolumeAttachment_IsCfnResource ¶
func CfnVolumeAttachment_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnVolumeAttachment_IsConstruct ¶
func CfnVolumeAttachment_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 CfnVolume_CFN_RESOURCE_TYPE_NAME ¶
func CfnVolume_CFN_RESOURCE_TYPE_NAME() *string
func CfnVolume_IsCfnElement ¶
func CfnVolume_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 CfnVolume_IsCfnResource ¶
func CfnVolume_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnVolume_IsConstruct ¶
func CfnVolume_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 ClientVpnAuthorizationRule_IsConstruct ¶
func ClientVpnAuthorizationRule_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 ClientVpnAuthorizationRule_IsOwnedResource ¶ added in v2.32.0
func ClientVpnAuthorizationRule_IsOwnedResource(construct constructs.IConstruct) *bool
Returns true if the construct was created by CDK, and false otherwise.
func ClientVpnAuthorizationRule_IsResource ¶
func ClientVpnAuthorizationRule_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource.
func ClientVpnEndpoint_IsConstruct ¶
func ClientVpnEndpoint_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 ClientVpnEndpoint_IsOwnedResource ¶ added in v2.32.0
func ClientVpnEndpoint_IsOwnedResource(construct constructs.IConstruct) *bool
Returns true if the construct was created by CDK, and false otherwise.
func ClientVpnEndpoint_IsResource ¶
func ClientVpnEndpoint_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource.
func ClientVpnRoute_IsConstruct ¶
func ClientVpnRoute_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 ClientVpnRoute_IsOwnedResource ¶ added in v2.32.0
func ClientVpnRoute_IsOwnedResource(construct constructs.IConstruct) *bool
Returns true if the construct was created by CDK, and false otherwise.
func ClientVpnRoute_IsResource ¶
func ClientVpnRoute_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource.
func FlowLog_IsConstruct ¶
func FlowLog_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 FlowLog_IsOwnedResource ¶ added in v2.32.0
func FlowLog_IsOwnedResource(construct constructs.IConstruct) *bool
Returns true if the construct was created by CDK, and false otherwise.
func FlowLog_IsResource ¶
func FlowLog_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource.
func GatewayVpcEndpoint_IsConstruct ¶
func GatewayVpcEndpoint_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 GatewayVpcEndpoint_IsOwnedResource ¶ added in v2.32.0
func GatewayVpcEndpoint_IsOwnedResource(construct constructs.IConstruct) *bool
Returns true if the construct was created by CDK, and false otherwise.
func GatewayVpcEndpoint_IsResource ¶
func GatewayVpcEndpoint_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource.
func Instance_IsConstruct ¶
func Instance_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 Instance_IsOwnedResource ¶ added in v2.32.0
func Instance_IsOwnedResource(construct constructs.IConstruct) *bool
Returns true if the construct was created by CDK, and false otherwise.
func Instance_IsResource ¶
func Instance_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource.
func InterfaceVpcEndpoint_IsConstruct ¶
func InterfaceVpcEndpoint_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 InterfaceVpcEndpoint_IsOwnedResource ¶ added in v2.32.0
func InterfaceVpcEndpoint_IsOwnedResource(construct constructs.IConstruct) *bool
Returns true if the construct was created by CDK, and false otherwise.
func InterfaceVpcEndpoint_IsResource ¶
func InterfaceVpcEndpoint_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource.
func KeyPair_IsConstruct ¶ added in v2.116.0
func KeyPair_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 KeyPair_IsOwnedResource ¶ added in v2.116.0
func KeyPair_IsOwnedResource(construct constructs.IConstruct) *bool
Returns true if the construct was created by CDK, and false otherwise.
func KeyPair_IsResource ¶ added in v2.116.0
func KeyPair_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource.
func LaunchTemplateSpecialVersions_DEFAULT_VERSION ¶
func LaunchTemplateSpecialVersions_DEFAULT_VERSION() *string
func LaunchTemplateSpecialVersions_LATEST_VERSION ¶
func LaunchTemplateSpecialVersions_LATEST_VERSION() *string
func LaunchTemplate_IsConstruct ¶
func LaunchTemplate_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 LaunchTemplate_IsOwnedResource ¶ added in v2.32.0
func LaunchTemplate_IsOwnedResource(construct constructs.IConstruct) *bool
Returns true if the construct was created by CDK, and false otherwise.
func LaunchTemplate_IsResource ¶
func LaunchTemplate_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource.
func MultipartBody_CLOUD_BOOTHOOK ¶
func MultipartBody_CLOUD_BOOTHOOK() *string
func MultipartBody_SHELL_SCRIPT ¶
func MultipartBody_SHELL_SCRIPT() *string
func NatInstanceProviderV2_DEFAULT_USER_DATA_COMMANDS ¶ added in v2.137.0
func NatInstanceProviderV2_DEFAULT_USER_DATA_COMMANDS() *[]*string
func NetworkAclEntry_IsConstruct ¶
func NetworkAclEntry_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 NetworkAclEntry_IsOwnedResource ¶ added in v2.32.0
func NetworkAclEntry_IsOwnedResource(construct constructs.IConstruct) *bool
Returns true if the construct was created by CDK, and false otherwise.
func NetworkAclEntry_IsResource ¶
func NetworkAclEntry_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource.
func NetworkAcl_IsConstruct ¶
func NetworkAcl_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 NetworkAcl_IsOwnedResource ¶ added in v2.32.0
func NetworkAcl_IsOwnedResource(construct constructs.IConstruct) *bool
Returns true if the construct was created by CDK, and false otherwise.
func NetworkAcl_IsResource ¶
func NetworkAcl_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource.
func NewAclCidr_Override ¶
func NewAclCidr_Override(a AclCidr)
func NewAclTraffic_Override ¶
func NewAclTraffic_Override(a AclTraffic)
func NewAmazonLinux2022ImageSsmParameter_Override ¶ added in v2.76.0
func NewAmazonLinux2022ImageSsmParameter_Override(a AmazonLinux2022ImageSsmParameter, props *AmazonLinux2022ImageSsmParameterProps)
func NewAmazonLinux2022Kernel_Override ¶ added in v2.76.0
func NewAmazonLinux2022Kernel_Override(a AmazonLinux2022Kernel, version *string)
func NewAmazonLinux2023ImageSsmParameter_Override ¶ added in v2.76.0
func NewAmazonLinux2023ImageSsmParameter_Override(a AmazonLinux2023ImageSsmParameter, props *AmazonLinux2023ImageSsmParameterProps)
func NewAmazonLinux2023Kernel_Override ¶ added in v2.76.0
func NewAmazonLinux2023Kernel_Override(a AmazonLinux2023Kernel, version *string)
func NewAmazonLinux2ImageSsmParameter_Override ¶ added in v2.76.0
func NewAmazonLinux2ImageSsmParameter_Override(a AmazonLinux2ImageSsmParameter, props *AmazonLinux2ImageSsmParameterProps)
func NewAmazonLinux2Kernel_Override ¶ added in v2.76.0
func NewAmazonLinux2Kernel_Override(a AmazonLinux2Kernel, version *string)
func NewAmazonLinuxImageSsmParameterBase_Override ¶ added in v2.76.0
func NewAmazonLinuxImageSsmParameterBase_Override(a AmazonLinuxImageSsmParameterBase, props *AmazonLinuxImageSsmParameterBaseProps)
func NewAmazonLinuxImage_Override ¶
func NewAmazonLinuxImage_Override(a AmazonLinuxImage, props *AmazonLinuxImageProps)
func NewBastionHostLinux_Override ¶
func NewBastionHostLinux_Override(b BastionHostLinux, scope constructs.Construct, id *string, props *BastionHostLinuxProps)
func NewBlockDeviceVolume_Override ¶
func NewBlockDeviceVolume_Override(b BlockDeviceVolume, ebsDevice *EbsDeviceProps, virtualName *string)
func NewCfnCapacityReservationFleet_Override ¶
func NewCfnCapacityReservationFleet_Override(c CfnCapacityReservationFleet, scope constructs.Construct, id *string, props *CfnCapacityReservationFleetProps)
func NewCfnCapacityReservation_Override ¶
func NewCfnCapacityReservation_Override(c CfnCapacityReservation, scope constructs.Construct, id *string, props *CfnCapacityReservationProps)
func NewCfnCarrierGateway_Override ¶
func NewCfnCarrierGateway_Override(c CfnCarrierGateway, scope constructs.Construct, id *string, props *CfnCarrierGatewayProps)
func NewCfnClientVpnAuthorizationRule_Override ¶
func NewCfnClientVpnAuthorizationRule_Override(c CfnClientVpnAuthorizationRule, scope constructs.Construct, id *string, props *CfnClientVpnAuthorizationRuleProps)
func NewCfnClientVpnEndpoint_Override ¶
func NewCfnClientVpnEndpoint_Override(c CfnClientVpnEndpoint, scope constructs.Construct, id *string, props *CfnClientVpnEndpointProps)
func NewCfnClientVpnRoute_Override ¶
func NewCfnClientVpnRoute_Override(c CfnClientVpnRoute, scope constructs.Construct, id *string, props *CfnClientVpnRouteProps)
func NewCfnClientVpnTargetNetworkAssociation_Override ¶
func NewCfnClientVpnTargetNetworkAssociation_Override(c CfnClientVpnTargetNetworkAssociation, scope constructs.Construct, id *string, props *CfnClientVpnTargetNetworkAssociationProps)
func NewCfnCustomerGateway_Override ¶
func NewCfnCustomerGateway_Override(c CfnCustomerGateway, scope constructs.Construct, id *string, props *CfnCustomerGatewayProps)
func NewCfnDHCPOptions_Override ¶
func NewCfnDHCPOptions_Override(c CfnDHCPOptions, scope constructs.Construct, id *string, props *CfnDHCPOptionsProps)
func NewCfnEC2Fleet_Override ¶
func NewCfnEC2Fleet_Override(c CfnEC2Fleet, scope constructs.Construct, id *string, props *CfnEC2FleetProps)
func NewCfnEIPAssociation_Override ¶
func NewCfnEIPAssociation_Override(c CfnEIPAssociation, scope constructs.Construct, id *string, props *CfnEIPAssociationProps)
func NewCfnEIP_Override ¶
func NewCfnEIP_Override(c CfnEIP, scope constructs.Construct, id *string, props *CfnEIPProps)
func NewCfnEgressOnlyInternetGateway_Override ¶
func NewCfnEgressOnlyInternetGateway_Override(c CfnEgressOnlyInternetGateway, scope constructs.Construct, id *string, props *CfnEgressOnlyInternetGatewayProps)
func NewCfnEnclaveCertificateIamRoleAssociation_Override ¶
func NewCfnEnclaveCertificateIamRoleAssociation_Override(c CfnEnclaveCertificateIamRoleAssociation, scope constructs.Construct, id *string, props *CfnEnclaveCertificateIamRoleAssociationProps)
func NewCfnFlowLog_Override ¶
func NewCfnFlowLog_Override(c CfnFlowLog, scope constructs.Construct, id *string, props *CfnFlowLogProps)
func NewCfnGatewayRouteTableAssociation_Override ¶
func NewCfnGatewayRouteTableAssociation_Override(c CfnGatewayRouteTableAssociation, scope constructs.Construct, id *string, props *CfnGatewayRouteTableAssociationProps)
func NewCfnHost_Override ¶
func NewCfnHost_Override(c CfnHost, scope constructs.Construct, id *string, props *CfnHostProps)
func NewCfnIPAMAllocation_Override ¶ added in v2.2.0
func NewCfnIPAMAllocation_Override(c CfnIPAMAllocation, scope constructs.Construct, id *string, props *CfnIPAMAllocationProps)
func NewCfnIPAMPoolCidr_Override ¶ added in v2.64.0
func NewCfnIPAMPoolCidr_Override(c CfnIPAMPoolCidr, scope constructs.Construct, id *string, props *CfnIPAMPoolCidrProps)
func NewCfnIPAMPool_Override ¶ added in v2.2.0
func NewCfnIPAMPool_Override(c CfnIPAMPool, scope constructs.Construct, id *string, props *CfnIPAMPoolProps)
func NewCfnIPAMResourceDiscoveryAssociation_Override ¶ added in v2.64.0
func NewCfnIPAMResourceDiscoveryAssociation_Override(c CfnIPAMResourceDiscoveryAssociation, scope constructs.Construct, id *string, props *CfnIPAMResourceDiscoveryAssociationProps)
func NewCfnIPAMResourceDiscovery_Override ¶ added in v2.64.0
func NewCfnIPAMResourceDiscovery_Override(c CfnIPAMResourceDiscovery, scope constructs.Construct, id *string, props *CfnIPAMResourceDiscoveryProps)
func NewCfnIPAMScope_Override ¶ added in v2.2.0
func NewCfnIPAMScope_Override(c CfnIPAMScope, scope constructs.Construct, id *string, props *CfnIPAMScopeProps)
func NewCfnIPAM_Override ¶ added in v2.2.0
func NewCfnIPAM_Override(c CfnIPAM, scope constructs.Construct, id *string, props *CfnIPAMProps)
func NewCfnInstanceConnectEndpoint_Override ¶ added in v2.97.0
func NewCfnInstanceConnectEndpoint_Override(c CfnInstanceConnectEndpoint, scope constructs.Construct, id *string, props *CfnInstanceConnectEndpointProps)
func NewCfnInstance_Override ¶
func NewCfnInstance_Override(c CfnInstance, scope constructs.Construct, id *string, props *CfnInstanceProps)
func NewCfnInternetGateway_Override ¶
func NewCfnInternetGateway_Override(c CfnInternetGateway, scope constructs.Construct, id *string, props *CfnInternetGatewayProps)
func NewCfnKeyPair_Override ¶ added in v2.25.0
func NewCfnKeyPair_Override(c CfnKeyPair, scope constructs.Construct, id *string, props *CfnKeyPairProps)
func NewCfnLaunchTemplate_Override ¶
func NewCfnLaunchTemplate_Override(c CfnLaunchTemplate, scope constructs.Construct, id *string, props *CfnLaunchTemplateProps)
func NewCfnLocalGatewayRouteTableVPCAssociation_Override ¶
func NewCfnLocalGatewayRouteTableVPCAssociation_Override(c CfnLocalGatewayRouteTableVPCAssociation, scope constructs.Construct, id *string, props *CfnLocalGatewayRouteTableVPCAssociationProps)
func NewCfnLocalGatewayRouteTableVirtualInterfaceGroupAssociation_Override ¶ added in v2.70.0
func NewCfnLocalGatewayRouteTableVirtualInterfaceGroupAssociation_Override(c CfnLocalGatewayRouteTableVirtualInterfaceGroupAssociation, scope constructs.Construct, id *string, props *CfnLocalGatewayRouteTableVirtualInterfaceGroupAssociationProps)
func NewCfnLocalGatewayRouteTable_Override ¶ added in v2.70.0
func NewCfnLocalGatewayRouteTable_Override(c CfnLocalGatewayRouteTable, scope constructs.Construct, id *string, props *CfnLocalGatewayRouteTableProps)
func NewCfnLocalGatewayRoute_Override ¶
func NewCfnLocalGatewayRoute_Override(c CfnLocalGatewayRoute, scope constructs.Construct, id *string, props *CfnLocalGatewayRouteProps)
func NewCfnNatGateway_Override ¶
func NewCfnNatGateway_Override(c CfnNatGateway, scope constructs.Construct, id *string, props *CfnNatGatewayProps)
func NewCfnNetworkAclEntry_Override ¶
func NewCfnNetworkAclEntry_Override(c CfnNetworkAclEntry, scope constructs.Construct, id *string, props *CfnNetworkAclEntryProps)
func NewCfnNetworkAcl_Override ¶
func NewCfnNetworkAcl_Override(c CfnNetworkAcl, scope constructs.Construct, id *string, props *CfnNetworkAclProps)
func NewCfnNetworkInsightsAccessScopeAnalysis_Override ¶ added in v2.9.0
func NewCfnNetworkInsightsAccessScopeAnalysis_Override(c CfnNetworkInsightsAccessScopeAnalysis, scope constructs.Construct, id *string, props *CfnNetworkInsightsAccessScopeAnalysisProps)
func NewCfnNetworkInsightsAccessScope_Override ¶ added in v2.9.0
func NewCfnNetworkInsightsAccessScope_Override(c CfnNetworkInsightsAccessScope, scope constructs.Construct, id *string, props *CfnNetworkInsightsAccessScopeProps)
func NewCfnNetworkInsightsAnalysis_Override ¶
func NewCfnNetworkInsightsAnalysis_Override(c CfnNetworkInsightsAnalysis, scope constructs.Construct, id *string, props *CfnNetworkInsightsAnalysisProps)
func NewCfnNetworkInsightsPath_Override ¶
func NewCfnNetworkInsightsPath_Override(c CfnNetworkInsightsPath, scope constructs.Construct, id *string, props *CfnNetworkInsightsPathProps)
func NewCfnNetworkInterfaceAttachment_Override ¶
func NewCfnNetworkInterfaceAttachment_Override(c CfnNetworkInterfaceAttachment, scope constructs.Construct, id *string, props *CfnNetworkInterfaceAttachmentProps)
func NewCfnNetworkInterfacePermission_Override ¶
func NewCfnNetworkInterfacePermission_Override(c CfnNetworkInterfacePermission, scope constructs.Construct, id *string, props *CfnNetworkInterfacePermissionProps)
func NewCfnNetworkInterface_Override ¶
func NewCfnNetworkInterface_Override(c CfnNetworkInterface, scope constructs.Construct, id *string, props *CfnNetworkInterfaceProps)
func NewCfnNetworkPerformanceMetricSubscription_Override ¶ added in v2.55.0
func NewCfnNetworkPerformanceMetricSubscription_Override(c CfnNetworkPerformanceMetricSubscription, scope constructs.Construct, id *string, props *CfnNetworkPerformanceMetricSubscriptionProps)
func NewCfnPlacementGroup_Override ¶
func NewCfnPlacementGroup_Override(c CfnPlacementGroup, scope constructs.Construct, id *string, props *CfnPlacementGroupProps)
func NewCfnPrefixList_Override ¶
func NewCfnPrefixList_Override(c CfnPrefixList, scope constructs.Construct, id *string, props *CfnPrefixListProps)
func NewCfnRouteTable_Override ¶
func NewCfnRouteTable_Override(c CfnRouteTable, scope constructs.Construct, id *string, props *CfnRouteTableProps)
func NewCfnRoute_Override ¶
func NewCfnRoute_Override(c CfnRoute, scope constructs.Construct, id *string, props *CfnRouteProps)
func NewCfnSecurityGroupEgress_Override ¶
func NewCfnSecurityGroupEgress_Override(c CfnSecurityGroupEgress, scope constructs.Construct, id *string, props *CfnSecurityGroupEgressProps)
func NewCfnSecurityGroupIngress_Override ¶
func NewCfnSecurityGroupIngress_Override(c CfnSecurityGroupIngress, scope constructs.Construct, id *string, props *CfnSecurityGroupIngressProps)
func NewCfnSecurityGroup_Override ¶
func NewCfnSecurityGroup_Override(c CfnSecurityGroup, scope constructs.Construct, id *string, props *CfnSecurityGroupProps)
func NewCfnSnapshotBlockPublicAccess_Override ¶ added in v2.116.0
func NewCfnSnapshotBlockPublicAccess_Override(c CfnSnapshotBlockPublicAccess, scope constructs.Construct, id *string, props *CfnSnapshotBlockPublicAccessProps)
func NewCfnSpotFleet_Override ¶
func NewCfnSpotFleet_Override(c CfnSpotFleet, scope constructs.Construct, id *string, props *CfnSpotFleetProps)
func NewCfnSubnetCidrBlock_Override ¶
func NewCfnSubnetCidrBlock_Override(c CfnSubnetCidrBlock, scope constructs.Construct, id *string, props *CfnSubnetCidrBlockProps)
func NewCfnSubnetNetworkAclAssociation_Override ¶
func NewCfnSubnetNetworkAclAssociation_Override(c CfnSubnetNetworkAclAssociation, scope constructs.Construct, id *string, props *CfnSubnetNetworkAclAssociationProps)
func NewCfnSubnetRouteTableAssociation_Override ¶
func NewCfnSubnetRouteTableAssociation_Override(c CfnSubnetRouteTableAssociation, scope constructs.Construct, id *string, props *CfnSubnetRouteTableAssociationProps)
func NewCfnSubnet_Override ¶
func NewCfnSubnet_Override(c CfnSubnet, scope constructs.Construct, id *string, props *CfnSubnetProps)
func NewCfnTrafficMirrorFilterRule_Override ¶
func NewCfnTrafficMirrorFilterRule_Override(c CfnTrafficMirrorFilterRule, scope constructs.Construct, id *string, props *CfnTrafficMirrorFilterRuleProps)
func NewCfnTrafficMirrorFilter_Override ¶
func NewCfnTrafficMirrorFilter_Override(c CfnTrafficMirrorFilter, scope constructs.Construct, id *string, props *CfnTrafficMirrorFilterProps)
func NewCfnTrafficMirrorSession_Override ¶
func NewCfnTrafficMirrorSession_Override(c CfnTrafficMirrorSession, scope constructs.Construct, id *string, props *CfnTrafficMirrorSessionProps)
func NewCfnTrafficMirrorTarget_Override ¶
func NewCfnTrafficMirrorTarget_Override(c CfnTrafficMirrorTarget, scope constructs.Construct, id *string, props *CfnTrafficMirrorTargetProps)
func NewCfnTransitGatewayAttachment_Override ¶
func NewCfnTransitGatewayAttachment_Override(c CfnTransitGatewayAttachment, scope constructs.Construct, id *string, props *CfnTransitGatewayAttachmentProps)
func NewCfnTransitGatewayConnect_Override ¶
func NewCfnTransitGatewayConnect_Override(c CfnTransitGatewayConnect, scope constructs.Construct, id *string, props *CfnTransitGatewayConnectProps)
func NewCfnTransitGatewayMulticastDomainAssociation_Override ¶
func NewCfnTransitGatewayMulticastDomainAssociation_Override(c CfnTransitGatewayMulticastDomainAssociation, scope constructs.Construct, id *string, props *CfnTransitGatewayMulticastDomainAssociationProps)
func NewCfnTransitGatewayMulticastDomain_Override ¶
func NewCfnTransitGatewayMulticastDomain_Override(c CfnTransitGatewayMulticastDomain, scope constructs.Construct, id *string, props *CfnTransitGatewayMulticastDomainProps)
func NewCfnTransitGatewayMulticastGroupMember_Override ¶
func NewCfnTransitGatewayMulticastGroupMember_Override(c CfnTransitGatewayMulticastGroupMember, scope constructs.Construct, id *string, props *CfnTransitGatewayMulticastGroupMemberProps)
func NewCfnTransitGatewayMulticastGroupSource_Override ¶
func NewCfnTransitGatewayMulticastGroupSource_Override(c CfnTransitGatewayMulticastGroupSource, scope constructs.Construct, id *string, props *CfnTransitGatewayMulticastGroupSourceProps)
func NewCfnTransitGatewayPeeringAttachment_Override ¶
func NewCfnTransitGatewayPeeringAttachment_Override(c CfnTransitGatewayPeeringAttachment, scope constructs.Construct, id *string, props *CfnTransitGatewayPeeringAttachmentProps)
func NewCfnTransitGatewayRouteTableAssociation_Override ¶
func NewCfnTransitGatewayRouteTableAssociation_Override(c CfnTransitGatewayRouteTableAssociation, scope constructs.Construct, id *string, props *CfnTransitGatewayRouteTableAssociationProps)
func NewCfnTransitGatewayRouteTablePropagation_Override ¶
func NewCfnTransitGatewayRouteTablePropagation_Override(c CfnTransitGatewayRouteTablePropagation, scope constructs.Construct, id *string, props *CfnTransitGatewayRouteTablePropagationProps)
func NewCfnTransitGatewayRouteTable_Override ¶
func NewCfnTransitGatewayRouteTable_Override(c CfnTransitGatewayRouteTable, scope constructs.Construct, id *string, props *CfnTransitGatewayRouteTableProps)
func NewCfnTransitGatewayRoute_Override ¶
func NewCfnTransitGatewayRoute_Override(c CfnTransitGatewayRoute, scope constructs.Construct, id *string, props *CfnTransitGatewayRouteProps)
func NewCfnTransitGatewayVpcAttachment_Override ¶
func NewCfnTransitGatewayVpcAttachment_Override(c CfnTransitGatewayVpcAttachment, scope constructs.Construct, id *string, props *CfnTransitGatewayVpcAttachmentProps)
func NewCfnTransitGateway_Override ¶
func NewCfnTransitGateway_Override(c CfnTransitGateway, scope constructs.Construct, id *string, props *CfnTransitGatewayProps)
func NewCfnVPCCidrBlock_Override ¶
func NewCfnVPCCidrBlock_Override(c CfnVPCCidrBlock, scope constructs.Construct, id *string, props *CfnVPCCidrBlockProps)
func NewCfnVPCDHCPOptionsAssociation_Override ¶
func NewCfnVPCDHCPOptionsAssociation_Override(c CfnVPCDHCPOptionsAssociation, scope constructs.Construct, id *string, props *CfnVPCDHCPOptionsAssociationProps)
func NewCfnVPCEndpointConnectionNotification_Override ¶
func NewCfnVPCEndpointConnectionNotification_Override(c CfnVPCEndpointConnectionNotification, scope constructs.Construct, id *string, props *CfnVPCEndpointConnectionNotificationProps)
func NewCfnVPCEndpointServicePermissions_Override ¶
func NewCfnVPCEndpointServicePermissions_Override(c CfnVPCEndpointServicePermissions, scope constructs.Construct, id *string, props *CfnVPCEndpointServicePermissionsProps)
func NewCfnVPCEndpointService_Override ¶
func NewCfnVPCEndpointService_Override(c CfnVPCEndpointService, scope constructs.Construct, id *string, props *CfnVPCEndpointServiceProps)
func NewCfnVPCEndpoint_Override ¶
func NewCfnVPCEndpoint_Override(c CfnVPCEndpoint, scope constructs.Construct, id *string, props *CfnVPCEndpointProps)
func NewCfnVPCGatewayAttachment_Override ¶
func NewCfnVPCGatewayAttachment_Override(c CfnVPCGatewayAttachment, scope constructs.Construct, id *string, props *CfnVPCGatewayAttachmentProps)
func NewCfnVPCPeeringConnection_Override ¶
func NewCfnVPCPeeringConnection_Override(c CfnVPCPeeringConnection, scope constructs.Construct, id *string, props *CfnVPCPeeringConnectionProps)
func NewCfnVPC_Override ¶
func NewCfnVPC_Override(c CfnVPC, scope constructs.Construct, id *string, props *CfnVPCProps)
func NewCfnVPNConnectionRoute_Override ¶
func NewCfnVPNConnectionRoute_Override(c CfnVPNConnectionRoute, scope constructs.Construct, id *string, props *CfnVPNConnectionRouteProps)
func NewCfnVPNConnection_Override ¶
func NewCfnVPNConnection_Override(c CfnVPNConnection, scope constructs.Construct, id *string, props *CfnVPNConnectionProps)
func NewCfnVPNGatewayRoutePropagation_Override ¶
func NewCfnVPNGatewayRoutePropagation_Override(c CfnVPNGatewayRoutePropagation, scope constructs.Construct, id *string, props *CfnVPNGatewayRoutePropagationProps)
func NewCfnVPNGateway_Override ¶
func NewCfnVPNGateway_Override(c CfnVPNGateway, scope constructs.Construct, id *string, props *CfnVPNGatewayProps)
func NewCfnVerifiedAccessEndpoint_Override ¶ added in v2.80.0
func NewCfnVerifiedAccessEndpoint_Override(c CfnVerifiedAccessEndpoint, scope constructs.Construct, id *string, props *CfnVerifiedAccessEndpointProps)
func NewCfnVerifiedAccessGroup_Override ¶ added in v2.80.0
func NewCfnVerifiedAccessGroup_Override(c CfnVerifiedAccessGroup, scope constructs.Construct, id *string, props *CfnVerifiedAccessGroupProps)
func NewCfnVerifiedAccessInstance_Override ¶ added in v2.79.0
func NewCfnVerifiedAccessInstance_Override(c CfnVerifiedAccessInstance, scope constructs.Construct, id *string, props *CfnVerifiedAccessInstanceProps)
func NewCfnVerifiedAccessTrustProvider_Override ¶ added in v2.80.0
func NewCfnVerifiedAccessTrustProvider_Override(c CfnVerifiedAccessTrustProvider, scope constructs.Construct, id *string, props *CfnVerifiedAccessTrustProviderProps)
func NewCfnVolumeAttachment_Override ¶
func NewCfnVolumeAttachment_Override(c CfnVolumeAttachment, scope constructs.Construct, id *string, props *CfnVolumeAttachmentProps)
func NewCfnVolume_Override ¶
func NewCfnVolume_Override(c CfnVolume, scope constructs.Construct, id *string, props *CfnVolumeProps)
func NewClientVpnAuthorizationRule_Override ¶
func NewClientVpnAuthorizationRule_Override(c ClientVpnAuthorizationRule, scope constructs.Construct, id *string, props *ClientVpnAuthorizationRuleProps)
func NewClientVpnEndpoint_Override ¶
func NewClientVpnEndpoint_Override(c ClientVpnEndpoint, scope constructs.Construct, id *string, props *ClientVpnEndpointProps)
func NewClientVpnRouteTarget_Override ¶
func NewClientVpnRouteTarget_Override(c ClientVpnRouteTarget)
func NewClientVpnRoute_Override ¶
func NewClientVpnRoute_Override(c ClientVpnRoute, scope constructs.Construct, id *string, props *ClientVpnRouteProps)
func NewClientVpnUserBasedAuthentication_Override ¶
func NewClientVpnUserBasedAuthentication_Override(c ClientVpnUserBasedAuthentication)
func NewConnections_Override ¶
func NewConnections_Override(c Connections, props *ConnectionsProps)
func NewFlowLogDestination_Override ¶
func NewFlowLogDestination_Override(f FlowLogDestination)
func NewFlowLogResourceType_Override ¶
func NewFlowLogResourceType_Override(f FlowLogResourceType)
func NewFlowLog_Override ¶
func NewFlowLog_Override(f FlowLog, scope constructs.Construct, id *string, props *FlowLogProps)
func NewGatewayVpcEndpointAwsService_Override ¶
func NewGatewayVpcEndpointAwsService_Override(g GatewayVpcEndpointAwsService, name *string, prefix *string)
func NewGatewayVpcEndpoint_Override ¶
func NewGatewayVpcEndpoint_Override(g GatewayVpcEndpoint, scope constructs.Construct, id *string, props *GatewayVpcEndpointProps)
func NewGenericLinuxImage_Override ¶
func NewGenericLinuxImage_Override(g GenericLinuxImage, amiMap *map[string]*string, props *GenericLinuxImageProps)
func NewGenericSSMParameterImage_Override ¶
func NewGenericSSMParameterImage_Override(g GenericSSMParameterImage, parameterName *string, os OperatingSystemType, userData UserData)
func NewGenericWindowsImage_Override ¶
func NewGenericWindowsImage_Override(g GenericWindowsImage, amiMap *map[string]*string, props *GenericWindowsImageProps)
func NewInitCommandWaitDuration_Override ¶
func NewInitCommandWaitDuration_Override(i InitCommandWaitDuration)
func NewInitConfig_Override ¶
func NewInitConfig_Override(i InitConfig, elements *[]InitElement)
func NewInitElement_Override ¶
func NewInitElement_Override(i InitElement)
func NewInitFile_Override ¶
func NewInitFile_Override(i InitFile, fileName *string, options *InitFileOptions)
func NewInitGroup_Override ¶
func NewInitPackage_Override ¶
func NewInitPackage_Override(i InitPackage, type_ *string, versions *[]*string, packageName *string, serviceHandles *[]InitServiceRestartHandle)
func NewInitServiceRestartHandle_Override ¶
func NewInitServiceRestartHandle_Override(i InitServiceRestartHandle)
func NewInitSource_Override ¶
func NewInitSource_Override(i InitSource, targetDirectory *string, serviceHandles *[]InitServiceRestartHandle)
func NewInitUser_Override ¶
func NewInitUser_Override(i InitUser, userName *string, userOptions *InitUserOptions)
func NewInstanceRequireImdsv2Aspect_Override ¶
func NewInstanceRequireImdsv2Aspect_Override(i InstanceRequireImdsv2Aspect, props *InstanceRequireImdsv2AspectProps)
func NewInstanceType_Override ¶
func NewInstanceType_Override(i InstanceType, instanceTypeIdentifier *string)
func NewInstance_Override ¶
func NewInstance_Override(i Instance, scope constructs.Construct, id *string, props *InstanceProps)
func NewInterfaceVpcEndpointAwsService_Override ¶
func NewInterfaceVpcEndpointAwsService_Override(i InterfaceVpcEndpointAwsService, name *string, prefix *string, port *float64, props *InterfaceVpcEndpointAwsServiceProps)
func NewInterfaceVpcEndpointService_Override ¶
func NewInterfaceVpcEndpointService_Override(i InterfaceVpcEndpointService, name *string, port *float64)
func NewInterfaceVpcEndpoint_Override ¶
func NewInterfaceVpcEndpoint_Override(i InterfaceVpcEndpoint, scope constructs.Construct, id *string, props *InterfaceVpcEndpointProps)
func NewKeyPair_Override ¶ added in v2.116.0
func NewKeyPair_Override(k KeyPair, scope constructs.Construct, id *string, props *KeyPairProps)
func NewLaunchTemplateRequireImdsv2Aspect_Override ¶
func NewLaunchTemplateRequireImdsv2Aspect_Override(l LaunchTemplateRequireImdsv2Aspect, props *LaunchTemplateRequireImdsv2AspectProps)
func NewLaunchTemplateSpecialVersions_Override ¶
func NewLaunchTemplateSpecialVersions_Override(l LaunchTemplateSpecialVersions)
func NewLaunchTemplate_Override ¶
func NewLaunchTemplate_Override(l LaunchTemplate, scope constructs.Construct, id *string, props *LaunchTemplateProps)
func NewLogFormat_Override ¶ added in v2.51.0
func NewLookupMachineImage_Override ¶
func NewLookupMachineImage_Override(l LookupMachineImage, props *LookupMachineImageProps)
func NewMachineImage_Override ¶
func NewMachineImage_Override(m MachineImage)
func NewMultipartBody_Override ¶
func NewMultipartBody_Override(m MultipartBody)
func NewMultipartUserData_Override ¶
func NewMultipartUserData_Override(m MultipartUserData, opts *MultipartUserDataOptions)
func NewNatGatewayProvider_Override ¶ added in v2.151.0
func NewNatGatewayProvider_Override(n NatGatewayProvider, props *NatGatewayProps)
func NewNatInstanceImage_Override ¶
func NewNatInstanceImage_Override(n NatInstanceImage)
func NewNatInstanceProviderV2_Override ¶ added in v2.132.0
func NewNatInstanceProviderV2_Override(n NatInstanceProviderV2, props *NatInstanceProps)
func NewNatInstanceProvider_Override
deprecated
func NewNatInstanceProvider_Override(n NatInstanceProvider, props *NatInstanceProps)
Deprecated: use NatInstanceProviderV2. NatInstanceProvider is deprecated since the instance image used has reached EOL on Dec 31 2023.
func NewNatProvider_Override ¶
func NewNatProvider_Override(n NatProvider)
func NewNetworkAclEntry_Override ¶
func NewNetworkAclEntry_Override(n NetworkAclEntry, scope constructs.Construct, id *string, props *NetworkAclEntryProps)
func NewNetworkAcl_Override ¶
func NewNetworkAcl_Override(n NetworkAcl, scope constructs.Construct, id *string, props *NetworkAclProps)
func NewPeer_Override ¶
func NewPeer_Override(p Peer)
func NewPlacementGroup_Override ¶ added in v2.74.0
func NewPlacementGroup_Override(p PlacementGroup, scope constructs.Construct, id *string, props *PlacementGroupProps)
func NewPort_Override ¶
func NewPrefixList_Override ¶ added in v2.78.0
func NewPrefixList_Override(p PrefixList, scope constructs.Construct, id *string, props *PrefixListProps)
func NewPrivateSubnet_Override ¶
func NewPrivateSubnet_Override(p PrivateSubnet, scope constructs.Construct, id *string, props *PrivateSubnetProps)
func NewPublicSubnet_Override ¶
func NewPublicSubnet_Override(p PublicSubnet, scope constructs.Construct, id *string, props *PublicSubnetProps)
func NewResolveSsmParameterAtLaunchImage_Override ¶ added in v2.88.0
func NewResolveSsmParameterAtLaunchImage_Override(r ResolveSsmParameterAtLaunchImage, parameterName *string, props *SsmParameterImageOptions)
func NewSecurityGroup_Override ¶
func NewSecurityGroup_Override(s SecurityGroup, scope constructs.Construct, id *string, props *SecurityGroupProps)
func NewSubnetFilter_Override ¶
func NewSubnetFilter_Override(s SubnetFilter)
func NewSubnetNetworkAclAssociation_Override ¶
func NewSubnetNetworkAclAssociation_Override(s SubnetNetworkAclAssociation, scope constructs.Construct, id *string, props *SubnetNetworkAclAssociationProps)
func NewSubnet_Override ¶
func NewSubnet_Override(s Subnet, scope constructs.Construct, id *string, props *SubnetProps)
func NewUserData_Override ¶
func NewUserData_Override(u UserData)
func NewVolume_Override ¶
func NewVolume_Override(v Volume, scope constructs.Construct, id *string, props *VolumeProps)
func NewVpcEndpointService_Override ¶
func NewVpcEndpointService_Override(v VpcEndpointService, scope constructs.Construct, id *string, props *VpcEndpointServiceProps)
func NewVpcEndpoint_Override ¶
func NewVpcEndpoint_Override(v VpcEndpoint, scope constructs.Construct, id *string, props *awscdk.ResourceProps)
func NewVpc_Override ¶
Vpc creates a VPC that spans a whole region.
It will automatically divide the provided VPC CIDR range, and create public and private subnets per Availability Zone. Network routing for the public subnets will be configured to allow outbound access directly via an Internet Gateway. Network routing for the private subnets will be configured to allow outbound access via a set of resilient NAT Gateways (one per AZ).
func NewVpnConnectionBase_Override ¶ added in v2.43.0
func NewVpnConnectionBase_Override(v VpnConnectionBase, scope constructs.Construct, id *string, props *awscdk.ResourceProps)
func NewVpnConnection_Override ¶
func NewVpnConnection_Override(v VpnConnection, scope constructs.Construct, id *string, props *VpnConnectionProps)
func NewVpnGateway_Override ¶
func NewVpnGateway_Override(v VpnGateway, scope constructs.Construct, id *string, props *VpnGatewayProps)
func NewWindowsImage_Override ¶
func NewWindowsImage_Override(w WindowsImage, version WindowsVersion, props *WindowsImageProps)
func PlacementGroup_IsConstruct ¶ added in v2.74.0
func PlacementGroup_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 PlacementGroup_IsOwnedResource ¶ added in v2.74.0
func PlacementGroup_IsOwnedResource(construct constructs.IConstruct) *bool
Returns true if the construct was created by CDK, and false otherwise.
func PlacementGroup_IsResource ¶ added in v2.74.0
func PlacementGroup_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource.
func PrefixList_IsConstruct ¶ added in v2.78.0
func PrefixList_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 PrefixList_IsOwnedResource ¶ added in v2.78.0
func PrefixList_IsOwnedResource(construct constructs.IConstruct) *bool
Returns true if the construct was created by CDK, and false otherwise.
func PrefixList_IsResource ¶ added in v2.78.0
func PrefixList_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource.
func PrivateSubnet_IsConstruct ¶
func PrivateSubnet_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 PrivateSubnet_IsOwnedResource ¶ added in v2.32.0
func PrivateSubnet_IsOwnedResource(construct constructs.IConstruct) *bool
Returns true if the construct was created by CDK, and false otherwise.
func PrivateSubnet_IsResource ¶
func PrivateSubnet_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource.
func PrivateSubnet_IsVpcSubnet ¶
func PrivateSubnet_IsVpcSubnet(x interface{}) *bool
func PublicSubnet_IsConstruct ¶
func PublicSubnet_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 PublicSubnet_IsOwnedResource ¶ added in v2.32.0
func PublicSubnet_IsOwnedResource(construct constructs.IConstruct) *bool
Returns true if the construct was created by CDK, and false otherwise.
func PublicSubnet_IsResource ¶
func PublicSubnet_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource.
func PublicSubnet_IsVpcSubnet ¶
func PublicSubnet_IsVpcSubnet(x interface{}) *bool
func SecurityGroup_IsConstruct ¶
func SecurityGroup_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 SecurityGroup_IsOwnedResource ¶ added in v2.32.0
func SecurityGroup_IsOwnedResource(construct constructs.IConstruct) *bool
Returns true if the construct was created by CDK, and false otherwise.
func SecurityGroup_IsResource ¶
func SecurityGroup_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource.
func SecurityGroup_IsSecurityGroup ¶
func SecurityGroup_IsSecurityGroup(x interface{}) *bool
Return whether the indicated object is a security group.
func SubnetNetworkAclAssociation_IsConstruct ¶
func SubnetNetworkAclAssociation_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 SubnetNetworkAclAssociation_IsOwnedResource ¶ added in v2.32.0
func SubnetNetworkAclAssociation_IsOwnedResource(construct constructs.IConstruct) *bool
Returns true if the construct was created by CDK, and false otherwise.
func SubnetNetworkAclAssociation_IsResource ¶
func SubnetNetworkAclAssociation_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource.
func Subnet_IsConstruct ¶
func Subnet_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 Subnet_IsOwnedResource ¶ added in v2.32.0
func Subnet_IsOwnedResource(construct constructs.IConstruct) *bool
Returns true if the construct was created by CDK, and false otherwise.
func Subnet_IsResource ¶
func Subnet_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource.
func Subnet_IsVpcSubnet ¶
func Subnet_IsVpcSubnet(x interface{}) *bool
func Volume_IsConstruct ¶
func Volume_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 Volume_IsOwnedResource ¶ added in v2.32.0
func Volume_IsOwnedResource(construct constructs.IConstruct) *bool
Returns true if the construct was created by CDK, and false otherwise.
func Volume_IsResource ¶
func Volume_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource.
func VpcEndpointService_DEFAULT_PREFIX ¶ added in v2.150.0
func VpcEndpointService_DEFAULT_PREFIX() *string
func VpcEndpointService_IsConstruct ¶
func VpcEndpointService_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 VpcEndpointService_IsOwnedResource ¶ added in v2.32.0
func VpcEndpointService_IsOwnedResource(construct constructs.IConstruct) *bool
Returns true if the construct was created by CDK, and false otherwise.
func VpcEndpointService_IsResource ¶
func VpcEndpointService_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource.
func VpcEndpoint_IsConstruct ¶
func VpcEndpoint_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 VpcEndpoint_IsOwnedResource ¶ added in v2.32.0
func VpcEndpoint_IsOwnedResource(construct constructs.IConstruct) *bool
Returns true if the construct was created by CDK, and false otherwise.
func VpcEndpoint_IsResource ¶
func VpcEndpoint_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource.
func Vpc_DEFAULT_CIDR_RANGE ¶
func Vpc_DEFAULT_CIDR_RANGE() *string
func Vpc_DEFAULT_SUBNETS ¶
func Vpc_DEFAULT_SUBNETS() *[]*SubnetConfiguration
func Vpc_DEFAULT_SUBNETS_NO_NAT ¶
func Vpc_DEFAULT_SUBNETS_NO_NAT() *[]*SubnetConfiguration
func Vpc_IsConstruct ¶
func Vpc_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 Vpc_IsOwnedResource ¶ added in v2.32.0
func Vpc_IsOwnedResource(construct constructs.IConstruct) *bool
Returns true if the construct was created by CDK, and false otherwise.
func Vpc_IsResource ¶
func Vpc_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource.
func VpnConnectionBase_IsConstruct ¶ added in v2.43.0
func VpnConnectionBase_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 VpnConnectionBase_IsOwnedResource ¶ added in v2.43.0
func VpnConnectionBase_IsOwnedResource(construct constructs.IConstruct) *bool
Returns true if the construct was created by CDK, and false otherwise.
func VpnConnectionBase_IsResource ¶ added in v2.43.0
func VpnConnectionBase_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource.
func VpnConnection_IsConstruct ¶
func VpnConnection_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 VpnConnection_IsOwnedResource ¶ added in v2.32.0
func VpnConnection_IsOwnedResource(construct constructs.IConstruct) *bool
Returns true if the construct was created by CDK, and false otherwise.
func VpnConnection_IsResource ¶
func VpnConnection_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource.
func VpnConnection_MetricAll ¶
func VpnConnection_MetricAll(metricName *string, props *awscloudwatch.MetricOptions) awscloudwatch.Metric
Return the given named metric for all VPN connections in the account/region.
func VpnConnection_MetricAllTunnelDataIn ¶
func VpnConnection_MetricAllTunnelDataIn(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
Metric for the tunnel data in of all VPN connections in the account/region. Default: sum over 5 minutes.
func VpnConnection_MetricAllTunnelDataOut ¶
func VpnConnection_MetricAllTunnelDataOut(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
Metric for the tunnel data out of all VPN connections. Default: sum over 5 minutes.
func VpnConnection_MetricAllTunnelState ¶
func VpnConnection_MetricAllTunnelState(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
Metric for the tunnel state of all VPN connections in the account/region. Default: average over 5 minutes.
func VpnGateway_IsConstruct ¶
func VpnGateway_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 VpnGateway_IsOwnedResource ¶ added in v2.32.0
func VpnGateway_IsOwnedResource(construct constructs.IConstruct) *bool
Returns true if the construct was created by CDK, and false otherwise.
func VpnGateway_IsResource ¶
func VpnGateway_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource.
Types ¶
type AclCidr ¶
type AclCidr interface {
ToCidrConfig() *AclCidrConfig
}
Either an IPv4 or an IPv6 CIDR.
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" aclCidr := awscdk.Aws_ec2.AclCidr_AnyIpv4()
func AclCidr_AnyIpv4 ¶
func AclCidr_AnyIpv4() AclCidr
The CIDR containing all IPv4 addresses (i.e., 0.0.0.0/0).
func AclCidr_AnyIpv6 ¶
func AclCidr_AnyIpv6() AclCidr
The CIDR containing all IPv6 addresses (i.e., ::/0).
func AclCidr_Ipv4 ¶
An IP network range in CIDR notation (for example, 172.16.0.0/24).
func AclCidr_Ipv6 ¶
An IPv6 network range in CIDR notation (for example, 2001:db8::/48).
type AclCidrConfig ¶
type AclCidrConfig struct {
// Ipv4 CIDR.
CidrBlock *string `field:"optional" json:"cidrBlock" yaml:"cidrBlock"`
// Ipv6 CIDR.
Ipv6CidrBlock *string `field:"optional" json:"ipv6CidrBlock" yaml:"ipv6CidrBlock"`
}
Acl Configuration for CIDR.
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"
aclCidrConfig := &AclCidrConfig{
CidrBlock: jsii.String("cidrBlock"),
Ipv6CidrBlock: jsii.String("ipv6CidrBlock"),
}
type AclIcmp ¶
type AclIcmp struct {
// The Internet Control Message Protocol (ICMP) code.
//
// You can use -1 to specify all ICMP
// codes for the given ICMP type. Requirement is conditional: Required if you
// specify 1 (ICMP) for the protocol parameter.
Code *float64 `field:"optional" json:"code" yaml:"code"`
// The Internet Control Message Protocol (ICMP) type.
//
// You can use -1 to specify all ICMP types.
// Conditional requirement: Required if you specify 1 (ICMP) for the CreateNetworkAclEntry protocol parameter.
Type *float64 `field:"optional" json:"type" yaml:"type"`
}
Properties to create Icmp.
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"
aclIcmp := &AclIcmp{
Code: jsii.Number(123),
Type: jsii.Number(123),
}
type AclPortRange ¶
type AclPortRange struct {
// The first port in the range.
//
// Required if you specify 6 (TCP) or 17 (UDP) for the protocol parameter.
From *float64 `field:"optional" json:"from" yaml:"from"`
// The last port in the range.
//
// Required if you specify 6 (TCP) or 17 (UDP) for the protocol parameter.
To *float64 `field:"optional" json:"to" yaml:"to"`
}
Properties to create PortRange.
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"
aclPortRange := &AclPortRange{
From: jsii.Number(123),
To: jsii.Number(123),
}
type AclTraffic ¶
type AclTraffic interface {
ToTrafficConfig() *AclTrafficConfig
}
The traffic that is configured using a Network ACL entry.
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" aclTraffic := awscdk.Aws_ec2.AclTraffic_AllTraffic()
func AclTraffic_AllTraffic ¶
func AclTraffic_AllTraffic() AclTraffic
Apply the ACL entry to all traffic.
func AclTraffic_Icmp ¶
func AclTraffic_Icmp(props *AclIcmp) AclTraffic
Apply the ACL entry to ICMP traffic of given type and code.
func AclTraffic_Icmpv6 ¶
func AclTraffic_Icmpv6(props *AclIcmp) AclTraffic
Apply the ACL entry to ICMPv6 traffic of given type and code.
Requires an IPv6 CIDR block.
func AclTraffic_TcpPort ¶
func AclTraffic_TcpPort(port *float64) AclTraffic
Apply the ACL entry to TCP traffic on a given port.
func AclTraffic_TcpPortRange ¶
func AclTraffic_TcpPortRange(startPort *float64, endPort *float64) AclTraffic
Apply the ACL entry to TCP traffic on a given port range.
func AclTraffic_UdpPort ¶
func AclTraffic_UdpPort(port *float64) AclTraffic
Apply the ACL entry to UDP traffic on a given port.
func AclTraffic_UdpPortRange ¶
func AclTraffic_UdpPortRange(startPort *float64, endPort *float64) AclTraffic
Apply the ACL entry to UDP traffic on a given port range.
type AclTrafficConfig ¶
type AclTrafficConfig struct {
// The protocol number.
//
// A value of "-1" means all protocols.
//
// If you specify "-1" or a protocol number other than "6" (TCP), "17" (UDP),
// or "1" (ICMP), traffic on all ports is allowed, regardless of any ports or
// ICMP types or codes that you specify.
//
// If you specify protocol "58" (ICMPv6) and specify an IPv4 CIDR
// block, traffic for all ICMP types and codes allowed, regardless of any that
// you specify. If you specify protocol "58" (ICMPv6) and specify an IPv6 CIDR
// block, you must specify an ICMP type and code.
// Default: 17.
//
Protocol *float64 `field:"required" json:"protocol" yaml:"protocol"`
// The Internet Control Message Protocol (ICMP) code and type.
// Default: - Required if specifying 1 (ICMP) for the protocol parameter.
//
Icmp *AclIcmp `field:"optional" json:"icmp" yaml:"icmp"`
// The range of port numbers for the UDP/TCP protocol.
// Default: - Required if specifying 6 (TCP) or 17 (UDP) for the protocol parameter.
//
PortRange *AclPortRange `field:"optional" json:"portRange" yaml:"portRange"`
}
Acl Configuration for traffic.
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"
aclTrafficConfig := &AclTrafficConfig{
Protocol: jsii.Number(123),
// the properties below are optional
Icmp: &AclIcmp{
Code: jsii.Number(123),
Type: jsii.Number(123),
},
PortRange: &AclPortRange{
From: jsii.Number(123),
To: jsii.Number(123),
},
}
type AddRouteOptions ¶
type AddRouteOptions struct {
// The ID of the router.
//
// Can be an instance ID, gateway ID, etc, depending on the router type.
RouterId *string `field:"required" json:"routerId" yaml:"routerId"`
// What type of router to route this traffic to.
RouterType RouterType `field:"required" json:"routerType" yaml:"routerType"`
// IPv4 range this route applies to.
// Default: '0.0.0.0/0'
//
DestinationCidrBlock *string `field:"optional" json:"destinationCidrBlock" yaml:"destinationCidrBlock"`
// IPv6 range this route applies to.
// Default: - Uses IPv6.
//
DestinationIpv6CidrBlock *string `field:"optional" json:"destinationIpv6CidrBlock" yaml:"destinationIpv6CidrBlock"`
// Whether this route will enable internet connectivity.
//
// If true, this route will be added before any AWS resources that depend
// on internet connectivity in the VPC will be created.
// Default: false.
//
EnablesInternetConnectivity *bool `field:"optional" json:"enablesInternetConnectivity" yaml:"enablesInternetConnectivity"`
}
Options for adding a new route to a subnet.
Example:
vpc := ec2.NewVpc(this, jsii.String("VPC"), &VpcProps{
SubnetConfiguration: []subnetConfiguration{
&subnetConfiguration{
SubnetType: ec2.SubnetType_PUBLIC,
Name: jsii.String("Public"),
},
&subnetConfiguration{
SubnetType: ec2.SubnetType_PRIVATE_ISOLATED,
Name: jsii.String("Isolated"),
},
},
})
(vpc.IsolatedSubnets[0].(subnet)).AddRoute(jsii.String("StaticRoute"), &AddRouteOptions{
RouterId: vpc.InternetGatewayId,
RouterType: ec2.RouterType_GATEWAY,
DestinationCidrBlock: jsii.String("8.8.8.8/32"),
})
type AddressFamily ¶ added in v2.78.0
type AddressFamily string
The IP address type.
const ( AddressFamily_IP_V4 AddressFamily = "IP_V4" AddressFamily_IP_V6 AddressFamily = "IP_V6" )
type AllocateCidrRequest ¶ added in v2.48.0
type AllocateCidrRequest struct {
// The Subnets to be allocated.
RequestedSubnets *[]*RequestedSubnet `field:"required" json:"requestedSubnets" yaml:"requestedSubnets"`
// The IPv4 CIDR block for this Vpc.
VpcCidr *string `field:"required" json:"vpcCidr" yaml:"vpcCidr"`
}
Request for subnets CIDR to be allocated for a Vpc.
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"
allocateCidrRequest := &AllocateCidrRequest{
RequestedSubnets: []requestedSubnet{
&requestedSubnet{
AvailabilityZone: jsii.String("availabilityZone"),
Configuration: &SubnetConfiguration{
Name: jsii.String("name"),
SubnetType: awscdk.Aws_ec2.SubnetType_PRIVATE_ISOLATED,
// the properties below are optional
CidrMask: jsii.Number(123),
Ipv6AssignAddressOnCreation: jsii.Boolean(false),
MapPublicIpOnLaunch: jsii.Boolean(false),
Reserved: jsii.Boolean(false),
},
SubnetConstructId: jsii.String("subnetConstructId"),
},
},
VpcCidr: jsii.String("vpcCidr"),
}
type AllocateIpv6CidrRequest ¶ added in v2.121.0
type AllocateIpv6CidrRequest struct {
// List of subnets allocated with IPv4 CIDRs.
AllocatedSubnets *[]*AllocatedSubnet `field:"required" json:"allocatedSubnets" yaml:"allocatedSubnets"`
// The IPv6 CIDRs to be allocated to the subnets.
Ipv6Cidrs *[]*string `field:"required" json:"ipv6Cidrs" yaml:"ipv6Cidrs"`
}
Request for subnet IPv6 CIDRs to be allocated for a VPC.
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"
allocateIpv6CidrRequest := &AllocateIpv6CidrRequest{
AllocatedSubnets: []allocatedSubnet{
&allocatedSubnet{
Cidr: jsii.String("cidr"),
// the properties below are optional
Ipv6Cidr: jsii.String("ipv6Cidr"),
},
},
Ipv6Cidrs: []*string{
jsii.String("ipv6Cidrs"),
},
}
type AllocateVpcIpv6CidrRequest ¶ added in v2.121.0
type AllocateVpcIpv6CidrRequest struct {
// The VPC construct to attach to.
Scope constructs.Construct `field:"required" json:"scope" yaml:"scope"`
// The id of the VPC.
VpcId *string `field:"required" json:"vpcId" yaml:"vpcId"`
}
Request for allocation of the VPC IPv6 CIDR.
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"
import constructs "github.com/aws/constructs-go/constructs"
var construct construct
allocateVpcIpv6CidrRequest := &AllocateVpcIpv6CidrRequest{
Scope: construct,
VpcId: jsii.String("vpcId"),
}
type AllocatedSubnet ¶ added in v2.48.0
type AllocatedSubnet struct {
// IPv4 CIDR Allocations for a Subnet.
//
// Note this is specific to the IPv4 CIDR.
Cidr *string `field:"required" json:"cidr" yaml:"cidr"`
// IPv6 CIDR Allocations for a Subnet.
//
// Note this is specific to the IPv6 CIDR.
// Default: - no IPV6 CIDR.
//
Ipv6Cidr *string `field:"optional" json:"ipv6Cidr" yaml:"ipv6Cidr"`
}
CIDR Allocated Subnet.
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"
allocatedSubnet := &AllocatedSubnet{
Cidr: jsii.String("cidr"),
// the properties below are optional
Ipv6Cidr: jsii.String("ipv6Cidr"),
}
type AmazonLinux2022ImageSsmParameter ¶ added in v2.76.0
type AmazonLinux2022ImageSsmParameter interface {
AmazonLinuxImageSsmParameterBase
// Return the image to use in the given context.
GetImage(scope constructs.Construct) *MachineImageConfig
}
A SSM Parameter that contains the AMI ID for Amazon Linux 2023.
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"
var amazonLinux2022Kernel amazonLinux2022Kernel
var userData userData
amazonLinux2022ImageSsmParameter := awscdk.Aws_ec2.NewAmazonLinux2022ImageSsmParameter(&AmazonLinux2022ImageSsmParameterProps{
CachedInContext: jsii.Boolean(false),
CpuType: awscdk.*Aws_ec2.AmazonLinuxCpuType_ARM_64,
Edition: awscdk.*Aws_ec2.AmazonLinuxEdition_STANDARD,
Kernel: amazonLinux2022Kernel,
UserData: userData,
})
func NewAmazonLinux2022ImageSsmParameter ¶ added in v2.76.0
func NewAmazonLinux2022ImageSsmParameter(props *AmazonLinux2022ImageSsmParameterProps) AmazonLinux2022ImageSsmParameter
type AmazonLinux2022ImageSsmParameterProps ¶ added in v2.76.0
type AmazonLinux2022ImageSsmParameterProps struct {
// Whether the AMI ID is cached to be stable between deployments.
//
// By default, the newest image is used on each deployment. This will cause
// instances to be replaced whenever a new version is released, and may cause
// downtime if there aren't enough running instances in the AutoScalingGroup
// to reschedule the tasks on.
//
// If set to true, the AMI ID will be cached in `cdk.context.json` and the
// same value will be used on future runs. Your instances will not be replaced
// but your AMI version will grow old over time. To refresh the AMI lookup,
// you will have to evict the value from the cache using the `cdk context`
// command. See https://docs.aws.amazon.com/cdk/latest/guide/context.html for
// more information.
//
// Can not be set to `true` in environment-agnostic stacks.
// Default: false.
//
CachedInContext *bool `field:"optional" json:"cachedInContext" yaml:"cachedInContext"`
// Initial user data.
// Default: - Empty UserData for Linux machines.
//
UserData UserData `field:"optional" json:"userData" yaml:"userData"`
// CPU Type.
// Default: AmazonLinuxCpuType.X86_64
//
CpuType AmazonLinuxCpuType `field:"optional" json:"cpuType" yaml:"cpuType"`
// What edition of Amazon Linux to use.
// Default: AmazonLinuxEdition.Standard
//
Edition AmazonLinuxEdition `field:"optional" json:"edition" yaml:"edition"`
// What kernel version of Amazon Linux to use.
// Default: AmazonLinux2022Kernel.DEFAULT
//
Kernel AmazonLinux2022Kernel `field:"optional" json:"kernel" yaml:"kernel"`
}
Properties specific to al2022 images.
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"
var amazonLinux2022Kernel amazonLinux2022Kernel
var userData userData
amazonLinux2022ImageSsmParameterProps := &AmazonLinux2022ImageSsmParameterProps{
CachedInContext: jsii.Boolean(false),
CpuType: awscdk.Aws_ec2.AmazonLinuxCpuType_ARM_64,
Edition: awscdk.*Aws_ec2.AmazonLinuxEdition_STANDARD,
Kernel: amazonLinux2022Kernel,
UserData: userData,
}
type AmazonLinux2022Kernel ¶ added in v2.76.0
type AmazonLinux2022Kernel interface {
// Generate a string representation of the kernel.
ToString() *string
}
Amazon Linux 2022 kernel versions.
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" amazonLinux2022Kernel := awscdk.Aws_ec2.AmazonLinux2022Kernel_CDK_LATEST()
func AmazonLinux2022Kernel_CDK_LATEST ¶ added in v2.76.0
func AmazonLinux2022Kernel_CDK_LATEST() AmazonLinux2022Kernel
func AmazonLinux2022Kernel_DEFAULT ¶ added in v2.76.0
func AmazonLinux2022Kernel_DEFAULT() AmazonLinux2022Kernel
func AmazonLinux2022Kernel_KERNEL_5_15 ¶ added in v2.76.0
func AmazonLinux2022Kernel_KERNEL_5_15() AmazonLinux2022Kernel
func NewAmazonLinux2022Kernel ¶ added in v2.76.0
func NewAmazonLinux2022Kernel(version *string) AmazonLinux2022Kernel
type AmazonLinux2023ImageSsmParameter ¶ added in v2.76.0
type AmazonLinux2023ImageSsmParameter interface {
AmazonLinuxImageSsmParameterBase
// Return the image to use in the given context.
GetImage(scope constructs.Construct) *MachineImageConfig
}
A SSM Parameter that contains the AMI ID for Amazon Linux 2023.
Example:
var vpc vpc
ec2.NewInstance(this, jsii.String("LatestAl2023"), &InstanceProps{
Vpc: Vpc,
InstanceType: ec2.InstanceType_Of(ec2.InstanceClass_C7G, ec2.InstanceSize_LARGE),
MachineImage: ec2.MachineImage_LatestAmazonLinux2023(&AmazonLinux2023ImageSsmParameterProps{
CachedInContext: jsii.Boolean(true),
}),
})
// or
// or
ec2.NewInstance(this, jsii.String("LatestAl2023"), &InstanceProps{
Vpc: Vpc,
InstanceType: ec2.InstanceType_*Of(ec2.InstanceClass_C7G, ec2.InstanceSize_LARGE),
// context cache is turned on by default
MachineImage: ec2.NewAmazonLinux2023ImageSsmParameter(),
})
func NewAmazonLinux2023ImageSsmParameter ¶ added in v2.76.0
func NewAmazonLinux2023ImageSsmParameter(props *AmazonLinux2023ImageSsmParameterProps) AmazonLinux2023ImageSsmParameter
type AmazonLinux2023ImageSsmParameterProps ¶ added in v2.76.0
type AmazonLinux2023ImageSsmParameterProps struct {
// Whether the AMI ID is cached to be stable between deployments.
//
// By default, the newest image is used on each deployment. This will cause
// instances to be replaced whenever a new version is released, and may cause
// downtime if there aren't enough running instances in the AutoScalingGroup
// to reschedule the tasks on.
//
// If set to true, the AMI ID will be cached in `cdk.context.json` and the
// same value will be used on future runs. Your instances will not be replaced
// but your AMI version will grow old over time. To refresh the AMI lookup,
// you will have to evict the value from the cache using the `cdk context`
// command. See https://docs.aws.amazon.com/cdk/latest/guide/context.html for
// more information.
//
// Can not be set to `true` in environment-agnostic stacks.
// Default: false.
//
CachedInContext *bool `field:"optional" json:"cachedInContext" yaml:"cachedInContext"`
// Initial user data.
// Default: - Empty UserData for Linux machines.
//
UserData UserData `field:"optional" json:"userData" yaml:"userData"`
// CPU Type.
// Default: AmazonLinuxCpuType.X86_64
//
CpuType AmazonLinuxCpuType `field:"optional" json:"cpuType" yaml:"cpuType"`
// What edition of Amazon Linux to use.
// Default: AmazonLinuxEdition.Standard
//
Edition AmazonLinuxEdition `field:"optional" json:"edition" yaml:"edition"`
// What kernel version of Amazon Linux to use.
// Default: AmazonLinux2023Kernel.DEFAULT
//
Kernel AmazonLinux2023Kernel `field:"optional" json:"kernel" yaml:"kernel"`
}
Properties specific to al2023 images.
Example:
var vpc vpc
ec2.NewInstance(this, jsii.String("LatestAl2023"), &InstanceProps{
Vpc: Vpc,
InstanceType: ec2.InstanceType_Of(ec2.InstanceClass_C7G, ec2.InstanceSize_LARGE),
MachineImage: ec2.MachineImage_LatestAmazonLinux2023(&AmazonLinux2023ImageSsmParameterProps{
CachedInContext: jsii.Boolean(true),
}),
})
// or
// or
ec2.NewInstance(this, jsii.String("LatestAl2023"), &InstanceProps{
Vpc: Vpc,
InstanceType: ec2.InstanceType_*Of(ec2.InstanceClass_C7G, ec2.InstanceSize_LARGE),
// context cache is turned on by default
MachineImage: ec2.NewAmazonLinux2023ImageSsmParameter(),
})
type AmazonLinux2023Kernel ¶ added in v2.76.0
type AmazonLinux2023Kernel interface {
// Generate a string representation of the kernel.
ToString() *string
}
Amazon Linux 2023 kernel versions.
Example:
var vpc vpc
ec2.NewInstance(this, jsii.String("LatestAl2023"), &InstanceProps{
Vpc: Vpc,
InstanceType: ec2.InstanceType_Of(ec2.InstanceClass_C7G, ec2.InstanceSize_LARGE),
// context cache is turned on by default
MachineImage: ec2.NewAmazonLinux2023ImageSsmParameter(&AmazonLinux2023ImageSsmParameterProps{
Kernel: ec2.AmazonLinux2023Kernel_KERNEL_6_1(),
}),
})
func AmazonLinux2023Kernel_CDK_LATEST ¶ added in v2.76.0
func AmazonLinux2023Kernel_CDK_LATEST() AmazonLinux2023Kernel
func AmazonLinux2023Kernel_DEFAULT ¶ added in v2.76.0
func AmazonLinux2023Kernel_DEFAULT() AmazonLinux2023Kernel
func AmazonLinux2023Kernel_KERNEL_6_1 ¶ added in v2.76.0
func AmazonLinux2023Kernel_KERNEL_6_1() AmazonLinux2023Kernel
func NewAmazonLinux2023Kernel ¶ added in v2.76.0
func NewAmazonLinux2023Kernel(version *string) AmazonLinux2023Kernel
type AmazonLinux2ImageSsmParameter ¶ added in v2.76.0
type AmazonLinux2ImageSsmParameter interface {
AmazonLinuxImageSsmParameterBase
// Return the image to use in the given context.
GetImage(scope constructs.Construct) *MachineImageConfig
}
A SSM Parameter that contains the AMI ID for Amazon Linux 2.
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"
var amazonLinux2Kernel amazonLinux2Kernel
var userData userData
amazonLinux2ImageSsmParameter := awscdk.Aws_ec2.NewAmazonLinux2ImageSsmParameter(&AmazonLinux2ImageSsmParameterProps{
CachedInContext: jsii.Boolean(false),
CpuType: awscdk.*Aws_ec2.AmazonLinuxCpuType_ARM_64,
Edition: awscdk.*Aws_ec2.AmazonLinuxEdition_STANDARD,
Kernel: amazonLinux2Kernel,
Storage: awscdk.*Aws_ec2.AmazonLinuxStorage_EBS,
UserData: userData,
Virtualization: awscdk.*Aws_ec2.AmazonLinuxVirt_HVM,
})
func NewAmazonLinux2ImageSsmParameter ¶ added in v2.76.0
func NewAmazonLinux2ImageSsmParameter(props *AmazonLinux2ImageSsmParameterProps) AmazonLinux2ImageSsmParameter
type AmazonLinux2ImageSsmParameterProps ¶ added in v2.76.0
type AmazonLinux2ImageSsmParameterProps struct {
// Whether the AMI ID is cached to be stable between deployments.
//
// By default, the newest image is used on each deployment. This will cause
// instances to be replaced whenever a new version is released, and may cause
// downtime if there aren't enough running instances in the AutoScalingGroup
// to reschedule the tasks on.
//
// If set to true, the AMI ID will be cached in `cdk.context.json` and the
// same value will be used on future runs. Your instances will not be replaced
// but your AMI version will grow old over time. To refresh the AMI lookup,
// you will have to evict the value from the cache using the `cdk context`
// command. See https://docs.aws.amazon.com/cdk/latest/guide/context.html for
// more information.
//
// Can not be set to `true` in environment-agnostic stacks.
// Default: false.
//
CachedInContext *bool `field:"optional" json:"cachedInContext" yaml:"cachedInContext"`
// Initial user data.
// Default: - Empty UserData for Linux machines.
//
UserData UserData `field:"optional" json:"userData" yaml:"userData"`
// CPU Type.
// Default: AmazonLinuxCpuType.X86_64
//
CpuType AmazonLinuxCpuType `field:"optional" json:"cpuType" yaml:"cpuType"`
// What edition of Amazon Linux to use.
// Default: AmazonLinuxEdition.Standard
//
Edition AmazonLinuxEdition `field:"optional" json:"edition" yaml:"edition"`
// What kernel version of Amazon Linux to use.
// Default: -.
//
Kernel AmazonLinux2Kernel `field:"optional" json:"kernel" yaml:"kernel"`
// What storage backed image to use.
// Default: GeneralPurpose.
//
Storage AmazonLinuxStorage `field:"optional" json:"storage" yaml:"storage"`
// Virtualization type.
// Default: HVM.
//
Virtualization AmazonLinuxVirt `field:"optional" json:"virtualization" yaml:"virtualization"`
}
Properties specific to amzn2 images.
Example:
var vpc vpc
var instanceType instanceType
// Amazon Linux 2
// Amazon Linux 2
ec2.NewInstance(this, jsii.String("Instance2"), &InstanceProps{
Vpc: Vpc,
InstanceType: InstanceType,
MachineImage: ec2.MachineImage_LatestAmazonLinux2(),
})
// Amazon Linux 2 with kernel 5.x
// Amazon Linux 2 with kernel 5.x
ec2.NewInstance(this, jsii.String("Instance3"), &InstanceProps{
Vpc: Vpc,
InstanceType: InstanceType,
MachineImage: ec2.MachineImage_*LatestAmazonLinux2(&AmazonLinux2ImageSsmParameterProps{
Kernel: ec2.AmazonLinux2Kernel_KERNEL_5_10(),
}),
})
// Amazon Linux 2023
// Amazon Linux 2023
ec2.NewInstance(this, jsii.String("Instance4"), &InstanceProps{
Vpc: Vpc,
InstanceType: InstanceType,
MachineImage: ec2.MachineImage_LatestAmazonLinux2023(),
})
// Graviton 3 Processor
// Graviton 3 Processor
ec2.NewInstance(this, jsii.String("Instance5"), &InstanceProps{
Vpc: Vpc,
InstanceType: ec2.*instanceType_Of(ec2.InstanceClass_C7G, ec2.InstanceSize_LARGE),
MachineImage: ec2.MachineImage_*LatestAmazonLinux2023(&AmazonLinux2023ImageSsmParameterProps{
CpuType: ec2.AmazonLinuxCpuType_ARM_64,
}),
})
type AmazonLinux2Kernel ¶ added in v2.76.0
type AmazonLinux2Kernel interface {
// Generate a string representation of the kernel.
ToString() *string
}
Amazon Linux 2 kernel versions.
Example:
var vpc vpc
var instanceType instanceType
// Amazon Linux 2
// Amazon Linux 2
ec2.NewInstance(this, jsii.String("Instance2"), &InstanceProps{
Vpc: Vpc,
InstanceType: InstanceType,
MachineImage: ec2.MachineImage_LatestAmazonLinux2(),
})
// Amazon Linux 2 with kernel 5.x
// Amazon Linux 2 with kernel 5.x
ec2.NewInstance(this, jsii.String("Instance3"), &InstanceProps{
Vpc: Vpc,
InstanceType: InstanceType,
MachineImage: ec2.MachineImage_*LatestAmazonLinux2(&AmazonLinux2ImageSsmParameterProps{
Kernel: ec2.AmazonLinux2Kernel_KERNEL_5_10(),
}),
})
// Amazon Linux 2023
// Amazon Linux 2023
ec2.NewInstance(this, jsii.String("Instance4"), &InstanceProps{
Vpc: Vpc,
InstanceType: InstanceType,
MachineImage: ec2.MachineImage_LatestAmazonLinux2023(),
})
// Graviton 3 Processor
// Graviton 3 Processor
ec2.NewInstance(this, jsii.String("Instance5"), &InstanceProps{
Vpc: Vpc,
InstanceType: ec2.*instanceType_Of(ec2.InstanceClass_C7G, ec2.InstanceSize_LARGE),
MachineImage: ec2.MachineImage_*LatestAmazonLinux2023(&AmazonLinux2023ImageSsmParameterProps{
CpuType: ec2.AmazonLinuxCpuType_ARM_64,
}),
})
func AmazonLinux2Kernel_CDK_LATEST ¶ added in v2.76.0
func AmazonLinux2Kernel_CDK_LATEST() AmazonLinux2Kernel
func AmazonLinux2Kernel_DEFAULT ¶ added in v2.76.0
func AmazonLinux2Kernel_DEFAULT() AmazonLinux2Kernel
func AmazonLinux2Kernel_KERNEL_5_10 ¶ added in v2.76.0
func AmazonLinux2Kernel_KERNEL_5_10() AmazonLinux2Kernel
func NewAmazonLinux2Kernel ¶ added in v2.76.0
func NewAmazonLinux2Kernel(version *string) AmazonLinux2Kernel
type AmazonLinuxCpuType ¶
type AmazonLinuxCpuType string
CPU type.
Example:
// Pick the right Amazon Linux edition. All arguments shown are optional
// and will default to these values when omitted.
amznLinux := ec2.MachineImage_LatestAmazonLinux(&AmazonLinuxImageProps{
Generation: ec2.AmazonLinuxGeneration_AMAZON_LINUX,
Edition: ec2.AmazonLinuxEdition_STANDARD,
Virtualization: ec2.AmazonLinuxVirt_HVM,
Storage: ec2.AmazonLinuxStorage_GENERAL_PURPOSE,
CpuType: ec2.AmazonLinuxCpuType_X86_64,
})
// Pick a Windows edition to use
windows := ec2.MachineImage_LatestWindows(ec2.WindowsVersion_WINDOWS_SERVER_2019_ENGLISH_FULL_BASE)
// Read AMI id from SSM parameter store
ssm := ec2.MachineImage_FromSsmParameter(jsii.String("/my/ami"), &SsmParameterImageOptions{
Os: ec2.OperatingSystemType_LINUX,
})
// Look up the most recent image matching a set of AMI filters.
// In this case, look up the NAT instance AMI, by using a wildcard
// in the 'name' field:
natAmi := ec2.MachineImage_Lookup(&LookupMachineImageProps{
Name: jsii.String("amzn-ami-vpc-nat-*"),
Owners: []*string{
jsii.String("amazon"),
},
})
// For other custom (Linux) images, instantiate a `GenericLinuxImage` with
// a map giving the AMI to in for each region:
linux := ec2.MachineImage_GenericLinux(map[string]*string{
"us-east-1": jsii.String("ami-97785bed"),
"eu-west-1": jsii.String("ami-12345678"),
})
// For other custom (Windows) images, instantiate a `GenericWindowsImage` with
// a map giving the AMI to in for each region:
genericWindows := ec2.MachineImage_GenericWindows(map[string]*string{
"us-east-1": jsii.String("ami-97785bed"),
"eu-west-1": jsii.String("ami-12345678"),
})
const ( // arm64 CPU type. AmazonLinuxCpuType_ARM_64 AmazonLinuxCpuType = "ARM_64" // x86_64 CPU type. AmazonLinuxCpuType_X86_64 AmazonLinuxCpuType = "X86_64" )
type AmazonLinuxEdition ¶
type AmazonLinuxEdition string
Amazon Linux edition.
Example:
// Pick a Windows edition to use
windows := ec2.NewWindowsImage(ec2.WindowsVersion_WINDOWS_SERVER_2019_ENGLISH_FULL_BASE)
// Pick the right Amazon Linux edition. All arguments shown are optional
// and will default to these values when omitted.
amznLinux := ec2.NewAmazonLinuxImage(&AmazonLinuxImageProps{
Generation: ec2.AmazonLinuxGeneration_AMAZON_LINUX,
Edition: ec2.AmazonLinuxEdition_STANDARD,
Virtualization: ec2.AmazonLinuxVirt_HVM,
Storage: ec2.AmazonLinuxStorage_GENERAL_PURPOSE,
})
// For other custom (Linux) images, instantiate a `GenericLinuxImage` with
// a map giving the AMI to in for each region:
linux := ec2.NewGenericLinuxImage(map[string]*string{
"us-east-1": jsii.String("ami-97785bed"),
"eu-west-1": jsii.String("ami-12345678"),
})
const ( // Standard edition. AmazonLinuxEdition_STANDARD AmazonLinuxEdition = "STANDARD" // Minimal edition. AmazonLinuxEdition_MINIMAL AmazonLinuxEdition = "MINIMAL" )
type AmazonLinuxGeneration ¶
type AmazonLinuxGeneration string
What generation of Amazon Linux to use.
Example:
var vpc vpc
ec2.NewInstance(this, jsii.String("Instance"), &InstanceProps{
Vpc: Vpc,
InstanceType: ec2.InstanceType_Of(ec2.InstanceClass_T3, ec2.InstanceSize_NANO),
MachineImage: ec2.NewAmazonLinuxImage(&AmazonLinuxImageProps{
Generation: ec2.AmazonLinuxGeneration_AMAZON_LINUX_2,
}),
InstanceInitiatedShutdownBehavior: ec2.InstanceInitiatedShutdownBehavior_TERMINATE,
})
const ( // Amazon Linux. AmazonLinuxGeneration_AMAZON_LINUX AmazonLinuxGeneration = "AMAZON_LINUX" // Amazon Linux 2. AmazonLinuxGeneration_AMAZON_LINUX_2 AmazonLinuxGeneration = "AMAZON_LINUX_2" // Amazon Linux 2022. AmazonLinuxGeneration_AMAZON_LINUX_2022 AmazonLinuxGeneration = "AMAZON_LINUX_2022" // Amazon Linux 2023. AmazonLinuxGeneration_AMAZON_LINUX_2023 AmazonLinuxGeneration = "AMAZON_LINUX_2023" )
type AmazonLinuxImage ¶
type AmazonLinuxImage interface {
GenericSSMParameterImage
// Name of the SSM parameter we're looking up.
ParameterName() *string
// Return the image to use in the given context.
GetImage(scope constructs.Construct) *MachineImageConfig
}
Selects the latest version of Amazon Linux.
This Machine Image automatically updates to the latest version on every deployment. Be aware this will cause your instances to be replaced when a new version of the image becomes available. Do not store stateful information on the instance if you are using this image.
The AMI ID is selected using the values published to the SSM parameter store.
Example:
var vpc iVpc
lb := elb.NewLoadBalancer(this, jsii.String("LB"), &LoadBalancerProps{
Vpc: Vpc,
InternetFacing: jsii.Boolean(true),
})
// instance to add as the target for load balancer.
instance := ec2.NewInstance(this, jsii.String("targetInstance"), &InstanceProps{
Vpc: vpc,
InstanceType: ec2.InstanceType_Of(ec2.InstanceClass_BURSTABLE2, ec2.InstanceSize_MICRO),
MachineImage: ec2.NewAmazonLinuxImage(&AmazonLinuxImageProps{
Generation: ec2.AmazonLinuxGeneration_AMAZON_LINUX_2,
}),
})
lb.AddTarget(elb.NewInstanceTarget(instance))
func NewAmazonLinuxImage ¶
func NewAmazonLinuxImage(props *AmazonLinuxImageProps) AmazonLinuxImage
type AmazonLinuxImageProps ¶
type AmazonLinuxImageProps struct {
// Whether the AMI ID is cached to be stable between deployments.
//
// By default, the newest image is used on each deployment. This will cause
// instances to be replaced whenever a new version is released, and may cause
// downtime if there aren't enough running instances in the AutoScalingGroup
// to reschedule the tasks on.
//
// If set to true, the AMI ID will be cached in `cdk.context.json` and the
// same value will be used on future runs. Your instances will not be replaced
// but your AMI version will grow old over time. To refresh the AMI lookup,
// you will have to evict the value from the cache using the `cdk context`
// command. See https://docs.aws.amazon.com/cdk/latest/guide/context.html for
// more information.
//
// Can not be set to `true` in environment-agnostic stacks.
// Default: false.
//
CachedInContext *bool `field:"optional" json:"cachedInContext" yaml:"cachedInContext"`
// CPU Type.
// Default: X86_64.
//
CpuType AmazonLinuxCpuType `field:"optional" json:"cpuType" yaml:"cpuType"`
// What edition of Amazon Linux to use.
// Default: Standard.
//
Edition AmazonLinuxEdition `field:"optional" json:"edition" yaml:"edition"`
// What generation of Amazon Linux to use.
// Default: AmazonLinux.
//
Generation AmazonLinuxGeneration `field:"optional" json:"generation" yaml:"generation"`
// What kernel version of Amazon Linux to use.
// Default: -.
//
Kernel AmazonLinuxKernel `field:"optional" json:"kernel" yaml:"kernel"`
// What storage backed image to use.
// Default: GeneralPurpose.
//
Storage AmazonLinuxStorage `field:"optional" json:"storage" yaml:"storage"`
// Initial user data.
// Default: - Empty UserData for Linux machines.
//
UserData UserData `field:"optional" json:"userData" yaml:"userData"`
// Virtualization type.
// Default: HVM.
//
Virtualization AmazonLinuxVirt `field:"optional" json:"virtualization" yaml:"virtualization"`
}
Amazon Linux image properties.
Example:
var vpc iVpc
lb := elb.NewLoadBalancer(this, jsii.String("LB"), &LoadBalancerProps{
Vpc: Vpc,
InternetFacing: jsii.Boolean(true),
})
// instance to add as the target for load balancer.
instance := ec2.NewInstance(this, jsii.String("targetInstance"), &InstanceProps{
Vpc: vpc,
InstanceType: ec2.InstanceType_Of(ec2.InstanceClass_BURSTABLE2, ec2.InstanceSize_MICRO),
MachineImage: ec2.NewAmazonLinuxImage(&AmazonLinuxImageProps{
Generation: ec2.AmazonLinuxGeneration_AMAZON_LINUX_2,
}),
})
lb.AddTarget(elb.NewInstanceTarget(instance))
type AmazonLinuxImageSsmParameterBase ¶ added in v2.76.0
type AmazonLinuxImageSsmParameterBase interface {
IMachineImage
// Return the image to use in the given context.
GetImage(scope constructs.Construct) *MachineImageConfig
}
type AmazonLinuxImageSsmParameterBaseOptions ¶ added in v2.76.0
type AmazonLinuxImageSsmParameterBaseOptions struct {
// Whether the AMI ID is cached to be stable between deployments.
//
// By default, the newest image is used on each deployment. This will cause
// instances to be replaced whenever a new version is released, and may cause
// downtime if there aren't enough running instances in the AutoScalingGroup
// to reschedule the tasks on.
//
// If set to true, the AMI ID will be cached in `cdk.context.json` and the
// same value will be used on future runs. Your instances will not be replaced
// but your AMI version will grow old over time. To refresh the AMI lookup,
// you will have to evict the value from the cache using the `cdk context`
// command. See https://docs.aws.amazon.com/cdk/latest/guide/context.html for
// more information.
//
// Can not be set to `true` in environment-agnostic stacks.
// Default: false.
//
CachedInContext *bool `field:"optional" json:"cachedInContext" yaml:"cachedInContext"`
// Initial user data.
// Default: - Empty UserData for Linux machines.
//
UserData UserData `field:"optional" json:"userData" yaml:"userData"`
}
Base options for amazon linux ssm parameters.
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"
var userData userData
amazonLinuxImageSsmParameterBaseOptions := &AmazonLinuxImageSsmParameterBaseOptions{
CachedInContext: jsii.Boolean(false),
UserData: userData,
}
type AmazonLinuxImageSsmParameterBaseProps ¶ added in v2.76.0
type AmazonLinuxImageSsmParameterBaseProps struct {
// Whether the AMI ID is cached to be stable between deployments.
//
// By default, the newest image is used on each deployment. This will cause
// instances to be replaced whenever a new version is released, and may cause
// downtime if there aren't enough running instances in the AutoScalingGroup
// to reschedule the tasks on.
//
// If set to true, the AMI ID will be cached in `cdk.context.json` and the
// same value will be used on future runs. Your instances will not be replaced
// but your AMI version will grow old over time. To refresh the AMI lookup,
// you will have to evict the value from the cache using the `cdk context`
// command. See https://docs.aws.amazon.com/cdk/latest/guide/context.html for
// more information.
//
// Can not be set to `true` in environment-agnostic stacks.
// Default: false.
//
CachedInContext *bool `field:"optional" json:"cachedInContext" yaml:"cachedInContext"`
// Initial user data.
// Default: - Empty UserData for Linux machines.
//
UserData UserData `field:"optional" json:"userData" yaml:"userData"`
// The name of the SSM parameter that contains the AMI value.
ParameterName *string `field:"required" json:"parameterName" yaml:"parameterName"`
}
Base properties for an Amazon Linux SSM Parameter.
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"
var userData userData
amazonLinuxImageSsmParameterBaseProps := &AmazonLinuxImageSsmParameterBaseProps{
ParameterName: jsii.String("parameterName"),
// the properties below are optional
CachedInContext: jsii.Boolean(false),
UserData: userData,
}
type AmazonLinuxImageSsmParameterCommonOptions ¶ added in v2.76.0
type AmazonLinuxImageSsmParameterCommonOptions struct {
// Whether the AMI ID is cached to be stable between deployments.
//
// By default, the newest image is used on each deployment. This will cause
// instances to be replaced whenever a new version is released, and may cause
// downtime if there aren't enough running instances in the AutoScalingGroup
// to reschedule the tasks on.
//
// If set to true, the AMI ID will be cached in `cdk.context.json` and the
// same value will be used on future runs. Your instances will not be replaced
// but your AMI version will grow old over time. To refresh the AMI lookup,
// you will have to evict the value from the cache using the `cdk context`
// command. See https://docs.aws.amazon.com/cdk/latest/guide/context.html for
// more information.
//
// Can not be set to `true` in environment-agnostic stacks.
// Default: false.
//
CachedInContext *bool `field:"optional" json:"cachedInContext" yaml:"cachedInContext"`
// Initial user data.
// Default: - Empty UserData for Linux machines.
//
UserData UserData `field:"optional" json:"userData" yaml:"userData"`
// CPU Type.
// Default: AmazonLinuxCpuType.X86_64
//
CpuType AmazonLinuxCpuType `field:"optional" json:"cpuType" yaml:"cpuType"`
// What edition of Amazon Linux to use.
// Default: AmazonLinuxEdition.Standard
//
Edition AmazonLinuxEdition `field:"optional" json:"edition" yaml:"edition"`
}
Common options across all generations.
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"
var userData userData
amazonLinuxImageSsmParameterCommonOptions := &AmazonLinuxImageSsmParameterCommonOptions{
CachedInContext: jsii.Boolean(false),
CpuType: awscdk.Aws_ec2.AmazonLinuxCpuType_ARM_64,
Edition: awscdk.*Aws_ec2.AmazonLinuxEdition_STANDARD,
UserData: userData,
}
type AmazonLinuxKernel ¶ added in v2.9.0
type AmazonLinuxKernel string
Amazon Linux Kernel.
const ( // Kernel version 5.10. AmazonLinuxKernel_KERNEL5_X AmazonLinuxKernel = "KERNEL5_X" // Kernel version 6.1. AmazonLinuxKernel_KERNEL6_1 AmazonLinuxKernel = "KERNEL6_1" )
type AmazonLinuxStorage ¶
type AmazonLinuxStorage string
Available storage options for Amazon Linux images Only applies to Amazon Linux & Amazon Linux 2.
Example:
// Pick a Windows edition to use
windows := ec2.NewWindowsImage(ec2.WindowsVersion_WINDOWS_SERVER_2019_ENGLISH_FULL_BASE)
// Pick the right Amazon Linux edition. All arguments shown are optional
// and will default to these values when omitted.
amznLinux := ec2.NewAmazonLinuxImage(&AmazonLinuxImageProps{
Generation: ec2.AmazonLinuxGeneration_AMAZON_LINUX,
Edition: ec2.AmazonLinuxEdition_STANDARD,
Virtualization: ec2.AmazonLinuxVirt_HVM,
Storage: ec2.AmazonLinuxStorage_GENERAL_PURPOSE,
})
// For other custom (Linux) images, instantiate a `GenericLinuxImage` with
// a map giving the AMI to in for each region:
linux := ec2.NewGenericLinuxImage(map[string]*string{
"us-east-1": jsii.String("ami-97785bed"),
"eu-west-1": jsii.String("ami-12345678"),
})
const ( // EBS-backed storage. AmazonLinuxStorage_EBS AmazonLinuxStorage = "EBS" // S3-backed storage. AmazonLinuxStorage_S3 AmazonLinuxStorage = "S3" // General Purpose-based storage (recommended). AmazonLinuxStorage_GENERAL_PURPOSE AmazonLinuxStorage = "GENERAL_PURPOSE" )
type AmazonLinuxVirt ¶
type AmazonLinuxVirt string
Virtualization type for Amazon Linux.
Example:
// Pick a Windows edition to use
windows := ec2.NewWindowsImage(ec2.WindowsVersion_WINDOWS_SERVER_2019_ENGLISH_FULL_BASE)
// Pick the right Amazon Linux edition. All arguments shown are optional
// and will default to these values when omitted.
amznLinux := ec2.NewAmazonLinuxImage(&AmazonLinuxImageProps{
Generation: ec2.AmazonLinuxGeneration_AMAZON_LINUX,
Edition: ec2.AmazonLinuxEdition_STANDARD,
Virtualization: ec2.AmazonLinuxVirt_HVM,
Storage: ec2.AmazonLinuxStorage_GENERAL_PURPOSE,
})
// For other custom (Linux) images, instantiate a `GenericLinuxImage` with
// a map giving the AMI to in for each region:
linux := ec2.NewGenericLinuxImage(map[string]*string{
"us-east-1": jsii.String("ami-97785bed"),
"eu-west-1": jsii.String("ami-12345678"),
})
const ( // HVM virtualization (recommended). AmazonLinuxVirt_HVM AmazonLinuxVirt = "HVM" // PV virtualization. AmazonLinuxVirt_PV AmazonLinuxVirt = "PV" )
type ApplyCloudFormationInitOptions ¶
type ApplyCloudFormationInitOptions struct {
// ConfigSet to activate.
// Default: ['default'].
//
ConfigSets *[]*string `field:"optional" json:"configSets" yaml:"configSets"`
// Force instance replacement by embedding a config fingerprint.
//
// If `true` (the default), a hash of the config will be embedded into the
// UserData, so that if the config changes, the UserData changes.
//
// - If the EC2 instance is instance-store backed or
// `userDataCausesReplacement` is set, this will cause the instance to be
// replaced and the new configuration to be applied.
// - If the instance is EBS-backed and `userDataCausesReplacement` is not
// set, the change of UserData will make the instance restart but not be
// replaced, and the configuration will not be applied automatically.
//
// If `false`, no hash will be embedded, and if the CloudFormation Init
// config changes nothing will happen to the running instance. If a
// config update introduces errors, you will not notice until after the
// CloudFormation deployment successfully finishes and the next instance
// fails to launch.
// Default: true.
//
EmbedFingerprint *bool `field:"optional" json:"embedFingerprint" yaml:"embedFingerprint"`
// Don't fail the instance creation when cfn-init fails.
//
// You can use this to prevent CloudFormation from rolling back when
// instances fail to start up, to help in debugging.
// Default: false.
//
IgnoreFailures *bool `field:"optional" json:"ignoreFailures" yaml:"ignoreFailures"`
// Include --role argument when running cfn-init and cfn-signal commands.
//
// This will be the IAM instance profile attached to the EC2 instance.
// Default: false.
//
IncludeRole *bool `field:"optional" json:"includeRole" yaml:"includeRole"`
// Include --url argument when running cfn-init and cfn-signal commands.
//
// This will be the cloudformation endpoint in the deployed region
// e.g. https://cloudformation.us-east-1.amazonaws.com
// Default: false.
//
IncludeUrl *bool `field:"optional" json:"includeUrl" yaml:"includeUrl"`
// Print the results of running cfn-init to the Instance System Log.
//
// By default, the output of running cfn-init is written to a log file
// on the instance. Set this to `true` to print it to the System Log
// (visible from the EC2 Console), `false` to not print it.
//
// (Be aware that the system log is refreshed at certain points in
// time of the instance life cycle, and successful execution may
// not always show up).
// Default: true.
//
PrintLog *bool `field:"optional" json:"printLog" yaml:"printLog"`
// Timeout waiting for the configuration to be applied.
// Default: Duration.minutes(5)
//
Timeout awscdk.Duration `field:"optional" json:"timeout" yaml:"timeout"`
}
Options for applying CloudFormation init to an instance or instance group.
Example:
var vpc vpc
var instanceType instanceType
var machineImage iMachineImage
ec2.NewInstance(this, jsii.String("Instance"), &InstanceProps{
Vpc: Vpc,
InstanceType: InstanceType,
MachineImage: MachineImage,
// Showing the most complex setup, if you have simpler requirements
// you can use `CloudFormationInit.fromElements()`.
Init: ec2.CloudFormationInit_FromConfigSets(&ConfigSetProps{
ConfigSets: map[string][]*string{
// Applies the configs below in this order
"default": []*string{
jsii.String("yumPreinstall"),
jsii.String("config"),
},
},
Configs: map[string]initConfig{
"yumPreinstall": ec2.NewInitConfig([]InitElement{
ec2.InitPackage_yum(jsii.String("git")),
}),
"config": ec2.NewInitConfig([]InitElement{
ec2.InitFile_fromObject(jsii.String("/etc/stack.json"), map[string]interface{}{
"stackId": awscdk.*stack_of(this).stackId,
"stackName": awscdk.*stack_of(this).stackName,
"region": awscdk.*stack_of(this).region,
}),
ec2.InitGroup_fromName(jsii.String("my-group")),
ec2.InitUser_fromName(jsii.String("my-user")),
ec2.InitPackage_rpm(jsii.String("http://mirrors.ukfast.co.uk/sites/dl.fedoraproject.org/pub/epel/8/Everything/x86_64/Packages/r/rubygem-git-1.5.0-2.el8.noarch.rpm")),
}),
},
}),
InitOptions: &ApplyCloudFormationInitOptions{
// Optional, which configsets to activate (['default'] by default)
ConfigSets: []*string{
jsii.String("default"),
},
// Optional, how long the installation is expected to take (5 minutes by default)
Timeout: awscdk.Duration_Minutes(jsii.Number(30)),
// Optional, whether to include the --url argument when running cfn-init and cfn-signal commands (false by default)
IncludeUrl: jsii.Boolean(true),
// Optional, whether to include the --role argument when running cfn-init and cfn-signal commands (false by default)
IncludeRole: jsii.Boolean(true),
},
})
type AttachInitOptions ¶
type AttachInitOptions struct {
// Instance role of the consuming instance or fleet.
InstanceRole awsiam.IRole `field:"required" json:"instanceRole" yaml:"instanceRole"`
// OS Platform the init config will be used for.
Platform OperatingSystemType `field:"required" json:"platform" yaml:"platform"`
// UserData to add commands to.
UserData UserData `field:"required" json:"userData" yaml:"userData"`
// ConfigSet to activate.
// Default: ['default'].
//
ConfigSets *[]*string `field:"optional" json:"configSets" yaml:"configSets"`
// Whether to embed a hash into the userData.
//
// If `true` (the default), a hash of the config will be embedded into the
// UserData, so that if the config changes, the UserData changes and
// the instance will be replaced.
//
// If `false`, no such hash will be embedded, and if the CloudFormation Init
// config changes nothing will happen to the running instance.
// Default: true.
//
EmbedFingerprint *bool `field:"optional" json:"embedFingerprint" yaml:"embedFingerprint"`
// Don't fail the instance creation when cfn-init fails.
//
// You can use this to prevent CloudFormation from rolling back when
// instances fail to start up, to help in debugging.
// Default: false.
//
IgnoreFailures *bool `field:"optional" json:"ignoreFailures" yaml:"ignoreFailures"`
// Include --role argument when running cfn-init and cfn-signal commands.
//
// This will be the IAM instance profile attached to the EC2 instance.
// Default: false.
//
IncludeRole *bool `field:"optional" json:"includeRole" yaml:"includeRole"`
// Include --url argument when running cfn-init and cfn-signal commands.
//
// This will be the cloudformation endpoint in the deployed region
// e.g. https://cloudformation.us-east-1.amazonaws.com
// Default: false.
//
IncludeUrl *bool `field:"optional" json:"includeUrl" yaml:"includeUrl"`
// Print the results of running cfn-init to the Instance System Log.
//
// By default, the output of running cfn-init is written to a log file
// on the instance. Set this to `true` to print it to the System Log
// (visible from the EC2 Console), `false` to not print it.
//
// (Be aware that the system log is refreshed at certain points in
// time of the instance life cycle, and successful execution may
// not always show up).
// Default: true.
//
PrintLog *bool `field:"optional" json:"printLog" yaml:"printLog"`
// When provided, signals this resource instead of the attached resource.
//
// You can use this to support signaling LaunchTemplate while attaching AutoScalingGroup.
// Default: - if this property is undefined cfn-signal signals the attached resource.
//
SignalResource awscdk.CfnResource `field:"optional" json:"signalResource" yaml:"signalResource"`
}
Options for attaching a CloudFormationInit to a resource.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
var cfnResource cfnResource
var role role
var userData userData
attachInitOptions := &AttachInitOptions{
InstanceRole: role,
Platform: awscdk.Aws_ec2.OperatingSystemType_LINUX,
UserData: userData,
// the properties below are optional
ConfigSets: []*string{
jsii.String("configSets"),
},
EmbedFingerprint: jsii.Boolean(false),
IgnoreFailures: jsii.Boolean(false),
IncludeRole: jsii.Boolean(false),
IncludeUrl: jsii.Boolean(false),
PrintLog: jsii.Boolean(false),
SignalResource: cfnResource,
}
type AwsIpamProps ¶ added in v2.48.0
type AwsIpamProps struct {
// Ipam Pool Id for ipv4 allocation.
Ipv4IpamPoolId *string `field:"required" json:"ipv4IpamPoolId" yaml:"ipv4IpamPoolId"`
// Netmask length for Vpc.
Ipv4NetmaskLength *float64 `field:"required" json:"ipv4NetmaskLength" yaml:"ipv4NetmaskLength"`
// Default length for Subnet ipv4 Network mask.
//
// Specify this option only if you do not specify all Subnets using SubnetConfiguration with a cidrMask.
// Default: - Default ipv4 Subnet Mask for subnets in Vpc.
//
DefaultSubnetIpv4NetmaskLength *float64 `field:"optional" json:"defaultSubnetIpv4NetmaskLength" yaml:"defaultSubnetIpv4NetmaskLength"`
}
Configuration for AwsIpam.
Example:
import "github.com/aws/aws-cdk-go/awscdk"
var pool cfnIPAMPool
ec2.NewVpc(this, jsii.String("TheVPC"), &VpcProps{
IpAddresses: awscdk.IpAddresses_AwsIpamAllocation(&AwsIpamProps{
Ipv4IpamPoolId: pool.ref,
Ipv4NetmaskLength: jsii.Number(18),
DefaultSubnetIpv4NetmaskLength: jsii.Number(24),
}),
})
type BastionHostLinux ¶
type BastionHostLinux interface {
awscdk.Resource
IInstance
// Allows specify security group connections for the instance.
Connections() Connections
// The environment this resource belongs to.
//
// For resources that are created and managed by the CDK
// (generally, those created by creating new class instances like Role, Bucket, etc.),
// this is always the same as the environment of the stack they belong to;
// however, for imported resources
// (those obtained from static methods like fromRoleArn, fromBucketName, etc.),
// that might be different than the stack they were imported into.
Env() *awscdk.ResourceEnvironment
// The principal to grant permissions to.
GrantPrincipal() awsiam.IPrincipal
// The underlying instance resource.
Instance() Instance
// The availability zone the instance was launched in.
InstanceAvailabilityZone() *string
// The instance's ID.
InstanceId() *string
// Private DNS name for this instance.
InstancePrivateDnsName() *string
// Private IP for this instance.
InstancePrivateIp() *string
// Publicly-routable DNS name for this instance.
//
// (May be an empty string if the instance does not have a public name).
InstancePublicDnsName() *string
// Publicly-routable IP address for this instance.
//
// (May be an empty string if the instance does not have a public IP).
InstancePublicIp() *string
// The tree node.
Node() constructs.Node
// Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
//
// This value will resolve to one of the following:
// - a concrete value (e.g. `"my-awesome-bucket"`)
// - `undefined`, when a name should be generated by CloudFormation
// - a concrete name generated automatically during synthesis, in
// cross-environment scenarios.
PhysicalName() *string
// The IAM role assumed by the instance.
Role() awsiam.IRole
// The stack in which this resource is defined.
Stack() awscdk.Stack
// Allow SSH access from the given peer or peers.
//
// Necessary if you want to connect to the instance using ssh. If not
// called, you should use SSM Session Manager to connect to the instance.
AllowSshAccessFrom(peer ...IPeer)
// Apply the given removal policy to this resource.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
GeneratePhysicalName() *string
// Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`).
//
// Normally, this token will resolve to `arnAttr`, but if the resource is
// referenced across environments, `arnComponents` will be used to synthesize
// a concrete ARN with the resource's physical name. Make sure to reference
// `this.physicalName` in `arnComponents`.
GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
// Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`).
//
// Normally, this token will resolve to `nameAttr`, but if the resource is
// referenced across environments, it will be resolved to `this.physicalName`,
// which will be a concrete name.
GetResourceNameAttribute(nameAttr *string) *string
// Returns a string representation of this construct.
ToString() *string
}
This creates a linux bastion host you can use to connect to other instances or services in your VPC.
The recommended way to connect to the bastion host is by using AWS Systems Manager Session Manager.
The operating system is Amazon Linux 2 with the latest SSM agent installed ¶
You can also configure this bastion host to allow connections via SSH.
Example:
host := ec2.NewBastionHostLinux(this, jsii.String("BastionHost"), &BastionHostLinuxProps{
Vpc: Vpc,
BlockDevices: []blockDevice{
&blockDevice{
DeviceName: jsii.String("/dev/sdh"),
Volume: ec2.BlockDeviceVolume_Ebs(jsii.Number(10), &EbsDeviceOptions{
Encrypted: jsii.Boolean(true),
}),
},
},
})
func NewBastionHostLinux ¶
func NewBastionHostLinux(scope constructs.Construct, id *string, props *BastionHostLinuxProps) BastionHostLinux
type BastionHostLinuxProps ¶
type BastionHostLinuxProps struct {
// VPC to launch the instance in.
Vpc IVpc `field:"required" json:"vpc" yaml:"vpc"`
// In which AZ to place the instance within the VPC.
// Default: - Random zone.
//
AvailabilityZone *string `field:"optional" json:"availabilityZone" yaml:"availabilityZone"`
// Specifies how block devices are exposed to the instance. You can specify virtual devices and EBS volumes.
//
// Each instance that is launched has an associated root device volume,
// either an Amazon EBS volume or an instance store volume.
// You can use block device mappings to specify additional EBS volumes or
// instance store volumes to attach to an instance when it is launched.
// See: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html
//
// Default: - Uses the block device mapping of the AMI.
//
BlockDevices *[]*BlockDevice `field:"optional" json:"blockDevices" yaml:"blockDevices"`
// Apply the given CloudFormation Init configuration to the instance at startup.
// Default: - no CloudFormation init.
//
Init CloudFormationInit `field:"optional" json:"init" yaml:"init"`
// Use the given options for applying CloudFormation Init.
//
// Describes the configsets to use and the timeout to wait.
// Default: - default options.
//
InitOptions *ApplyCloudFormationInitOptions `field:"optional" json:"initOptions" yaml:"initOptions"`
// The name of the instance.
// Default: 'BastionHost'.
//
InstanceName *string `field:"optional" json:"instanceName" yaml:"instanceName"`
// Type of instance to launch.
// Default: 't3.nano'
//
InstanceType InstanceType `field:"optional" json:"instanceType" yaml:"instanceType"`
// The machine image to use, assumed to have SSM Agent preinstalled.
// Default: - An Amazon Linux 2 image which is kept up-to-date automatically (the instance
// may be replaced on every deployment) and already has SSM Agent installed.
//
MachineImage IMachineImage `field:"optional" json:"machineImage" yaml:"machineImage"`
// Whether IMDSv2 should be required on this instance.
// Default: - false.
//
RequireImdsv2 *bool `field:"optional" json:"requireImdsv2" yaml:"requireImdsv2"`
// Security Group to assign to this instance.
// Default: - create new security group with no inbound and all outbound traffic allowed.
//
SecurityGroup ISecurityGroup `field:"optional" json:"securityGroup" yaml:"securityGroup"`
// Select the subnets to run the bastion host in.
//
// Set this to PUBLIC if you need to connect to this instance via the internet and cannot use SSM.
// You have to allow port 22 manually by using the connections field.
// Default: - private subnets of the supplied VPC.
//
SubnetSelection *SubnetSelection `field:"optional" json:"subnetSelection" yaml:"subnetSelection"`
}
Properties of the bastion host.
Example:
host := ec2.NewBastionHostLinux(this, jsii.String("BastionHost"), &BastionHostLinuxProps{
Vpc: Vpc,
BlockDevices: []blockDevice{
&blockDevice{
DeviceName: jsii.String("/dev/sdh"),
Volume: ec2.BlockDeviceVolume_Ebs(jsii.Number(10), &EbsDeviceOptions{
Encrypted: jsii.Boolean(true),
}),
},
},
})
type BlockDevice ¶
type BlockDevice struct {
// The device name exposed to the EC2 instance.
//
// For example, a value like `/dev/sdh`, `xvdh`.
// See: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/device_naming.html
//
DeviceName *string `field:"required" json:"deviceName" yaml:"deviceName"`
// Defines the block device volume, to be either an Amazon EBS volume or an ephemeral instance store volume.
//
// For example, a value like `BlockDeviceVolume.ebs(15)`, `BlockDeviceVolume.ephemeral(0)`.
Volume BlockDeviceVolume `field:"required" json:"volume" yaml:"volume"`
// If false, the device mapping will be suppressed.
//
// If set to false for the root device, the instance might fail the Amazon EC2 health check.
// Amazon EC2 Auto Scaling launches a replacement instance if the instance fails the health check.
// Default: true - device mapping is left untouched.
//
MappingEnabled *bool `field:"optional" json:"mappingEnabled" yaml:"mappingEnabled"`
}
Block device.
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"
var blockDeviceVolume blockDeviceVolume
blockDevice := &BlockDevice{
DeviceName: jsii.String("deviceName"),
Volume: blockDeviceVolume,
// the properties below are optional
MappingEnabled: jsii.Boolean(false),
}
type BlockDeviceVolume ¶
type BlockDeviceVolume interface {
// EBS device info.
EbsDevice() *EbsDeviceProps
// Virtual device name.
VirtualName() *string
}
Describes a block device mapping for an EC2 instance or Auto Scaling group.
Example:
var vpc vpc
var instanceType instanceType
var machineImage iMachineImage
ec2.NewInstance(this, jsii.String("Instance"), &InstanceProps{
Vpc: Vpc,
InstanceType: InstanceType,
MachineImage: MachineImage,
// ...
BlockDevices: []blockDevice{
&blockDevice{
DeviceName: jsii.String("/dev/sda1"),
Volume: ec2.BlockDeviceVolume_Ebs(jsii.Number(100), &EbsDeviceOptions{
VolumeType: ec2.EbsDeviceVolumeType_GP3,
Throughput: jsii.Number(250),
}),
},
},
})
func BlockDeviceVolume_Ebs ¶
func BlockDeviceVolume_Ebs(volumeSize *float64, options *EbsDeviceOptions) BlockDeviceVolume
Creates a new Elastic Block Storage device.
func BlockDeviceVolume_EbsFromSnapshot ¶
func BlockDeviceVolume_EbsFromSnapshot(snapshotId *string, options *EbsDeviceSnapshotOptions) BlockDeviceVolume
Creates a new Elastic Block Storage device from an existing snapshot.
func BlockDeviceVolume_Ephemeral ¶
func BlockDeviceVolume_Ephemeral(volumeIndex *float64) BlockDeviceVolume
Creates a virtual, ephemeral device.
The name will be in the form ephemeral{volumeIndex}.
func NewBlockDeviceVolume ¶
func NewBlockDeviceVolume(ebsDevice *EbsDeviceProps, virtualName *string) BlockDeviceVolume
type CfnCapacityReservation ¶
type CfnCapacityReservation interface {
awscdk.CfnResource
awscdk.IInspectable
// Returns the Availability Zone in which the capacity is reserved.
//
// For example: `us-east-1a` .
AttrAvailabilityZone() *string
// Returns the remaining capacity, which indicates the number of instances that can be launched in the Capacity Reservation.
//
// For example: `9` .
AttrAvailableInstanceCount() *float64
// The ID of the Capacity Reservation.
AttrId() *string
// Returns the type of instance for which the capacity is reserved.
//
// For example: `m4.large` .
AttrInstanceType() *string
// Returns the tenancy of the Capacity Reservation.
//
// For example: `dedicated` .
AttrTenancy() *string
// Returns the total number of instances for which the Capacity Reservation reserves capacity.
//
// For example: `15` .
AttrTotalInstanceCount() *float64
// The Availability Zone in which to create the Capacity Reservation.
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
// Indicates whether the Capacity Reservation supports EBS-optimized instances.
EbsOptimized() interface{}
SetEbsOptimized(val interface{})
// The date and time at which the Capacity Reservation expires.
EndDate() *string
SetEndDate(val *string)
// Indicates the way in which the Capacity Reservation ends.
EndDateType() *string
SetEndDateType(val *string)
// *Deprecated.*.
EphemeralStorage() interface{}
SetEphemeralStorage(val interface{})
// The number of instances for which to reserve capacity.
InstanceCount() *float64
SetInstanceCount(val *float64)
// Indicates the type of instance launches that the Capacity Reservation accepts.
//
// The options include:.
InstanceMatchCriteria() *string
SetInstanceMatchCriteria(val *string)
// The type of operating system for which to reserve capacity.
InstancePlatform() *string
SetInstancePlatform(val *string)
// The instance type for which to reserve capacity.
InstanceType() *string
SetInstanceType(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
// The Amazon Resource Name (ARN) of the Outpost on which to create the Capacity Reservation.
OutPostArn() *string
SetOutPostArn(val *string)
// The Amazon Resource Name (ARN) of the cluster placement group in which to create the Capacity Reservation.
PlacementGroupArn() *string
SetPlacementGroupArn(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 tags to apply to the Capacity Reservation during launch.
TagSpecifications() interface{}
SetTagSpecifications(val interface{})
// Indicates the tenancy of the Capacity Reservation.
//
// A Capacity Reservation can have one of the following tenancy settings:.
Tenancy() *string
SetTenancy(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{})
}
Creates a new Capacity Reservation with the specified attributes.
For more information, see [Capacity Reservations](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-capacity-reservations.html) in the *Amazon EC2 User 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"
cfnCapacityReservation := awscdk.Aws_ec2.NewCfnCapacityReservation(this, jsii.String("MyCfnCapacityReservation"), &CfnCapacityReservationProps{
AvailabilityZone: jsii.String("availabilityZone"),
InstanceCount: jsii.Number(123),
InstancePlatform: jsii.String("instancePlatform"),
InstanceType: jsii.String("instanceType"),
// the properties below are optional
EbsOptimized: jsii.Boolean(false),
EndDate: jsii.String("endDate"),
EndDateType: jsii.String("endDateType"),
EphemeralStorage: jsii.Boolean(false),
InstanceMatchCriteria: jsii.String("instanceMatchCriteria"),
OutPostArn: jsii.String("outPostArn"),
PlacementGroupArn: jsii.String("placementGroupArn"),
TagSpecifications: []interface{}{
&TagSpecificationProperty{
ResourceType: jsii.String("resourceType"),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
},
},
Tenancy: jsii.String("tenancy"),
})
func NewCfnCapacityReservation ¶
func NewCfnCapacityReservation(scope constructs.Construct, id *string, props *CfnCapacityReservationProps) CfnCapacityReservation
type CfnCapacityReservationFleet ¶
type CfnCapacityReservationFleet interface {
awscdk.CfnResource
awscdk.IInspectable
// The strategy used by the Capacity Reservation Fleet to determine which of the specified instance types to use.
AllocationStrategy() *string
SetAllocationStrategy(val *string)
// The ID of the Capacity Reservation Fleet.
AttrCapacityReservationFleetId() *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 date and time at which the Capacity Reservation Fleet expires.
EndDate() *string
SetEndDate(val *string)
// Indicates the type of instance launches that the Capacity Reservation Fleet accepts.
InstanceMatchCriteria() *string
SetInstanceMatchCriteria(val *string)
// Information about the instance types for which to reserve the capacity.
InstanceTypeSpecifications() interface{}
SetInstanceTypeSpecifications(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
// Used to add an end date to a Capacity Reservation Fleet that has no end date and time.
NoRemoveEndDate() interface{}
SetNoRemoveEndDate(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
// Used to remove an end date from a Capacity Reservation Fleet that is configured to end automatically at a specific date and time.
RemoveEndDate() interface{}
SetRemoveEndDate(val interface{})
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// The tags to assign to the Capacity Reservation Fleet.
TagSpecifications() interface{}
SetTagSpecifications(val interface{})
// Indicates the tenancy of the Capacity Reservation Fleet.
Tenancy() *string
SetTenancy(val *string)
// The total number of capacity units to be reserved by the Capacity Reservation Fleet.
TotalTargetCapacity() *float64
SetTotalTargetCapacity(val *float64)
// 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{})
}
Creates a new Capacity Reservation Fleet with the specified attributes.
For more information, see [Capacity Reservation Fleets](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/cr-fleets.html) in the *Amazon EC2 User 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"
cfnCapacityReservationFleet := awscdk.Aws_ec2.NewCfnCapacityReservationFleet(this, jsii.String("MyCfnCapacityReservationFleet"), &CfnCapacityReservationFleetProps{
AllocationStrategy: jsii.String("allocationStrategy"),
EndDate: jsii.String("endDate"),
InstanceMatchCriteria: jsii.String("instanceMatchCriteria"),
InstanceTypeSpecifications: []interface{}{
&InstanceTypeSpecificationProperty{
AvailabilityZone: jsii.String("availabilityZone"),
AvailabilityZoneId: jsii.String("availabilityZoneId"),
EbsOptimized: jsii.Boolean(false),
InstancePlatform: jsii.String("instancePlatform"),
InstanceType: jsii.String("instanceType"),
Priority: jsii.Number(123),
Weight: jsii.Number(123),
},
},
NoRemoveEndDate: jsii.Boolean(false),
RemoveEndDate: jsii.Boolean(false),
TagSpecifications: []interface{}{
&TagSpecificationProperty{
ResourceType: jsii.String("resourceType"),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
},
},
Tenancy: jsii.String("tenancy"),
TotalTargetCapacity: jsii.Number(123),
})
func NewCfnCapacityReservationFleet ¶
func NewCfnCapacityReservationFleet(scope constructs.Construct, id *string, props *CfnCapacityReservationFleetProps) CfnCapacityReservationFleet
type CfnCapacityReservationFleetProps ¶
type CfnCapacityReservationFleetProps struct {
// The strategy used by the Capacity Reservation Fleet to determine which of the specified instance types to use.
//
// Currently, only the `prioritized` allocation strategy is supported. For more information, see [Allocation strategy](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#allocation-strategy) in the *Amazon EC2 User Guide* .
//
// Valid values: `prioritized`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservationfleet.html#cfn-ec2-capacityreservationfleet-allocationstrategy
//
AllocationStrategy *string `field:"optional" json:"allocationStrategy" yaml:"allocationStrategy"`
// The date and time at which the Capacity Reservation Fleet expires.
//
// When the Capacity Reservation Fleet expires, its state changes to `expired` and all of the Capacity Reservations in the Fleet expire.
//
// The Capacity Reservation Fleet expires within an hour after the specified time. For example, if you specify `5/31/2019` , `13:30:55` , the Capacity Reservation Fleet is guaranteed to expire between `13:30:55` and `14:30:55` on `5/31/2019` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservationfleet.html#cfn-ec2-capacityreservationfleet-enddate
//
EndDate *string `field:"optional" json:"endDate" yaml:"endDate"`
// Indicates the type of instance launches that the Capacity Reservation Fleet accepts.
//
// All Capacity Reservations in the Fleet inherit this instance matching criteria.
//
// Currently, Capacity Reservation Fleets support `open` instance matching criteria only. This means that instances that have matching attributes (instance type, platform, and Availability Zone) run in the Capacity Reservations automatically. Instances do not need to explicitly target a Capacity Reservation Fleet to use its reserved capacity.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservationfleet.html#cfn-ec2-capacityreservationfleet-instancematchcriteria
//
InstanceMatchCriteria *string `field:"optional" json:"instanceMatchCriteria" yaml:"instanceMatchCriteria"`
// Information about the instance types for which to reserve the capacity.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservationfleet.html#cfn-ec2-capacityreservationfleet-instancetypespecifications
//
InstanceTypeSpecifications interface{} `field:"optional" json:"instanceTypeSpecifications" yaml:"instanceTypeSpecifications"`
// Used to add an end date to a Capacity Reservation Fleet that has no end date and time.
//
// To add an end date to a Capacity Reservation Fleet, specify `true` for this paramater and specify the end date and time (in UTC time format) for the *EndDate* parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservationfleet.html#cfn-ec2-capacityreservationfleet-noremoveenddate
//
NoRemoveEndDate interface{} `field:"optional" json:"noRemoveEndDate" yaml:"noRemoveEndDate"`
// Used to remove an end date from a Capacity Reservation Fleet that is configured to end automatically at a specific date and time.
//
// To remove the end date from a Capacity Reservation Fleet, specify `true` for this paramater and omit the *EndDate* parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservationfleet.html#cfn-ec2-capacityreservationfleet-removeenddate
//
RemoveEndDate interface{} `field:"optional" json:"removeEndDate" yaml:"removeEndDate"`
// The tags to assign to the Capacity Reservation Fleet.
//
// The tags are automatically assigned to the Capacity Reservations in the Fleet.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservationfleet.html#cfn-ec2-capacityreservationfleet-tagspecifications
//
TagSpecifications interface{} `field:"optional" json:"tagSpecifications" yaml:"tagSpecifications"`
// Indicates the tenancy of the Capacity Reservation Fleet.
//
// All Capacity Reservations in the Fleet inherit this tenancy. The Capacity Reservation Fleet can have one of the following tenancy settings:
//
// - `default` - The Capacity Reservation Fleet is created on hardware that is shared with other AWS accounts .
// - `dedicated` - The Capacity Reservations are created on single-tenant hardware that is dedicated to a single AWS account .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservationfleet.html#cfn-ec2-capacityreservationfleet-tenancy
//
Tenancy *string `field:"optional" json:"tenancy" yaml:"tenancy"`
// The total number of capacity units to be reserved by the Capacity Reservation Fleet.
//
// This value, together with the instance type weights that you assign to each instance type used by the Fleet determine the number of instances for which the Fleet reserves capacity. Both values are based on units that make sense for your workload. For more information, see [Total target capacity](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#target-capacity) in the *Amazon EC2 User Guide* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservationfleet.html#cfn-ec2-capacityreservationfleet-totaltargetcapacity
//
TotalTargetCapacity *float64 `field:"optional" json:"totalTargetCapacity" yaml:"totalTargetCapacity"`
}
Properties for defining a `CfnCapacityReservationFleet`.
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"
cfnCapacityReservationFleetProps := &CfnCapacityReservationFleetProps{
AllocationStrategy: jsii.String("allocationStrategy"),
EndDate: jsii.String("endDate"),
InstanceMatchCriteria: jsii.String("instanceMatchCriteria"),
InstanceTypeSpecifications: []interface{}{
&InstanceTypeSpecificationProperty{
AvailabilityZone: jsii.String("availabilityZone"),
AvailabilityZoneId: jsii.String("availabilityZoneId"),
EbsOptimized: jsii.Boolean(false),
InstancePlatform: jsii.String("instancePlatform"),
InstanceType: jsii.String("instanceType"),
Priority: jsii.Number(123),
Weight: jsii.Number(123),
},
},
NoRemoveEndDate: jsii.Boolean(false),
RemoveEndDate: jsii.Boolean(false),
TagSpecifications: []interface{}{
&TagSpecificationProperty{
ResourceType: jsii.String("resourceType"),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
},
},
Tenancy: jsii.String("tenancy"),
TotalTargetCapacity: jsii.Number(123),
}
type CfnCapacityReservationFleet_InstanceTypeSpecificationProperty ¶
type CfnCapacityReservationFleet_InstanceTypeSpecificationProperty struct {
// The Availability Zone in which the Capacity Reservation Fleet reserves the capacity.
//
// A Capacity Reservation Fleet can't span Availability Zones. All instance type specifications that you specify for the Fleet must use the same Availability Zone.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-capacityreservationfleet-instancetypespecification.html#cfn-ec2-capacityreservationfleet-instancetypespecification-availabilityzone
//
AvailabilityZone *string `field:"optional" json:"availabilityZone" yaml:"availabilityZone"`
// The ID of the Availability Zone in which the Capacity Reservation Fleet reserves the capacity.
//
// A Capacity Reservation Fleet can't span Availability Zones. All instance type specifications that you specify for the Fleet must use the same Availability Zone.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-capacityreservationfleet-instancetypespecification.html#cfn-ec2-capacityreservationfleet-instancetypespecification-availabilityzoneid
//
AvailabilityZoneId *string `field:"optional" json:"availabilityZoneId" yaml:"availabilityZoneId"`
// Indicates whether the Capacity Reservation Fleet supports EBS-optimized instances types.
//
// This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using EBS-optimized instance types.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-capacityreservationfleet-instancetypespecification.html#cfn-ec2-capacityreservationfleet-instancetypespecification-ebsoptimized
//
EbsOptimized interface{} `field:"optional" json:"ebsOptimized" yaml:"ebsOptimized"`
// The type of operating system for which the Capacity Reservation Fleet reserves capacity.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-capacityreservationfleet-instancetypespecification.html#cfn-ec2-capacityreservationfleet-instancetypespecification-instanceplatform
//
InstancePlatform *string `field:"optional" json:"instancePlatform" yaml:"instancePlatform"`
// The instance type for which the Capacity Reservation Fleet reserves capacity.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-capacityreservationfleet-instancetypespecification.html#cfn-ec2-capacityreservationfleet-instancetypespecification-instancetype
//
InstanceType *string `field:"optional" json:"instanceType" yaml:"instanceType"`
// The priority to assign to the instance type.
//
// This value is used to determine which of the instance types specified for the Fleet should be prioritized for use. A lower value indicates a high priority. For more information, see [Instance type priority](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#instance-priority) in the *Amazon EC2 User Guide* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-capacityreservationfleet-instancetypespecification.html#cfn-ec2-capacityreservationfleet-instancetypespecification-priority
//
Priority *float64 `field:"optional" json:"priority" yaml:"priority"`
// The number of capacity units provided by the specified instance type.
//
// This value, together with the total target capacity that you specify for the Fleet determine the number of instances for which the Fleet reserves capacity. Both values are based on units that make sense for your workload. For more information, see [Total target capacity](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#target-capacity) in the Amazon EC2 User Guide.
//
// Valid Range: Minimum value of `0.001` . Maximum value of `99.999` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-capacityreservationfleet-instancetypespecification.html#cfn-ec2-capacityreservationfleet-instancetypespecification-weight
//
Weight *float64 `field:"optional" json:"weight" yaml:"weight"`
}
Specifies information about an instance type to use in a Capacity Reservation Fleet.
`InstanceTypeSpecification` is a property of the [AWS::EC2::CapacityReservationFleet](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservationfleet.html) resource.
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"
instanceTypeSpecificationProperty := &InstanceTypeSpecificationProperty{
AvailabilityZone: jsii.String("availabilityZone"),
AvailabilityZoneId: jsii.String("availabilityZoneId"),
EbsOptimized: jsii.Boolean(false),
InstancePlatform: jsii.String("instancePlatform"),
InstanceType: jsii.String("instanceType"),
Priority: jsii.Number(123),
Weight: jsii.Number(123),
}
type CfnCapacityReservationFleet_TagSpecificationProperty ¶
type CfnCapacityReservationFleet_TagSpecificationProperty struct {
// The type of resource to tag on creation. Specify `capacity-reservation-fleet` .
//
// To tag a resource after it has been created, see [CreateTags](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html) .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-capacityreservationfleet-tagspecification.html#cfn-ec2-capacityreservationfleet-tagspecification-resourcetype
//
ResourceType *string `field:"optional" json:"resourceType" yaml:"resourceType"`
// The tags to apply to the resource.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-capacityreservationfleet-tagspecification.html#cfn-ec2-capacityreservationfleet-tagspecification-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
The tags to apply to a resource when the resource is being created.
When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.
> The `Valid Values` lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error.
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"
tagSpecificationProperty := &TagSpecificationProperty{
ResourceType: jsii.String("resourceType"),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
type CfnCapacityReservationProps ¶
type CfnCapacityReservationProps struct {
// The Availability Zone in which to create the Capacity Reservation.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-availabilityzone
//
AvailabilityZone *string `field:"required" json:"availabilityZone" yaml:"availabilityZone"`
// The number of instances for which to reserve capacity.
//
// Valid range: 1 - 1000.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-instancecount
//
InstanceCount *float64 `field:"required" json:"instanceCount" yaml:"instanceCount"`
// The type of operating system for which to reserve capacity.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-instanceplatform
//
InstancePlatform *string `field:"required" json:"instancePlatform" yaml:"instancePlatform"`
// The instance type for which to reserve capacity.
//
// For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-instancetype
//
InstanceType *string `field:"required" json:"instanceType" yaml:"instanceType"`
// Indicates whether the Capacity Reservation supports EBS-optimized instances.
//
// This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS- optimized instance.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-ebsoptimized
//
EbsOptimized interface{} `field:"optional" json:"ebsOptimized" yaml:"ebsOptimized"`
// The date and time at which the Capacity Reservation expires.
//
// When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to `expired` when it reaches its end date and time.
//
// You must provide an `EndDate` value if `EndDateType` is `limited` . Omit `EndDate` if `EndDateType` is `unlimited` .
//
// If the `EndDateType` is `limited` , the Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify 5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-enddate
//
EndDate *string `field:"optional" json:"endDate" yaml:"endDate"`
// Indicates the way in which the Capacity Reservation ends.
//
// A Capacity Reservation can have one of the following end types:
//
// - `unlimited` - The Capacity Reservation remains active until you explicitly cancel it. Do not provide an `EndDate` if the `EndDateType` is `unlimited` .
// - `limited` - The Capacity Reservation expires automatically at a specified date and time. You must provide an `EndDate` value if the `EndDateType` value is `limited` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-enddatetype
//
EndDateType *string `field:"optional" json:"endDateType" yaml:"endDateType"`
// *Deprecated.*.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-ephemeralstorage
//
EphemeralStorage interface{} `field:"optional" json:"ephemeralStorage" yaml:"ephemeralStorage"`
// Indicates the type of instance launches that the Capacity Reservation accepts. The options include:.
//
// - `open` - The Capacity Reservation automatically matches all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes run in the Capacity Reservation automatically without specifying any additional parameters.
// - `targeted` - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.
//
// Default: `open`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-instancematchcriteria
//
InstanceMatchCriteria *string `field:"optional" json:"instanceMatchCriteria" yaml:"instanceMatchCriteria"`
// The Amazon Resource Name (ARN) of the Outpost on which to create the Capacity Reservation.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-outpostarn
//
OutPostArn *string `field:"optional" json:"outPostArn" yaml:"outPostArn"`
// The Amazon Resource Name (ARN) of the cluster placement group in which to create the Capacity Reservation.
//
// For more information, see [Capacity Reservations for cluster placement groups](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/cr-cpg.html) in the *Amazon EC2 User Guide* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-placementgrouparn
//
PlacementGroupArn *string `field:"optional" json:"placementGroupArn" yaml:"placementGroupArn"`
// The tags to apply to the Capacity Reservation during launch.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-tagspecifications
//
TagSpecifications interface{} `field:"optional" json:"tagSpecifications" yaml:"tagSpecifications"`
// Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:.
//
// - `default` - The Capacity Reservation is created on hardware that is shared with other AWS accounts .
// - `dedicated` - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single AWS account .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-tenancy
//
Tenancy *string `field:"optional" json:"tenancy" yaml:"tenancy"`
}
Properties for defining a `CfnCapacityReservation`.
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"
cfnCapacityReservationProps := &CfnCapacityReservationProps{
AvailabilityZone: jsii.String("availabilityZone"),
InstanceCount: jsii.Number(123),
InstancePlatform: jsii.String("instancePlatform"),
InstanceType: jsii.String("instanceType"),
// the properties below are optional
EbsOptimized: jsii.Boolean(false),
EndDate: jsii.String("endDate"),
EndDateType: jsii.String("endDateType"),
EphemeralStorage: jsii.Boolean(false),
InstanceMatchCriteria: jsii.String("instanceMatchCriteria"),
OutPostArn: jsii.String("outPostArn"),
PlacementGroupArn: jsii.String("placementGroupArn"),
TagSpecifications: []interface{}{
&TagSpecificationProperty{
ResourceType: jsii.String("resourceType"),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
},
},
Tenancy: jsii.String("tenancy"),
}
type CfnCapacityReservation_TagSpecificationProperty ¶
type CfnCapacityReservation_TagSpecificationProperty struct {
// The type of resource to tag.
//
// Specify `capacity-reservation` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-capacityreservation-tagspecification.html#cfn-ec2-capacityreservation-tagspecification-resourcetype
//
ResourceType *string `field:"optional" json:"resourceType" yaml:"resourceType"`
// The tags to apply to the resource.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-capacityreservation-tagspecification.html#cfn-ec2-capacityreservation-tagspecification-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
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) .
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"
tagSpecificationProperty := &TagSpecificationProperty{
ResourceType: jsii.String("resourceType"),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
type CfnCarrierGateway ¶
type CfnCarrierGateway interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggable
// The ID of the carrier gateway.
AttrCarrierGatewayId() *string
// The AWS account ID of the owner of the carrier gateway.
AttrOwnerId() *string
// The state of the carrier gateway.
AttrState() *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
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
// The tags assigned to the carrier gateway.
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 ID of the VPC associated with the carrier gateway.
VpcId() *string
SetVpcId(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{})
}
Creates a carrier gateway.
For more information about carrier gateways, see [Carrier gateways](https://docs.aws.amazon.com/wavelength/latest/developerguide/how-wavelengths-work.html#wavelength-carrier-gateway) in the *AWS Wavelength 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"
cfnCarrierGateway := awscdk.Aws_ec2.NewCfnCarrierGateway(this, jsii.String("MyCfnCarrierGateway"), &CfnCarrierGatewayProps{
VpcId: jsii.String("vpcId"),
// the properties below are optional
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-carriergateway.html
func NewCfnCarrierGateway ¶
func NewCfnCarrierGateway(scope constructs.Construct, id *string, props *CfnCarrierGatewayProps) CfnCarrierGateway
type CfnCarrierGatewayProps ¶
type CfnCarrierGatewayProps struct {
// The ID of the VPC associated with the carrier gateway.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-carriergateway.html#cfn-ec2-carriergateway-vpcid
//
VpcId *string `field:"required" json:"vpcId" yaml:"vpcId"`
// The tags assigned to the carrier gateway.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-carriergateway.html#cfn-ec2-carriergateway-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnCarrierGateway`.
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"
cfnCarrierGatewayProps := &CfnCarrierGatewayProps{
VpcId: jsii.String("vpcId"),
// the properties below are optional
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-carriergateway.html
type CfnClientVpnAuthorizationRule ¶
type CfnClientVpnAuthorizationRule interface {
awscdk.CfnResource
awscdk.IInspectable
// The ID of the group to grant access to, for example, the Active Directory group or identity provider (IdP) group.
AccessGroupId() *string
SetAccessGroupId(val *string)
AttrId() *string
// Indicates whether to grant access to all clients.
AuthorizeAllGroups() interface{}
SetAuthorizeAllGroups(val interface{})
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// The ID of the Client VPN endpoint.
ClientVpnEndpointId() *string
SetClientVpnEndpointId(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
// A brief description of the authorization rule.
Description() *string
SetDescription(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
// The IPv4 address range, in CIDR notation, of the network for which access is being authorized.
TargetNetworkCidr() *string
SetTargetNetworkCidr(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{})
}
Specifies an ingress authorization rule to add to a Client VPN endpoint.
Ingress authorization rules act as firewall rules that grant access to networks. You must configure ingress authorization rules to enable clients to access resources in AWS or on-premises networks.
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"
cfnClientVpnAuthorizationRule := awscdk.Aws_ec2.NewCfnClientVpnAuthorizationRule(this, jsii.String("MyCfnClientVpnAuthorizationRule"), &CfnClientVpnAuthorizationRuleProps{
ClientVpnEndpointId: jsii.String("clientVpnEndpointId"),
TargetNetworkCidr: jsii.String("targetNetworkCidr"),
// the properties below are optional
AccessGroupId: jsii.String("accessGroupId"),
AuthorizeAllGroups: jsii.Boolean(false),
Description: jsii.String("description"),
})
func NewCfnClientVpnAuthorizationRule ¶
func NewCfnClientVpnAuthorizationRule(scope constructs.Construct, id *string, props *CfnClientVpnAuthorizationRuleProps) CfnClientVpnAuthorizationRule
type CfnClientVpnAuthorizationRuleProps ¶
type CfnClientVpnAuthorizationRuleProps struct {
// The ID of the Client VPN endpoint.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnauthorizationrule.html#cfn-ec2-clientvpnauthorizationrule-clientvpnendpointid
//
ClientVpnEndpointId *string `field:"required" json:"clientVpnEndpointId" yaml:"clientVpnEndpointId"`
// The IPv4 address range, in CIDR notation, of the network for which access is being authorized.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnauthorizationrule.html#cfn-ec2-clientvpnauthorizationrule-targetnetworkcidr
//
TargetNetworkCidr *string `field:"required" json:"targetNetworkCidr" yaml:"targetNetworkCidr"`
// The ID of the group to grant access to, for example, the Active Directory group or identity provider (IdP) group.
//
// Required if `AuthorizeAllGroups` is `false` or not specified.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnauthorizationrule.html#cfn-ec2-clientvpnauthorizationrule-accessgroupid
//
AccessGroupId *string `field:"optional" json:"accessGroupId" yaml:"accessGroupId"`
// Indicates whether to grant access to all clients.
//
// Specify `true` to grant all clients who successfully establish a VPN connection access to the network. Must be set to `true` if `AccessGroupId` is not specified.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnauthorizationrule.html#cfn-ec2-clientvpnauthorizationrule-authorizeallgroups
//
AuthorizeAllGroups interface{} `field:"optional" json:"authorizeAllGroups" yaml:"authorizeAllGroups"`
// A brief description of the authorization rule.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnauthorizationrule.html#cfn-ec2-clientvpnauthorizationrule-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
}
Properties for defining a `CfnClientVpnAuthorizationRule`.
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"
cfnClientVpnAuthorizationRuleProps := &CfnClientVpnAuthorizationRuleProps{
ClientVpnEndpointId: jsii.String("clientVpnEndpointId"),
TargetNetworkCidr: jsii.String("targetNetworkCidr"),
// the properties below are optional
AccessGroupId: jsii.String("accessGroupId"),
AuthorizeAllGroups: jsii.Boolean(false),
Description: jsii.String("description"),
}
type CfnClientVpnEndpoint ¶
type CfnClientVpnEndpoint interface {
awscdk.CfnResource
awscdk.IInspectable
AttrId() *string
// Information about the authentication method to be used to authenticate clients.
AuthenticationOptions() interface{}
SetAuthenticationOptions(val interface{})
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// The IPv4 address range, in CIDR notation, from which to assign client IP addresses.
ClientCidrBlock() *string
SetClientCidrBlock(val *string)
// The options for managing connection authorization for new client connections.
ClientConnectOptions() interface{}
SetClientConnectOptions(val interface{})
// Options for enabling a customizable text banner that will be displayed on AWS provided clients when a VPN session is established.
ClientLoginBannerOptions() interface{}
SetClientLoginBannerOptions(val interface{})
// Information about the client connection logging options.
ConnectionLogOptions() interface{}
SetConnectionLogOptions(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 brief description of the Client VPN endpoint.
Description() *string
SetDescription(val *string)
// Information about the DNS servers to be used for DNS resolution.
DnsServers() *[]*string
SetDnsServers(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 IDs of one or more security groups to apply to the target network.
SecurityGroupIds() *[]*string
SetSecurityGroupIds(val *[]*string)
// Specify whether to enable the self-service portal for the Client VPN endpoint.
SelfServicePortal() *string
SetSelfServicePortal(val *string)
// The ARN of the server certificate.
ServerCertificateArn() *string
SetServerCertificateArn(val *string)
// The maximum VPN session duration time in hours.
SessionTimeoutHours() *float64
SetSessionTimeoutHours(val *float64)
// Indicates whether split-tunnel is enabled on the AWS Client VPN endpoint.
SplitTunnel() interface{}
SetSplitTunnel(val interface{})
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// The tags to apply to the Client VPN endpoint during creation.
TagSpecifications() interface{}
SetTagSpecifications(val interface{})
// The transport protocol to be used by the VPN session.
TransportProtocol() *string
SetTransportProtocol(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{}
// The ID of the VPC to associate with the Client VPN endpoint.
VpcId() *string
SetVpcId(val *string)
// The port number to assign to the Client VPN endpoint for TCP and UDP traffic.
VpnPort() *float64
SetVpnPort(val *float64)
// 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{})
}
Specifies a Client VPN endpoint.
A Client VPN endpoint is the resource you create and configure to enable and manage client VPN sessions. It is the destination endpoint at which all client VPN sessions are terminated.
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"
cfnClientVpnEndpoint := awscdk.Aws_ec2.NewCfnClientVpnEndpoint(this, jsii.String("MyCfnClientVpnEndpoint"), &CfnClientVpnEndpointProps{
AuthenticationOptions: []interface{}{
&ClientAuthenticationRequestProperty{
Type: jsii.String("type"),
// the properties below are optional
ActiveDirectory: &DirectoryServiceAuthenticationRequestProperty{
DirectoryId: jsii.String("directoryId"),
},
FederatedAuthentication: &FederatedAuthenticationRequestProperty{
SamlProviderArn: jsii.String("samlProviderArn"),
// the properties below are optional
SelfServiceSamlProviderArn: jsii.String("selfServiceSamlProviderArn"),
},
MutualAuthentication: &CertificateAuthenticationRequestProperty{
ClientRootCertificateChainArn: jsii.String("clientRootCertificateChainArn"),
},
},
},
ClientCidrBlock: jsii.String("clientCidrBlock"),
ConnectionLogOptions: &ConnectionLogOptionsProperty{
Enabled: jsii.Boolean(false),
// the properties below are optional
CloudwatchLogGroup: jsii.String("cloudwatchLogGroup"),
CloudwatchLogStream: jsii.String("cloudwatchLogStream"),
},
ServerCertificateArn: jsii.String("serverCertificateArn"),
// the properties below are optional
ClientConnectOptions: &ClientConnectOptionsProperty{
Enabled: jsii.Boolean(false),
// the properties below are optional
LambdaFunctionArn: jsii.String("lambdaFunctionArn"),
},
ClientLoginBannerOptions: &ClientLoginBannerOptionsProperty{
Enabled: jsii.Boolean(false),
// the properties below are optional
BannerText: jsii.String("bannerText"),
},
Description: jsii.String("description"),
DnsServers: []*string{
jsii.String("dnsServers"),
},
SecurityGroupIds: []*string{
jsii.String("securityGroupIds"),
},
SelfServicePortal: jsii.String("selfServicePortal"),
SessionTimeoutHours: jsii.Number(123),
SplitTunnel: jsii.Boolean(false),
TagSpecifications: []interface{}{
&TagSpecificationProperty{
ResourceType: jsii.String("resourceType"),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
},
},
TransportProtocol: jsii.String("transportProtocol"),
VpcId: jsii.String("vpcId"),
VpnPort: jsii.Number(123),
})
func NewCfnClientVpnEndpoint ¶
func NewCfnClientVpnEndpoint(scope constructs.Construct, id *string, props *CfnClientVpnEndpointProps) CfnClientVpnEndpoint
type CfnClientVpnEndpointProps ¶
type CfnClientVpnEndpointProps struct {
// Information about the authentication method to be used to authenticate clients.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-authenticationoptions
//
AuthenticationOptions interface{} `field:"required" json:"authenticationOptions" yaml:"authenticationOptions"`
// The IPv4 address range, in CIDR notation, from which to assign client IP addresses.
//
// The address range cannot overlap with the local CIDR of the VPC in which the associated subnet is located, or the routes that you add manually. The address range cannot be changed after the Client VPN endpoint has been created. Client CIDR range must have a size of at least /22 and must not be greater than /12.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-clientcidrblock
//
ClientCidrBlock *string `field:"required" json:"clientCidrBlock" yaml:"clientCidrBlock"`
// Information about the client connection logging options.
//
// If you enable client connection logging, data about client connections is sent to a Cloudwatch Logs log stream. The following information is logged:
//
// - Client connection requests
// - Client connection results (successful and unsuccessful)
// - Reasons for unsuccessful client connection requests
// - Client connection termination time.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-connectionlogoptions
//
ConnectionLogOptions interface{} `field:"required" json:"connectionLogOptions" yaml:"connectionLogOptions"`
// The ARN of the server certificate.
//
// For more information, see the [AWS Certificate Manager User Guide](https://docs.aws.amazon.com/acm/latest/userguide/) .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-servercertificatearn
//
ServerCertificateArn *string `field:"required" json:"serverCertificateArn" yaml:"serverCertificateArn"`
// The options for managing connection authorization for new client connections.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-clientconnectoptions
//
ClientConnectOptions interface{} `field:"optional" json:"clientConnectOptions" yaml:"clientConnectOptions"`
// Options for enabling a customizable text banner that will be displayed on AWS provided clients when a VPN session is established.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-clientloginbanneroptions
//
ClientLoginBannerOptions interface{} `field:"optional" json:"clientLoginBannerOptions" yaml:"clientLoginBannerOptions"`
// A brief description of the Client VPN endpoint.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// Information about the DNS servers to be used for DNS resolution.
//
// A Client VPN endpoint can have up to two DNS servers. If no DNS server is specified, the DNS address configured on the device is used for the DNS server.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-dnsservers
//
DnsServers *[]*string `field:"optional" json:"dnsServers" yaml:"dnsServers"`
// The IDs of one or more security groups to apply to the target network.
//
// You must also specify the ID of the VPC that contains the security groups.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-securitygroupids
//
SecurityGroupIds *[]*string `field:"optional" json:"securityGroupIds" yaml:"securityGroupIds"`
// Specify whether to enable the self-service portal for the Client VPN endpoint.
//
// Default Value: `enabled`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-selfserviceportal
//
SelfServicePortal *string `field:"optional" json:"selfServicePortal" yaml:"selfServicePortal"`
// The maximum VPN session duration time in hours.
//
// Valid values: `8 | 10 | 12 | 24`
//
// Default value: `24`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-sessiontimeouthours
//
SessionTimeoutHours *float64 `field:"optional" json:"sessionTimeoutHours" yaml:"sessionTimeoutHours"`
// Indicates whether split-tunnel is enabled on the AWS Client VPN endpoint.
//
// By default, split-tunnel on a VPN endpoint is disabled.
//
// For information about split-tunnel VPN endpoints, see [Split-tunnel AWS Client VPN endpoint](https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/split-tunnel-vpn.html) in the *AWS Client VPN Administrator Guide* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-splittunnel
//
SplitTunnel interface{} `field:"optional" json:"splitTunnel" yaml:"splitTunnel"`
// The tags to apply to the Client VPN endpoint during creation.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-tagspecifications
//
TagSpecifications interface{} `field:"optional" json:"tagSpecifications" yaml:"tagSpecifications"`
// The transport protocol to be used by the VPN session.
//
// Default value: `udp`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-transportprotocol
//
TransportProtocol *string `field:"optional" json:"transportProtocol" yaml:"transportProtocol"`
// The ID of the VPC to associate with the Client VPN endpoint.
//
// If no security group IDs are specified in the request, the default security group for the VPC is applied.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-vpcid
//
VpcId *string `field:"optional" json:"vpcId" yaml:"vpcId"`
// The port number to assign to the Client VPN endpoint for TCP and UDP traffic.
//
// Valid Values: `443` | `1194`
//
// Default Value: `443`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-vpnport
//
VpnPort *float64 `field:"optional" json:"vpnPort" yaml:"vpnPort"`
}
Properties for defining a `CfnClientVpnEndpoint`.
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"
cfnClientVpnEndpointProps := &CfnClientVpnEndpointProps{
AuthenticationOptions: []interface{}{
&ClientAuthenticationRequestProperty{
Type: jsii.String("type"),
// the properties below are optional
ActiveDirectory: &DirectoryServiceAuthenticationRequestProperty{
DirectoryId: jsii.String("directoryId"),
},
FederatedAuthentication: &FederatedAuthenticationRequestProperty{
SamlProviderArn: jsii.String("samlProviderArn"),
// the properties below are optional
SelfServiceSamlProviderArn: jsii.String("selfServiceSamlProviderArn"),
},
MutualAuthentication: &CertificateAuthenticationRequestProperty{
ClientRootCertificateChainArn: jsii.String("clientRootCertificateChainArn"),
},
},
},
ClientCidrBlock: jsii.String("clientCidrBlock"),
ConnectionLogOptions: &ConnectionLogOptionsProperty{
Enabled: jsii.Boolean(false),
// the properties below are optional
CloudwatchLogGroup: jsii.String("cloudwatchLogGroup"),
CloudwatchLogStream: jsii.String("cloudwatchLogStream"),
},
ServerCertificateArn: jsii.String("serverCertificateArn"),
// the properties below are optional
ClientConnectOptions: &ClientConnectOptionsProperty{
Enabled: jsii.Boolean(false),
// the properties below are optional
LambdaFunctionArn: jsii.String("lambdaFunctionArn"),
},
ClientLoginBannerOptions: &ClientLoginBannerOptionsProperty{
Enabled: jsii.Boolean(false),
// the properties below are optional
BannerText: jsii.String("bannerText"),
},
Description: jsii.String("description"),
DnsServers: []*string{
jsii.String("dnsServers"),
},
SecurityGroupIds: []*string{
jsii.String("securityGroupIds"),
},
SelfServicePortal: jsii.String("selfServicePortal"),
SessionTimeoutHours: jsii.Number(123),
SplitTunnel: jsii.Boolean(false),
TagSpecifications: []interface{}{
&TagSpecificationProperty{
ResourceType: jsii.String("resourceType"),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
},
},
TransportProtocol: jsii.String("transportProtocol"),
VpcId: jsii.String("vpcId"),
VpnPort: jsii.Number(123),
}
type CfnClientVpnEndpoint_CertificateAuthenticationRequestProperty ¶
type CfnClientVpnEndpoint_CertificateAuthenticationRequestProperty struct {
// The ARN of the client certificate.
//
// The certificate must be signed by a certificate authority (CA) and it must be provisioned in AWS Certificate Manager (ACM).
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-certificateauthenticationrequest.html#cfn-ec2-clientvpnendpoint-certificateauthenticationrequest-clientrootcertificatechainarn
//
ClientRootCertificateChainArn *string `field:"required" json:"clientRootCertificateChainArn" yaml:"clientRootCertificateChainArn"`
}
Information about the client certificate to be used for authentication.
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"
certificateAuthenticationRequestProperty := &CertificateAuthenticationRequestProperty{
ClientRootCertificateChainArn: jsii.String("clientRootCertificateChainArn"),
}
type CfnClientVpnEndpoint_ClientAuthenticationRequestProperty ¶
type CfnClientVpnEndpoint_ClientAuthenticationRequestProperty struct {
// The type of client authentication to be used.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-clientauthenticationrequest.html#cfn-ec2-clientvpnendpoint-clientauthenticationrequest-type
//
Type *string `field:"required" json:"type" yaml:"type"`
// Information about the Active Directory to be used, if applicable.
//
// You must provide this information if *Type* is `directory-service-authentication` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-clientauthenticationrequest.html#cfn-ec2-clientvpnendpoint-clientauthenticationrequest-activedirectory
//
ActiveDirectory interface{} `field:"optional" json:"activeDirectory" yaml:"activeDirectory"`
// Information about the IAM SAML identity provider, if applicable.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-clientauthenticationrequest.html#cfn-ec2-clientvpnendpoint-clientauthenticationrequest-federatedauthentication
//
FederatedAuthentication interface{} `field:"optional" json:"federatedAuthentication" yaml:"federatedAuthentication"`
// Information about the authentication certificates to be used, if applicable.
//
// You must provide this information if *Type* is `certificate-authentication` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-clientauthenticationrequest.html#cfn-ec2-clientvpnendpoint-clientauthenticationrequest-mutualauthentication
//
MutualAuthentication interface{} `field:"optional" json:"mutualAuthentication" yaml:"mutualAuthentication"`
}
Describes the authentication method to be used by a Client VPN endpoint.
For more information, see [Authentication](https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/authentication-authrization.html#client-authentication) in the *AWS Client VPN Administrator 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"
clientAuthenticationRequestProperty := &ClientAuthenticationRequestProperty{
Type: jsii.String("type"),
// the properties below are optional
ActiveDirectory: &DirectoryServiceAuthenticationRequestProperty{
DirectoryId: jsii.String("directoryId"),
},
FederatedAuthentication: &FederatedAuthenticationRequestProperty{
SamlProviderArn: jsii.String("samlProviderArn"),
// the properties below are optional
SelfServiceSamlProviderArn: jsii.String("selfServiceSamlProviderArn"),
},
MutualAuthentication: &CertificateAuthenticationRequestProperty{
ClientRootCertificateChainArn: jsii.String("clientRootCertificateChainArn"),
},
}
type CfnClientVpnEndpoint_ClientConnectOptionsProperty ¶
type CfnClientVpnEndpoint_ClientConnectOptionsProperty struct {
// Indicates whether client connect options are enabled.
//
// The default is `false` (not enabled).
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-clientconnectoptions.html#cfn-ec2-clientvpnendpoint-clientconnectoptions-enabled
//
Enabled interface{} `field:"required" json:"enabled" yaml:"enabled"`
// The Amazon Resource Name (ARN) of the AWS Lambda function used for connection authorization.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-clientconnectoptions.html#cfn-ec2-clientvpnendpoint-clientconnectoptions-lambdafunctionarn
//
LambdaFunctionArn *string `field:"optional" json:"lambdaFunctionArn" yaml:"lambdaFunctionArn"`
}
Indicates whether client connect options are enabled.
The default is `false` (not enabled).
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"
clientConnectOptionsProperty := &ClientConnectOptionsProperty{
Enabled: jsii.Boolean(false),
// the properties below are optional
LambdaFunctionArn: jsii.String("lambdaFunctionArn"),
}
type CfnClientVpnEndpoint_ClientLoginBannerOptionsProperty ¶ added in v2.9.0
type CfnClientVpnEndpoint_ClientLoginBannerOptionsProperty struct {
// Enable or disable a customizable text banner that will be displayed on AWS provided clients when a VPN session is established.
//
// Valid values: `true | false`
//
// Default value: `false`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-clientloginbanneroptions.html#cfn-ec2-clientvpnendpoint-clientloginbanneroptions-enabled
//
Enabled interface{} `field:"required" json:"enabled" yaml:"enabled"`
// Customizable text that will be displayed in a banner on AWS provided clients when a VPN session is established.
//
// UTF-8 encoded characters only. Maximum of 1400 characters.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-clientloginbanneroptions.html#cfn-ec2-clientvpnendpoint-clientloginbanneroptions-bannertext
//
BannerText *string `field:"optional" json:"bannerText" yaml:"bannerText"`
}
Options for enabling a customizable text banner that will be displayed on AWS provided clients when a VPN session is established.
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"
clientLoginBannerOptionsProperty := &ClientLoginBannerOptionsProperty{
Enabled: jsii.Boolean(false),
// the properties below are optional
BannerText: jsii.String("bannerText"),
}
type CfnClientVpnEndpoint_ConnectionLogOptionsProperty ¶
type CfnClientVpnEndpoint_ConnectionLogOptionsProperty struct {
// Indicates whether connection logging is enabled.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-connectionlogoptions.html#cfn-ec2-clientvpnendpoint-connectionlogoptions-enabled
//
Enabled interface{} `field:"required" json:"enabled" yaml:"enabled"`
// The name of the CloudWatch Logs log group.
//
// Required if connection logging is enabled.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-connectionlogoptions.html#cfn-ec2-clientvpnendpoint-connectionlogoptions-cloudwatchloggroup
//
CloudwatchLogGroup *string `field:"optional" json:"cloudwatchLogGroup" yaml:"cloudwatchLogGroup"`
// The name of the CloudWatch Logs log stream to which the connection data is published.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-connectionlogoptions.html#cfn-ec2-clientvpnendpoint-connectionlogoptions-cloudwatchlogstream
//
CloudwatchLogStream *string `field:"optional" json:"cloudwatchLogStream" yaml:"cloudwatchLogStream"`
}
Describes the client connection logging options for the Client VPN endpoint.
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"
connectionLogOptionsProperty := &ConnectionLogOptionsProperty{
Enabled: jsii.Boolean(false),
// the properties below are optional
CloudwatchLogGroup: jsii.String("cloudwatchLogGroup"),
CloudwatchLogStream: jsii.String("cloudwatchLogStream"),
}
type CfnClientVpnEndpoint_DirectoryServiceAuthenticationRequestProperty ¶
type CfnClientVpnEndpoint_DirectoryServiceAuthenticationRequestProperty struct {
// The ID of the Active Directory to be used for authentication.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-directoryserviceauthenticationrequest.html#cfn-ec2-clientvpnendpoint-directoryserviceauthenticationrequest-directoryid
//
DirectoryId *string `field:"required" json:"directoryId" yaml:"directoryId"`
}
Describes the Active Directory to be used for client authentication.
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"
directoryServiceAuthenticationRequestProperty := &DirectoryServiceAuthenticationRequestProperty{
DirectoryId: jsii.String("directoryId"),
}
type CfnClientVpnEndpoint_FederatedAuthenticationRequestProperty ¶
type CfnClientVpnEndpoint_FederatedAuthenticationRequestProperty struct {
// The Amazon Resource Name (ARN) of the IAM SAML identity provider.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-federatedauthenticationrequest.html#cfn-ec2-clientvpnendpoint-federatedauthenticationrequest-samlproviderarn
//
SamlProviderArn *string `field:"required" json:"samlProviderArn" yaml:"samlProviderArn"`
// The Amazon Resource Name (ARN) of the IAM SAML identity provider for the self-service portal.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-federatedauthenticationrequest.html#cfn-ec2-clientvpnendpoint-federatedauthenticationrequest-selfservicesamlproviderarn
//
SelfServiceSamlProviderArn *string `field:"optional" json:"selfServiceSamlProviderArn" yaml:"selfServiceSamlProviderArn"`
}
The IAM SAML identity provider used for federated authentication.
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"
federatedAuthenticationRequestProperty := &FederatedAuthenticationRequestProperty{
SamlProviderArn: jsii.String("samlProviderArn"),
// the properties below are optional
SelfServiceSamlProviderArn: jsii.String("selfServiceSamlProviderArn"),
}
type CfnClientVpnEndpoint_TagSpecificationProperty ¶
type CfnClientVpnEndpoint_TagSpecificationProperty struct {
// The type of resource to tag.
//
// To tag a Client VPN endpoint, `ResourceType` must be `client-vpn-endpoint` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-tagspecification.html#cfn-ec2-clientvpnendpoint-tagspecification-resourcetype
//
ResourceType *string `field:"required" json:"resourceType" yaml:"resourceType"`
// The tags to apply to the resource.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-tagspecification.html#cfn-ec2-clientvpnendpoint-tagspecification-tags
//
Tags *[]*awscdk.CfnTag `field:"required" json:"tags" yaml:"tags"`
}
Specifies the tags to apply to the Client VPN endpoint.
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"
tagSpecificationProperty := &TagSpecificationProperty{
ResourceType: jsii.String("resourceType"),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
type CfnClientVpnRoute ¶
type CfnClientVpnRoute interface {
awscdk.CfnResource
awscdk.IInspectable
AttrId() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// The ID of the Client VPN endpoint to which to add the route.
ClientVpnEndpointId() *string
SetClientVpnEndpointId(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
// A brief description of the route.
Description() *string
SetDescription(val *string)
// The IPv4 address range, in CIDR notation, of the route destination.
//
// For example:.
DestinationCidrBlock() *string
SetDestinationCidrBlock(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
// The ID of the subnet through which you want to route traffic.
TargetVpcSubnetId() *string
SetTargetVpcSubnetId(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{})
}
Specifies a network route to add to a Client VPN endpoint.
Each Client VPN endpoint has a route table that describes the available destination network routes. Each route in the route table specifies the path for traffic to specific resources or networks.
A target network association must be created before you can specify a route. If you're setting up all the components of a Client VPN endpoint at the same time, you must use the [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) to declare a dependency on the `AWS::EC2::ClientVpnTargetNetworkAssociation` resource.
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"
cfnClientVpnRoute := awscdk.Aws_ec2.NewCfnClientVpnRoute(this, jsii.String("MyCfnClientVpnRoute"), &CfnClientVpnRouteProps{
ClientVpnEndpointId: jsii.String("clientVpnEndpointId"),
DestinationCidrBlock: jsii.String("destinationCidrBlock"),
TargetVpcSubnetId: jsii.String("targetVpcSubnetId"),
// the properties below are optional
Description: jsii.String("description"),
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnroute.html
func NewCfnClientVpnRoute ¶
func NewCfnClientVpnRoute(scope constructs.Construct, id *string, props *CfnClientVpnRouteProps) CfnClientVpnRoute
type CfnClientVpnRouteProps ¶
type CfnClientVpnRouteProps struct {
// The ID of the Client VPN endpoint to which to add the route.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnroute.html#cfn-ec2-clientvpnroute-clientvpnendpointid
//
ClientVpnEndpointId *string `field:"required" json:"clientVpnEndpointId" yaml:"clientVpnEndpointId"`
// The IPv4 address range, in CIDR notation, of the route destination. For example:.
//
// - To add a route for Internet access, enter `0.0.0.0/0`
// - To add a route for a peered VPC, enter the peered VPC's IPv4 CIDR range
// - To add a route for an on-premises network, enter the AWS Site-to-Site VPN connection's IPv4 CIDR range
// - To add a route for the local network, enter the client CIDR range.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnroute.html#cfn-ec2-clientvpnroute-destinationcidrblock
//
DestinationCidrBlock *string `field:"required" json:"destinationCidrBlock" yaml:"destinationCidrBlock"`
// The ID of the subnet through which you want to route traffic.
//
// The specified subnet must be an existing target network of the Client VPN endpoint.
//
// Alternatively, if you're adding a route for the local network, specify `local` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnroute.html#cfn-ec2-clientvpnroute-targetvpcsubnetid
//
TargetVpcSubnetId *string `field:"required" json:"targetVpcSubnetId" yaml:"targetVpcSubnetId"`
// A brief description of the route.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnroute.html#cfn-ec2-clientvpnroute-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
}
Properties for defining a `CfnClientVpnRoute`.
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"
cfnClientVpnRouteProps := &CfnClientVpnRouteProps{
ClientVpnEndpointId: jsii.String("clientVpnEndpointId"),
DestinationCidrBlock: jsii.String("destinationCidrBlock"),
TargetVpcSubnetId: jsii.String("targetVpcSubnetId"),
// the properties below are optional
Description: jsii.String("description"),
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnroute.html
type CfnClientVpnTargetNetworkAssociation ¶
type CfnClientVpnTargetNetworkAssociation interface {
awscdk.CfnResource
awscdk.IInspectable
AttrId() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// The ID of the Client VPN endpoint.
ClientVpnEndpointId() *string
SetClientVpnEndpointId(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 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 ID of the subnet to associate with the Client VPN endpoint.
SubnetId() *string
SetSubnetId(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{})
}
Specifies a target network to associate with a Client VPN endpoint.
A target network is a subnet in a VPC. You can associate multiple subnets from the same VPC with a Client VPN endpoint. You can associate only one subnet in each Availability Zone. We recommend that you associate at least two subnets to provide Availability Zone redundancy.
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"
cfnClientVpnTargetNetworkAssociation := awscdk.Aws_ec2.NewCfnClientVpnTargetNetworkAssociation(this, jsii.String("MyCfnClientVpnTargetNetworkAssociation"), &CfnClientVpnTargetNetworkAssociationProps{
ClientVpnEndpointId: jsii.String("clientVpnEndpointId"),
SubnetId: jsii.String("subnetId"),
})
func NewCfnClientVpnTargetNetworkAssociation ¶
func NewCfnClientVpnTargetNetworkAssociation(scope constructs.Construct, id *string, props *CfnClientVpnTargetNetworkAssociationProps) CfnClientVpnTargetNetworkAssociation
type CfnClientVpnTargetNetworkAssociationProps ¶
type CfnClientVpnTargetNetworkAssociationProps struct {
// The ID of the Client VPN endpoint.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpntargetnetworkassociation.html#cfn-ec2-clientvpntargetnetworkassociation-clientvpnendpointid
//
ClientVpnEndpointId *string `field:"required" json:"clientVpnEndpointId" yaml:"clientVpnEndpointId"`
// The ID of the subnet to associate with the Client VPN endpoint.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpntargetnetworkassociation.html#cfn-ec2-clientvpntargetnetworkassociation-subnetid
//
SubnetId *string `field:"required" json:"subnetId" yaml:"subnetId"`
}
Properties for defining a `CfnClientVpnTargetNetworkAssociation`.
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"
cfnClientVpnTargetNetworkAssociationProps := &CfnClientVpnTargetNetworkAssociationProps{
ClientVpnEndpointId: jsii.String("clientVpnEndpointId"),
SubnetId: jsii.String("subnetId"),
}
type CfnCustomerGateway ¶
type CfnCustomerGateway interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggable
// The ID of the customer gateway.
AttrCustomerGatewayId() *string
// For customer gateway devices that support BGP, specify the device's ASN.
BgpAsn() *float64
SetBgpAsn(val *float64)
// For customer gateway devices that support BGP, specify the device's ASN.
BgpAsnExtended() *float64
SetBgpAsnExtended(val *float64)
// The Amazon Resource Name (ARN) for the customer gateway certificate.
CertificateArn() *string
SetCertificateArn(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 customer gateway device.
DeviceName() *string
SetDeviceName(val *string)
// IPv4 address for the customer gateway device's outside interface.
IpAddress() *string
SetIpAddress(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
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
// One or more tags for the customer gateway.
TagsRaw() *[]*awscdk.CfnTag
SetTagsRaw(val *[]*awscdk.CfnTag)
// The type of VPN connection that this customer gateway supports ( `ipsec.1` ).
Type() *string
SetType(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{})
}
Specifies a customer gateway.
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"
cfnCustomerGateway := awscdk.Aws_ec2.NewCfnCustomerGateway(this, jsii.String("MyCfnCustomerGateway"), &CfnCustomerGatewayProps{
IpAddress: jsii.String("ipAddress"),
Type: jsii.String("type"),
// the properties below are optional
BgpAsn: jsii.Number(123),
BgpAsnExtended: jsii.Number(123),
CertificateArn: jsii.String("certificateArn"),
DeviceName: jsii.String("deviceName"),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customergateway.html
func NewCfnCustomerGateway ¶
func NewCfnCustomerGateway(scope constructs.Construct, id *string, props *CfnCustomerGatewayProps) CfnCustomerGateway
type CfnCustomerGatewayProps ¶
type CfnCustomerGatewayProps struct {
// IPv4 address for the customer gateway device's outside interface.
//
// The address must be static. If `OutsideIpAddressType` in your VPN connection options is set to `PrivateIpv4` , you can use an RFC6598 or RFC1918 private IPv4 address. If `OutsideIpAddressType` is set to `PublicIpv4` , you can use a public IPv4 address.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customergateway.html#cfn-ec2-customergateway-ipaddress
//
IpAddress *string `field:"required" json:"ipAddress" yaml:"ipAddress"`
// The type of VPN connection that this customer gateway supports ( `ipsec.1` ).
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customergateway.html#cfn-ec2-customergateway-type
//
Type *string `field:"required" json:"type" yaml:"type"`
// For customer gateway devices that support BGP, specify the device's ASN.
//
// You must specify either `BgpAsn` or `BgpAsnExtended` when creating the customer gateway. If the ASN is larger than `2,147,483,647` , you must use `BgpAsnExtended` .
//
// Default: 65000
//
// Valid values: `1` to `2,147,483,647`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customergateway.html#cfn-ec2-customergateway-bgpasn
//
// Default: - 65000.
//
BgpAsn *float64 `field:"optional" json:"bgpAsn" yaml:"bgpAsn"`
// For customer gateway devices that support BGP, specify the device's ASN.
//
// You must specify either `BgpAsn` or `BgpAsnExtended` when creating the customer gateway. If the ASN is larger than `2,147,483,647` , you must use `BgpAsnExtended` .
//
// Valid values: `2,147,483,648` to `4,294,967,295`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customergateway.html#cfn-ec2-customergateway-bgpasnextended
//
BgpAsnExtended *float64 `field:"optional" json:"bgpAsnExtended" yaml:"bgpAsnExtended"`
// The Amazon Resource Name (ARN) for the customer gateway certificate.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customergateway.html#cfn-ec2-customergateway-certificatearn
//
CertificateArn *string `field:"optional" json:"certificateArn" yaml:"certificateArn"`
// The name of customer gateway device.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customergateway.html#cfn-ec2-customergateway-devicename
//
DeviceName *string `field:"optional" json:"deviceName" yaml:"deviceName"`
// One or more tags for the customer gateway.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customergateway.html#cfn-ec2-customergateway-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnCustomerGateway`.
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"
cfnCustomerGatewayProps := &CfnCustomerGatewayProps{
IpAddress: jsii.String("ipAddress"),
Type: jsii.String("type"),
// the properties below are optional
BgpAsn: jsii.Number(123),
BgpAsnExtended: jsii.Number(123),
CertificateArn: jsii.String("certificateArn"),
DeviceName: jsii.String("deviceName"),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customergateway.html
type CfnDHCPOptions ¶
type CfnDHCPOptions interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggable
// The ID of the DHCP options set.
AttrDhcpOptionsId() *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
// This value is used to complete unqualified DNS hostnames.
DomainName() *string
SetDomainName(val *string)
// The IPv4 addresses of up to four domain name servers, or `AmazonProvidedDNS` .
DomainNameServers() *[]*string
SetDomainNameServers(val *[]*string)
// A value (in seconds, minutes, hours, or years) for how frequently a running instance with an IPv6 assigned to it goes through DHCPv6 lease renewal.
Ipv6AddressPreferredLeaseTime() *float64
SetIpv6AddressPreferredLeaseTime(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 IPv4 addresses of up to four NetBIOS name servers.
NetbiosNameServers() *[]*string
SetNetbiosNameServers(val *[]*string)
// The NetBIOS node type (1, 2, 4, or 8).
NetbiosNodeType() *float64
SetNetbiosNodeType(val *float64)
// The tree node.
Node() constructs.Node
// The IPv4 addresses of up to four Network Time Protocol (NTP) servers.
NtpServers() *[]*string
SetNtpServers(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
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
// Any tags assigned to the DHCP options set.
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{})
}
Specifies a set of DHCP options for your VPC.
You must specify at least one of the following properties: `DomainNameServers` , `NetbiosNameServers` , `NtpServers` . If you specify `NetbiosNameServers` , you must specify `NetbiosNodeType` .
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"
cfnDHCPOptions := awscdk.Aws_ec2.NewCfnDHCPOptions(this, jsii.String("MyCfnDHCPOptions"), &CfnDHCPOptionsProps{
DomainName: jsii.String("domainName"),
DomainNameServers: []*string{
jsii.String("domainNameServers"),
},
Ipv6AddressPreferredLeaseTime: jsii.Number(123),
NetbiosNameServers: []*string{
jsii.String("netbiosNameServers"),
},
NetbiosNodeType: jsii.Number(123),
NtpServers: []*string{
jsii.String("ntpServers"),
},
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-dhcpoptions.html
func NewCfnDHCPOptions ¶
func NewCfnDHCPOptions(scope constructs.Construct, id *string, props *CfnDHCPOptionsProps) CfnDHCPOptions
type CfnDHCPOptionsProps ¶
type CfnDHCPOptionsProps struct {
// This value is used to complete unqualified DNS hostnames.
//
// If you're using AmazonProvidedDNS in `us-east-1` , specify `ec2.internal` . If you're using AmazonProvidedDNS in another Region, specify *region* . `compute.internal` (for example, `ap-northeast-1.compute.internal` ). Otherwise, specify a domain name (for example, *MyCompany.com* ).
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-dhcpoptions.html#cfn-ec2-dhcpoptions-domainname
//
DomainName *string `field:"optional" json:"domainName" yaml:"domainName"`
// The IPv4 addresses of up to four domain name servers, or `AmazonProvidedDNS` .
//
// The default is `AmazonProvidedDNS` . To have your instance receive a custom DNS hostname as specified in `DomainName` , you must set this property to a custom DNS server.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-dhcpoptions.html#cfn-ec2-dhcpoptions-domainnameservers
//
DomainNameServers *[]*string `field:"optional" json:"domainNameServers" yaml:"domainNameServers"`
// A value (in seconds, minutes, hours, or years) for how frequently a running instance with an IPv6 assigned to it goes through DHCPv6 lease renewal.
//
// Acceptable values are between 140 and 2147483647 seconds (approximately 68 years). If no value is entered, the default lease time is 140 seconds. If you use long-term addressing for EC2 instances, you can increase the lease time and avoid frequent lease renewal requests. Lease renewal typically occurs when half of the lease time has elapsed.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-dhcpoptions.html#cfn-ec2-dhcpoptions-ipv6addresspreferredleasetime
//
Ipv6AddressPreferredLeaseTime *float64 `field:"optional" json:"ipv6AddressPreferredLeaseTime" yaml:"ipv6AddressPreferredLeaseTime"`
// The IPv4 addresses of up to four NetBIOS name servers.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-dhcpoptions.html#cfn-ec2-dhcpoptions-netbiosnameservers
//
NetbiosNameServers *[]*string `field:"optional" json:"netbiosNameServers" yaml:"netbiosNameServers"`
// The NetBIOS node type (1, 2, 4, or 8).
//
// We recommend that you specify 2 (broadcast and multicast are not currently supported).
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-dhcpoptions.html#cfn-ec2-dhcpoptions-netbiosnodetype
//
NetbiosNodeType *float64 `field:"optional" json:"netbiosNodeType" yaml:"netbiosNodeType"`
// The IPv4 addresses of up to four Network Time Protocol (NTP) servers.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-dhcpoptions.html#cfn-ec2-dhcpoptions-ntpservers
//
NtpServers *[]*string `field:"optional" json:"ntpServers" yaml:"ntpServers"`
// Any tags assigned to the DHCP options set.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-dhcpoptions.html#cfn-ec2-dhcpoptions-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnDHCPOptions`.
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"
cfnDHCPOptionsProps := &CfnDHCPOptionsProps{
DomainName: jsii.String("domainName"),
DomainNameServers: []*string{
jsii.String("domainNameServers"),
},
Ipv6AddressPreferredLeaseTime: jsii.Number(123),
NetbiosNameServers: []*string{
jsii.String("netbiosNameServers"),
},
NetbiosNodeType: jsii.Number(123),
NtpServers: []*string{
jsii.String("ntpServers"),
},
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-dhcpoptions.html
type CfnEC2Fleet ¶
type CfnEC2Fleet interface {
awscdk.CfnResource
awscdk.IInspectable
// The ID of the EC2 Fleet.
AttrFleetId() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// Reserved.
Context() *string
SetContext(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
// Indicates whether running instances should be terminated if the total target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet.
ExcessCapacityTerminationPolicy() *string
SetExcessCapacityTerminationPolicy(val *string)
// The configuration for the EC2 Fleet.
LaunchTemplateConfigs() interface{}
SetLaunchTemplateConfigs(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
// Describes the configuration of On-Demand Instances in an EC2 Fleet.
OnDemandOptions() interface{}
SetOnDemandOptions(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
// Indicates whether EC2 Fleet should replace unhealthy Spot Instances.
ReplaceUnhealthyInstances() interface{}
SetReplaceUnhealthyInstances(val interface{})
// Describes the configuration of Spot Instances in an EC2 Fleet.
SpotOptions() interface{}
SetSpotOptions(val interface{})
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// The key-value pair for tagging the EC2 Fleet request on creation.
//
// For more information, see [Tag your resources](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#tag-resources) .
TagSpecifications() interface{}
SetTagSpecifications(val interface{})
// The number of units to request.
TargetCapacitySpecification() interface{}
SetTargetCapacitySpecification(val interface{})
// Indicates whether running instances should be terminated when the EC2 Fleet expires.
TerminateInstancesWithExpiration() interface{}
SetTerminateInstancesWithExpiration(val interface{})
// The fleet type.
//
// The default value is `maintain` .
Type() *string
SetType(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{}
// The start date and time of the request, in UTC format (for example, *YYYY* - *MM* - *DD* T *HH* : *MM* : *SS* Z).
ValidFrom() *string
SetValidFrom(val *string)
// The end date and time of the request, in UTC format (for example, *YYYY* - *MM* - *DD* T *HH* : *MM* : *SS* Z).
ValidUntil() *string
SetValidUntil(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{})
}
Specifies the configuration information to launch a fleet--or group--of instances.
An EC2 Fleet can launch multiple instance types across multiple Availability Zones, using the On-Demand Instance, Reserved Instance, and Spot Instance purchasing models together. Using EC2 Fleet, you can define separate On-Demand and Spot capacity targets, specify the instance types that work best for your applications, and specify how Amazon EC2 should distribute your fleet capacity within each purchasing model. For more information, see [Launching an EC2 Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet.html) in the *Amazon EC2 User 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"
cfnEC2Fleet := awscdk.Aws_ec2.NewCfnEC2Fleet(this, jsii.String("MyCfnEC2Fleet"), &CfnEC2FleetProps{
LaunchTemplateConfigs: []interface{}{
&FleetLaunchTemplateConfigRequestProperty{
LaunchTemplateSpecification: &FleetLaunchTemplateSpecificationRequestProperty{
Version: jsii.String("version"),
// the properties below are optional
LaunchTemplateId: jsii.String("launchTemplateId"),
LaunchTemplateName: jsii.String("launchTemplateName"),
},
Overrides: []interface{}{
&FleetLaunchTemplateOverridesRequestProperty{
AvailabilityZone: jsii.String("availabilityZone"),
InstanceRequirements: &InstanceRequirementsRequestProperty{
AcceleratorCount: &AcceleratorCountRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
AcceleratorManufacturers: []*string{
jsii.String("acceleratorManufacturers"),
},
AcceleratorNames: []*string{
jsii.String("acceleratorNames"),
},
AcceleratorTotalMemoryMiB: &AcceleratorTotalMemoryMiBRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
AcceleratorTypes: []*string{
jsii.String("acceleratorTypes"),
},
AllowedInstanceTypes: []*string{
jsii.String("allowedInstanceTypes"),
},
BareMetal: jsii.String("bareMetal"),
BaselineEbsBandwidthMbps: &BaselineEbsBandwidthMbpsRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
BurstablePerformance: jsii.String("burstablePerformance"),
CpuManufacturers: []*string{
jsii.String("cpuManufacturers"),
},
ExcludedInstanceTypes: []*string{
jsii.String("excludedInstanceTypes"),
},
InstanceGenerations: []*string{
jsii.String("instanceGenerations"),
},
LocalStorage: jsii.String("localStorage"),
LocalStorageTypes: []*string{
jsii.String("localStorageTypes"),
},
MaxSpotPriceAsPercentageOfOptimalOnDemandPrice: jsii.Number(123),
MemoryGiBPerVCpu: &MemoryGiBPerVCpuRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
MemoryMiB: &MemoryMiBRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
NetworkBandwidthGbps: &NetworkBandwidthGbpsRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
NetworkInterfaceCount: &NetworkInterfaceCountRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
OnDemandMaxPricePercentageOverLowestPrice: jsii.Number(123),
RequireHibernateSupport: jsii.Boolean(false),
SpotMaxPricePercentageOverLowestPrice: jsii.Number(123),
TotalLocalStorageGb: &TotalLocalStorageGBRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
VCpuCount: &VCpuCountRangeRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
},
InstanceType: jsii.String("instanceType"),
MaxPrice: jsii.String("maxPrice"),
Placement: &PlacementProperty{
Affinity: jsii.String("affinity"),
AvailabilityZone: jsii.String("availabilityZone"),
GroupName: jsii.String("groupName"),
HostId: jsii.String("hostId"),
HostResourceGroupArn: jsii.String("hostResourceGroupArn"),
PartitionNumber: jsii.Number(123),
SpreadDomain: jsii.String("spreadDomain"),
Tenancy: jsii.String("tenancy"),
},
Priority: jsii.Number(123),
SubnetId: jsii.String("subnetId"),
WeightedCapacity: jsii.Number(123),
},
},
},
},
TargetCapacitySpecification: &TargetCapacitySpecificationRequestProperty{
TotalTargetCapacity: jsii.Number(123),
// the properties below are optional
DefaultTargetCapacityType: jsii.String("defaultTargetCapacityType"),
OnDemandTargetCapacity: jsii.Number(123),
SpotTargetCapacity: jsii.Number(123),
TargetCapacityUnitType: jsii.String("targetCapacityUnitType"),
},
// the properties below are optional
Context: jsii.String("context"),
ExcessCapacityTerminationPolicy: jsii.String("excessCapacityTerminationPolicy"),
OnDemandOptions: &OnDemandOptionsRequestProperty{
AllocationStrategy: jsii.String("allocationStrategy"),
CapacityReservationOptions: &CapacityReservationOptionsRequestProperty{
UsageStrategy: jsii.String("usageStrategy"),
},
MaxTotalPrice: jsii.String("maxTotalPrice"),
MinTargetCapacity: jsii.Number(123),
SingleAvailabilityZone: jsii.Boolean(false),
SingleInstanceType: jsii.Boolean(false),
},
ReplaceUnhealthyInstances: jsii.Boolean(false),
SpotOptions: &SpotOptionsRequestProperty{
AllocationStrategy: jsii.String("allocationStrategy"),
InstanceInterruptionBehavior: jsii.String("instanceInterruptionBehavior"),
InstancePoolsToUseCount: jsii.Number(123),
MaintenanceStrategies: &MaintenanceStrategiesProperty{
CapacityRebalance: &CapacityRebalanceProperty{
ReplacementStrategy: jsii.String("replacementStrategy"),
TerminationDelay: jsii.Number(123),
},
},
MaxTotalPrice: jsii.String("maxTotalPrice"),
MinTargetCapacity: jsii.Number(123),
SingleAvailabilityZone: jsii.Boolean(false),
SingleInstanceType: jsii.Boolean(false),
},
TagSpecifications: []interface{}{
&TagSpecificationProperty{
ResourceType: jsii.String("resourceType"),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
},
},
TerminateInstancesWithExpiration: jsii.Boolean(false),
Type: jsii.String("type"),
ValidFrom: jsii.String("validFrom"),
ValidUntil: jsii.String("validUntil"),
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html
func NewCfnEC2Fleet ¶
func NewCfnEC2Fleet(scope constructs.Construct, id *string, props *CfnEC2FleetProps) CfnEC2Fleet
type CfnEC2FleetProps ¶
type CfnEC2FleetProps struct {
// The configuration for the EC2 Fleet.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html#cfn-ec2-ec2fleet-launchtemplateconfigs
//
LaunchTemplateConfigs interface{} `field:"required" json:"launchTemplateConfigs" yaml:"launchTemplateConfigs"`
// The number of units to request.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html#cfn-ec2-ec2fleet-targetcapacityspecification
//
TargetCapacitySpecification interface{} `field:"required" json:"targetCapacitySpecification" yaml:"targetCapacitySpecification"`
// Reserved.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html#cfn-ec2-ec2fleet-context
//
Context *string `field:"optional" json:"context" yaml:"context"`
// Indicates whether running instances should be terminated if the total target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet.
//
// Supported only for fleets of type `maintain` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html#cfn-ec2-ec2fleet-excesscapacityterminationpolicy
//
ExcessCapacityTerminationPolicy *string `field:"optional" json:"excessCapacityTerminationPolicy" yaml:"excessCapacityTerminationPolicy"`
// Describes the configuration of On-Demand Instances in an EC2 Fleet.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html#cfn-ec2-ec2fleet-ondemandoptions
//
OnDemandOptions interface{} `field:"optional" json:"onDemandOptions" yaml:"onDemandOptions"`
// Indicates whether EC2 Fleet should replace unhealthy Spot Instances.
//
// Supported only for fleets of type `maintain` . For more information, see [EC2 Fleet health checks](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/manage-ec2-fleet.html#ec2-fleet-health-checks) in the *Amazon EC2 User Guide* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html#cfn-ec2-ec2fleet-replaceunhealthyinstances
//
ReplaceUnhealthyInstances interface{} `field:"optional" json:"replaceUnhealthyInstances" yaml:"replaceUnhealthyInstances"`
// Describes the configuration of Spot Instances in an EC2 Fleet.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html#cfn-ec2-ec2fleet-spotoptions
//
SpotOptions interface{} `field:"optional" json:"spotOptions" yaml:"spotOptions"`
// The key-value pair for tagging the EC2 Fleet request on creation. For more information, see [Tag your resources](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#tag-resources) .
//
// If the fleet type is `instant` , specify a resource type of `fleet` to tag the fleet or `instance` to tag the instances at launch.
//
// If the fleet type is `maintain` or `request` , specify a resource type of `fleet` to tag the fleet. You cannot specify a resource type of `instance` . To tag instances at launch, specify the tags in a [launch template](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html#create-launch-template) .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html#cfn-ec2-ec2fleet-tagspecifications
//
TagSpecifications interface{} `field:"optional" json:"tagSpecifications" yaml:"tagSpecifications"`
// Indicates whether running instances should be terminated when the EC2 Fleet expires.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html#cfn-ec2-ec2fleet-terminateinstanceswithexpiration
//
TerminateInstancesWithExpiration interface{} `field:"optional" json:"terminateInstancesWithExpiration" yaml:"terminateInstancesWithExpiration"`
// The fleet type. The default value is `maintain` .
//
// - `maintain` - The EC2 Fleet places an asynchronous request for your desired capacity, and continues to maintain your desired Spot capacity by replenishing interrupted Spot Instances.
// - `request` - The EC2 Fleet places an asynchronous one-time request for your desired capacity, but does submit Spot requests in alternative capacity pools if Spot capacity is unavailable, and does not maintain Spot capacity if Spot Instances are interrupted.
// - `instant` - The EC2 Fleet places a synchronous one-time request for your desired capacity, and returns errors for any instances that could not be launched.
//
// For more information, see [EC2 Fleet request types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-request-type.html) in the *Amazon EC2 User Guide* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html#cfn-ec2-ec2fleet-type
//
Type *string `field:"optional" json:"type" yaml:"type"`
// The start date and time of the request, in UTC format (for example, *YYYY* - *MM* - *DD* T *HH* : *MM* : *SS* Z).
//
// The default is to start fulfilling the request immediately.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html#cfn-ec2-ec2fleet-validfrom
//
ValidFrom *string `field:"optional" json:"validFrom" yaml:"validFrom"`
// The end date and time of the request, in UTC format (for example, *YYYY* - *MM* - *DD* T *HH* : *MM* : *SS* Z).
//
// At this point, no new EC2 Fleet requests are placed or able to fulfill the request. If no value is specified, the request remains until you cancel it.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html#cfn-ec2-ec2fleet-validuntil
//
ValidUntil *string `field:"optional" json:"validUntil" yaml:"validUntil"`
}
Properties for defining a `CfnEC2Fleet`.
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"
cfnEC2FleetProps := &CfnEC2FleetProps{
LaunchTemplateConfigs: []interface{}{
&FleetLaunchTemplateConfigRequestProperty{
LaunchTemplateSpecification: &FleetLaunchTemplateSpecificationRequestProperty{
Version: jsii.String("version"),
// the properties below are optional
LaunchTemplateId: jsii.String("launchTemplateId"),
LaunchTemplateName: jsii.String("launchTemplateName"),
},
Overrides: []interface{}{
&FleetLaunchTemplateOverridesRequestProperty{
AvailabilityZone: jsii.String("availabilityZone"),
InstanceRequirements: &InstanceRequirementsRequestProperty{
AcceleratorCount: &AcceleratorCountRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
AcceleratorManufacturers: []*string{
jsii.String("acceleratorManufacturers"),
},
AcceleratorNames: []*string{
jsii.String("acceleratorNames"),
},
AcceleratorTotalMemoryMiB: &AcceleratorTotalMemoryMiBRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
AcceleratorTypes: []*string{
jsii.String("acceleratorTypes"),
},
AllowedInstanceTypes: []*string{
jsii.String("allowedInstanceTypes"),
},
BareMetal: jsii.String("bareMetal"),
BaselineEbsBandwidthMbps: &BaselineEbsBandwidthMbpsRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
BurstablePerformance: jsii.String("burstablePerformance"),
CpuManufacturers: []*string{
jsii.String("cpuManufacturers"),
},
ExcludedInstanceTypes: []*string{
jsii.String("excludedInstanceTypes"),
},
InstanceGenerations: []*string{
jsii.String("instanceGenerations"),
},
LocalStorage: jsii.String("localStorage"),
LocalStorageTypes: []*string{
jsii.String("localStorageTypes"),
},
MaxSpotPriceAsPercentageOfOptimalOnDemandPrice: jsii.Number(123),
MemoryGiBPerVCpu: &MemoryGiBPerVCpuRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
MemoryMiB: &MemoryMiBRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
NetworkBandwidthGbps: &NetworkBandwidthGbpsRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
NetworkInterfaceCount: &NetworkInterfaceCountRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
OnDemandMaxPricePercentageOverLowestPrice: jsii.Number(123),
RequireHibernateSupport: jsii.Boolean(false),
SpotMaxPricePercentageOverLowestPrice: jsii.Number(123),
TotalLocalStorageGb: &TotalLocalStorageGBRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
VCpuCount: &VCpuCountRangeRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
},
InstanceType: jsii.String("instanceType"),
MaxPrice: jsii.String("maxPrice"),
Placement: &PlacementProperty{
Affinity: jsii.String("affinity"),
AvailabilityZone: jsii.String("availabilityZone"),
GroupName: jsii.String("groupName"),
HostId: jsii.String("hostId"),
HostResourceGroupArn: jsii.String("hostResourceGroupArn"),
PartitionNumber: jsii.Number(123),
SpreadDomain: jsii.String("spreadDomain"),
Tenancy: jsii.String("tenancy"),
},
Priority: jsii.Number(123),
SubnetId: jsii.String("subnetId"),
WeightedCapacity: jsii.Number(123),
},
},
},
},
TargetCapacitySpecification: &TargetCapacitySpecificationRequestProperty{
TotalTargetCapacity: jsii.Number(123),
// the properties below are optional
DefaultTargetCapacityType: jsii.String("defaultTargetCapacityType"),
OnDemandTargetCapacity: jsii.Number(123),
SpotTargetCapacity: jsii.Number(123),
TargetCapacityUnitType: jsii.String("targetCapacityUnitType"),
},
// the properties below are optional
Context: jsii.String("context"),
ExcessCapacityTerminationPolicy: jsii.String("excessCapacityTerminationPolicy"),
OnDemandOptions: &OnDemandOptionsRequestProperty{
AllocationStrategy: jsii.String("allocationStrategy"),
CapacityReservationOptions: &CapacityReservationOptionsRequestProperty{
UsageStrategy: jsii.String("usageStrategy"),
},
MaxTotalPrice: jsii.String("maxTotalPrice"),
MinTargetCapacity: jsii.Number(123),
SingleAvailabilityZone: jsii.Boolean(false),
SingleInstanceType: jsii.Boolean(false),
},
ReplaceUnhealthyInstances: jsii.Boolean(false),
SpotOptions: &SpotOptionsRequestProperty{
AllocationStrategy: jsii.String("allocationStrategy"),
InstanceInterruptionBehavior: jsii.String("instanceInterruptionBehavior"),
InstancePoolsToUseCount: jsii.Number(123),
MaintenanceStrategies: &MaintenanceStrategiesProperty{
CapacityRebalance: &CapacityRebalanceProperty{
ReplacementStrategy: jsii.String("replacementStrategy"),
TerminationDelay: jsii.Number(123),
},
},
MaxTotalPrice: jsii.String("maxTotalPrice"),
MinTargetCapacity: jsii.Number(123),
SingleAvailabilityZone: jsii.Boolean(false),
SingleInstanceType: jsii.Boolean(false),
},
TagSpecifications: []interface{}{
&TagSpecificationProperty{
ResourceType: jsii.String("resourceType"),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
},
},
TerminateInstancesWithExpiration: jsii.Boolean(false),
Type: jsii.String("type"),
ValidFrom: jsii.String("validFrom"),
ValidUntil: jsii.String("validUntil"),
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html
type CfnEC2Fleet_AcceleratorCountRequestProperty ¶
type CfnEC2Fleet_AcceleratorCountRequestProperty struct {
// The maximum number of accelerators.
//
// To specify no maximum limit, omit this parameter. To exclude accelerator-enabled instance types, set `Max` to `0` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-acceleratorcountrequest.html#cfn-ec2-ec2fleet-acceleratorcountrequest-max
//
Max *float64 `field:"optional" json:"max" yaml:"max"`
// The minimum number of accelerators.
//
// To specify no minimum limit, omit this parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-acceleratorcountrequest.html#cfn-ec2-ec2fleet-acceleratorcountrequest-min
//
Min *float64 `field:"optional" json:"min" yaml:"min"`
}
The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) on an instance.
To exclude accelerator-enabled instance types, set `Max` to `0` .
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"
acceleratorCountRequestProperty := &AcceleratorCountRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
}
type CfnEC2Fleet_AcceleratorTotalMemoryMiBRequestProperty ¶
type CfnEC2Fleet_AcceleratorTotalMemoryMiBRequestProperty struct {
// The maximum amount of accelerator memory, in MiB.
//
// To specify no maximum limit, omit this parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-acceleratortotalmemorymibrequest.html#cfn-ec2-ec2fleet-acceleratortotalmemorymibrequest-max
//
Max *float64 `field:"optional" json:"max" yaml:"max"`
// The minimum amount of accelerator memory, in MiB.
//
// To specify no minimum limit, omit this parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-acceleratortotalmemorymibrequest.html#cfn-ec2-ec2fleet-acceleratortotalmemorymibrequest-min
//
Min *float64 `field:"optional" json:"min" yaml:"min"`
}
The minimum and maximum amount of total accelerator memory, in MiB.
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"
acceleratorTotalMemoryMiBRequestProperty := &AcceleratorTotalMemoryMiBRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
}
type CfnEC2Fleet_BaselineEbsBandwidthMbpsRequestProperty ¶
type CfnEC2Fleet_BaselineEbsBandwidthMbpsRequestProperty struct {
// The maximum baseline bandwidth, in Mbps.
//
// To specify no maximum limit, omit this parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-baselineebsbandwidthmbpsrequest.html#cfn-ec2-ec2fleet-baselineebsbandwidthmbpsrequest-max
//
Max *float64 `field:"optional" json:"max" yaml:"max"`
// The minimum baseline bandwidth, in Mbps.
//
// To specify no minimum limit, omit this parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-baselineebsbandwidthmbpsrequest.html#cfn-ec2-ec2fleet-baselineebsbandwidthmbpsrequest-min
//
Min *float64 `field:"optional" json:"min" yaml:"min"`
}
The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps.
For more information, see [Amazon EBS–optimized instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) in the *Amazon EC2 User 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"
baselineEbsBandwidthMbpsRequestProperty := &BaselineEbsBandwidthMbpsRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
}
type CfnEC2Fleet_CapacityRebalanceProperty ¶
type CfnEC2Fleet_CapacityRebalanceProperty struct {
// The replacement strategy to use. Only available for fleets of type `maintain` .
//
// `launch` - EC2 Fleet launches a replacement Spot Instance when a rebalance notification is emitted for an existing Spot Instance in the fleet. EC2 Fleet does not terminate the instances that receive a rebalance notification. You can terminate the old instances, or you can leave them running. You are charged for all instances while they are running.
//
// `launch-before-terminate` - EC2 Fleet launches a replacement Spot Instance when a rebalance notification is emitted for an existing Spot Instance in the fleet, and then, after a delay that you specify (in `TerminationDelay` ), terminates the instances that received a rebalance notification.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-capacityrebalance.html#cfn-ec2-ec2fleet-capacityrebalance-replacementstrategy
//
ReplacementStrategy *string `field:"optional" json:"replacementStrategy" yaml:"replacementStrategy"`
// The amount of time (in seconds) that Amazon EC2 waits before terminating the old Spot Instance after launching a new replacement Spot Instance.
//
// Required when `ReplacementStrategy` is set to `launch-before-terminate` .
//
// Not valid when `ReplacementStrategy` is set to `launch` .
//
// Valid values: Minimum value of `120` seconds. Maximum value of `7200` seconds.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-capacityrebalance.html#cfn-ec2-ec2fleet-capacityrebalance-terminationdelay
//
TerminationDelay *float64 `field:"optional" json:"terminationDelay" yaml:"terminationDelay"`
}
The Spot Instance replacement strategy to use when Amazon EC2 emits a rebalance notification signal that your Spot Instance is at an elevated risk of being interrupted.
For more information, see [Capacity rebalancing](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-capacity-rebalance.html) in the *Amazon EC2 User 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"
capacityRebalanceProperty := &CapacityRebalanceProperty{
ReplacementStrategy: jsii.String("replacementStrategy"),
TerminationDelay: jsii.Number(123),
}
type CfnEC2Fleet_CapacityReservationOptionsRequestProperty ¶
type CfnEC2Fleet_CapacityReservationOptionsRequestProperty struct {
// Indicates whether to use unused Capacity Reservations for fulfilling On-Demand capacity.
//
// If you specify `use-capacity-reservations-first` , the fleet uses unused Capacity Reservations to fulfill On-Demand capacity up to the target On-Demand capacity. If multiple instance pools have unused Capacity Reservations, the On-Demand allocation strategy ( `lowest-price` or `prioritized` ) is applied. If the number of unused Capacity Reservations is less than the On-Demand target capacity, the remaining On-Demand target capacity is launched according to the On-Demand allocation strategy ( `lowest-price` or `prioritized` ).
//
// If you do not specify a value, the fleet fulfils the On-Demand capacity according to the chosen On-Demand allocation strategy.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-capacityreservationoptionsrequest.html#cfn-ec2-ec2fleet-capacityreservationoptionsrequest-usagestrategy
//
UsageStrategy *string `field:"optional" json:"usageStrategy" yaml:"usageStrategy"`
}
Describes the strategy for using unused Capacity Reservations for fulfilling On-Demand capacity.
> This strategy can only be used if the EC2 Fleet is of type `instant` .
For more information about Capacity Reservations, see [On-Demand Capacity Reservations](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-capacity-reservations.html) in the *Amazon EC2 User Guide* . For examples of using Capacity Reservations in an EC2 Fleet, see [EC2 Fleet example configurations](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-examples.html) in the *Amazon EC2 User 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"
capacityReservationOptionsRequestProperty := &CapacityReservationOptionsRequestProperty{
UsageStrategy: jsii.String("usageStrategy"),
}
type CfnEC2Fleet_FleetLaunchTemplateConfigRequestProperty ¶
type CfnEC2Fleet_FleetLaunchTemplateConfigRequestProperty struct {
// The launch template to use.
//
// You must specify either the launch template ID or launch template name in the request.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplateconfigrequest.html#cfn-ec2-ec2fleet-fleetlaunchtemplateconfigrequest-launchtemplatespecification
//
LaunchTemplateSpecification interface{} `field:"optional" json:"launchTemplateSpecification" yaml:"launchTemplateSpecification"`
// Any parameters that you specify override the same parameters in the launch template.
//
// For fleets of type `request` and `maintain` , a maximum of 300 items is allowed across all launch templates.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplateconfigrequest.html#cfn-ec2-ec2fleet-fleetlaunchtemplateconfigrequest-overrides
//
Overrides interface{} `field:"optional" json:"overrides" yaml:"overrides"`
}
Specifies a launch template and overrides for an EC2 Fleet.
`FleetLaunchTemplateConfigRequest` is a property of the [AWS::EC2::EC2Fleet](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html) resource.
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"
fleetLaunchTemplateConfigRequestProperty := &FleetLaunchTemplateConfigRequestProperty{
LaunchTemplateSpecification: &FleetLaunchTemplateSpecificationRequestProperty{
Version: jsii.String("version"),
// the properties below are optional
LaunchTemplateId: jsii.String("launchTemplateId"),
LaunchTemplateName: jsii.String("launchTemplateName"),
},
Overrides: []interface{}{
&FleetLaunchTemplateOverridesRequestProperty{
AvailabilityZone: jsii.String("availabilityZone"),
InstanceRequirements: &InstanceRequirementsRequestProperty{
AcceleratorCount: &AcceleratorCountRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
AcceleratorManufacturers: []*string{
jsii.String("acceleratorManufacturers"),
},
AcceleratorNames: []*string{
jsii.String("acceleratorNames"),
},
AcceleratorTotalMemoryMiB: &AcceleratorTotalMemoryMiBRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
AcceleratorTypes: []*string{
jsii.String("acceleratorTypes"),
},
AllowedInstanceTypes: []*string{
jsii.String("allowedInstanceTypes"),
},
BareMetal: jsii.String("bareMetal"),
BaselineEbsBandwidthMbps: &BaselineEbsBandwidthMbpsRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
BurstablePerformance: jsii.String("burstablePerformance"),
CpuManufacturers: []*string{
jsii.String("cpuManufacturers"),
},
ExcludedInstanceTypes: []*string{
jsii.String("excludedInstanceTypes"),
},
InstanceGenerations: []*string{
jsii.String("instanceGenerations"),
},
LocalStorage: jsii.String("localStorage"),
LocalStorageTypes: []*string{
jsii.String("localStorageTypes"),
},
MaxSpotPriceAsPercentageOfOptimalOnDemandPrice: jsii.Number(123),
MemoryGiBPerVCpu: &MemoryGiBPerVCpuRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
MemoryMiB: &MemoryMiBRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
NetworkBandwidthGbps: &NetworkBandwidthGbpsRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
NetworkInterfaceCount: &NetworkInterfaceCountRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
OnDemandMaxPricePercentageOverLowestPrice: jsii.Number(123),
RequireHibernateSupport: jsii.Boolean(false),
SpotMaxPricePercentageOverLowestPrice: jsii.Number(123),
TotalLocalStorageGb: &TotalLocalStorageGBRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
VCpuCount: &VCpuCountRangeRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
},
InstanceType: jsii.String("instanceType"),
MaxPrice: jsii.String("maxPrice"),
Placement: &PlacementProperty{
Affinity: jsii.String("affinity"),
AvailabilityZone: jsii.String("availabilityZone"),
GroupName: jsii.String("groupName"),
HostId: jsii.String("hostId"),
HostResourceGroupArn: jsii.String("hostResourceGroupArn"),
PartitionNumber: jsii.Number(123),
SpreadDomain: jsii.String("spreadDomain"),
Tenancy: jsii.String("tenancy"),
},
Priority: jsii.Number(123),
SubnetId: jsii.String("subnetId"),
WeightedCapacity: jsii.Number(123),
},
},
}
type CfnEC2Fleet_FleetLaunchTemplateOverridesRequestProperty ¶
type CfnEC2Fleet_FleetLaunchTemplateOverridesRequestProperty struct {
// The Availability Zone in which to launch the instances.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest.html#cfn-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest-availabilityzone
//
AvailabilityZone *string `field:"optional" json:"availabilityZone" yaml:"availabilityZone"`
// The attributes for the instance types.
//
// When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.
//
// > If you specify `InstanceRequirements` , you can't specify `InstanceType` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest.html#cfn-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest-instancerequirements
//
InstanceRequirements interface{} `field:"optional" json:"instanceRequirements" yaml:"instanceRequirements"`
// The instance type.
//
// `mac1.metal` is not supported as a launch template override.
//
// > If you specify `InstanceType` , you can't specify `InstanceRequirements` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest.html#cfn-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest-instancetype
//
InstanceType *string `field:"optional" json:"instanceType" yaml:"instanceType"`
// The maximum price per unit hour that you are willing to pay for a Spot Instance.
//
// We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
//
// > If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest.html#cfn-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest-maxprice
//
MaxPrice *string `field:"optional" json:"maxPrice" yaml:"maxPrice"`
// The location where the instance launched, if applicable.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest.html#cfn-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest-placement
//
Placement interface{} `field:"optional" json:"placement" yaml:"placement"`
// The priority for the launch template override. The highest priority is launched first.
//
// If the On-Demand `AllocationStrategy` is set to `prioritized` , EC2 Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity.
//
// If the Spot `AllocationStrategy` is set to `capacity-optimized-prioritized` , EC2 Fleet uses priority on a best-effort basis to determine which launch template override to use in fulfilling Spot capacity, but optimizes for capacity first.
//
// Valid values are whole numbers starting at `0` . The lower the number, the higher the priority. If no number is set, the launch template override has the lowest priority. You can set the same priority for different launch template overrides.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest.html#cfn-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest-priority
//
Priority *float64 `field:"optional" json:"priority" yaml:"priority"`
// The IDs of the subnets in which to launch the instances.
//
// Separate multiple subnet IDs using commas (for example, `subnet-1234abcdeexample1, subnet-0987cdef6example2` ). A request of type `instant` can have only one subnet ID.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest.html#cfn-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest-subnetid
//
SubnetId *string `field:"optional" json:"subnetId" yaml:"subnetId"`
// The number of units provided by the specified instance type.
//
// These are the same units that you chose to set the target capacity in terms of instances, or a performance characteristic such as vCPUs, memory, or I/O.
//
// If the target capacity divided by this value is not a whole number, Amazon EC2 rounds the number of instances to the next whole number. If this value is not specified, the default is 1.
//
// > When specifying weights, the price used in the `lowest-price` and `price-capacity-optimized` allocation strategies is per *unit* hour (where the instance price is divided by the specified weight). However, if all the specified weights are above the requested `TargetCapacity` , resulting in only 1 instance being launched, the price used is per *instance* hour.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest.html#cfn-ec2-ec2fleet-fleetlaunchtemplateoverridesrequest-weightedcapacity
//
WeightedCapacity *float64 `field:"optional" json:"weightedCapacity" yaml:"weightedCapacity"`
}
Specifies overrides for a launch template for an EC2 Fleet.
`FleetLaunchTemplateOverridesRequest` is a property of the [FleetLaunchTemplateConfigRequest](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplateconfigrequest.html) property type.
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"
fleetLaunchTemplateOverridesRequestProperty := &FleetLaunchTemplateOverridesRequestProperty{
AvailabilityZone: jsii.String("availabilityZone"),
InstanceRequirements: &InstanceRequirementsRequestProperty{
AcceleratorCount: &AcceleratorCountRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
AcceleratorManufacturers: []*string{
jsii.String("acceleratorManufacturers"),
},
AcceleratorNames: []*string{
jsii.String("acceleratorNames"),
},
AcceleratorTotalMemoryMiB: &AcceleratorTotalMemoryMiBRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
AcceleratorTypes: []*string{
jsii.String("acceleratorTypes"),
},
AllowedInstanceTypes: []*string{
jsii.String("allowedInstanceTypes"),
},
BareMetal: jsii.String("bareMetal"),
BaselineEbsBandwidthMbps: &BaselineEbsBandwidthMbpsRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
BurstablePerformance: jsii.String("burstablePerformance"),
CpuManufacturers: []*string{
jsii.String("cpuManufacturers"),
},
ExcludedInstanceTypes: []*string{
jsii.String("excludedInstanceTypes"),
},
InstanceGenerations: []*string{
jsii.String("instanceGenerations"),
},
LocalStorage: jsii.String("localStorage"),
LocalStorageTypes: []*string{
jsii.String("localStorageTypes"),
},
MaxSpotPriceAsPercentageOfOptimalOnDemandPrice: jsii.Number(123),
MemoryGiBPerVCpu: &MemoryGiBPerVCpuRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
MemoryMiB: &MemoryMiBRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
NetworkBandwidthGbps: &NetworkBandwidthGbpsRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
NetworkInterfaceCount: &NetworkInterfaceCountRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
OnDemandMaxPricePercentageOverLowestPrice: jsii.Number(123),
RequireHibernateSupport: jsii.Boolean(false),
SpotMaxPricePercentageOverLowestPrice: jsii.Number(123),
TotalLocalStorageGb: &TotalLocalStorageGBRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
VCpuCount: &VCpuCountRangeRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
},
InstanceType: jsii.String("instanceType"),
MaxPrice: jsii.String("maxPrice"),
Placement: &PlacementProperty{
Affinity: jsii.String("affinity"),
AvailabilityZone: jsii.String("availabilityZone"),
GroupName: jsii.String("groupName"),
HostId: jsii.String("hostId"),
HostResourceGroupArn: jsii.String("hostResourceGroupArn"),
PartitionNumber: jsii.Number(123),
SpreadDomain: jsii.String("spreadDomain"),
Tenancy: jsii.String("tenancy"),
},
Priority: jsii.Number(123),
SubnetId: jsii.String("subnetId"),
WeightedCapacity: jsii.Number(123),
}
type CfnEC2Fleet_FleetLaunchTemplateSpecificationRequestProperty ¶
type CfnEC2Fleet_FleetLaunchTemplateSpecificationRequestProperty struct {
// The launch template version number, `$Latest` , or `$Default` . You must specify a value, otherwise the request fails.
//
// If the value is `$Latest` , Amazon EC2 uses the latest version of the launch template.
//
// If the value is `$Default` , Amazon EC2 uses the default version of the launch template.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplatespecificationrequest.html#cfn-ec2-ec2fleet-fleetlaunchtemplatespecificationrequest-version
//
Version *string `field:"required" json:"version" yaml:"version"`
// The ID of the launch template.
//
// You must specify the `LaunchTemplateId` or the `LaunchTemplateName` , but not both.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplatespecificationrequest.html#cfn-ec2-ec2fleet-fleetlaunchtemplatespecificationrequest-launchtemplateid
//
LaunchTemplateId *string `field:"optional" json:"launchTemplateId" yaml:"launchTemplateId"`
// The name of the launch template.
//
// You must specify the `LaunchTemplateName` or the `LaunchTemplateId` , but not both.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplatespecificationrequest.html#cfn-ec2-ec2fleet-fleetlaunchtemplatespecificationrequest-launchtemplatename
//
LaunchTemplateName *string `field:"optional" json:"launchTemplateName" yaml:"launchTemplateName"`
}
Specifies the launch template to be used by the EC2 Fleet for configuring Amazon EC2 instances.
You must specify the following:
- The ID or the name of the launch template, but not both. - The version of the launch template.
`FleetLaunchTemplateSpecificationRequest` is a property of the [FleetLaunchTemplateConfigRequest](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-fleetlaunchtemplateconfigrequest.html) property type.
For information about creating a launch template, see [AWS::EC2::LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html) and [Create a launch template](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html#create-launch-template) in the *Amazon EC2 User Guide* .
For examples of launch templates, see [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#aws-resource-ec2-launchtemplate--examples) .
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"
fleetLaunchTemplateSpecificationRequestProperty := &FleetLaunchTemplateSpecificationRequestProperty{
Version: jsii.String("version"),
// the properties below are optional
LaunchTemplateId: jsii.String("launchTemplateId"),
LaunchTemplateName: jsii.String("launchTemplateName"),
}
type CfnEC2Fleet_InstanceRequirementsRequestProperty ¶
type CfnEC2Fleet_InstanceRequirementsRequestProperty struct {
// The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) on an instance.
//
// To exclude accelerator-enabled instance types, set `Max` to `0` .
//
// Default: No minimum or maximum limits.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-acceleratorcount
//
AcceleratorCount interface{} `field:"optional" json:"acceleratorCount" yaml:"acceleratorCount"`
// Indicates whether instance types must have accelerators by specific manufacturers.
//
// - For instance types with AWS devices, specify `amazon-web-services` .
// - For instance types with AMD devices, specify `amd` .
// - For instance types with Habana devices, specify `habana` .
// - For instance types with NVIDIA devices, specify `nvidia` .
// - For instance types with Xilinx devices, specify `xilinx` .
//
// Default: Any manufacturer.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-acceleratormanufacturers
//
AcceleratorManufacturers *[]*string `field:"optional" json:"acceleratorManufacturers" yaml:"acceleratorManufacturers"`
// The accelerators that must be on the instance type.
//
// - For instance types with NVIDIA A10G GPUs, specify `a10g` .
// - For instance types with NVIDIA A100 GPUs, specify `a100` .
// - For instance types with NVIDIA H100 GPUs, specify `h100` .
// - For instance types with AWS Inferentia chips, specify `inferentia` .
// - For instance types with NVIDIA GRID K520 GPUs, specify `k520` .
// - For instance types with NVIDIA K80 GPUs, specify `k80` .
// - For instance types with NVIDIA M60 GPUs, specify `m60` .
// - For instance types with AMD Radeon Pro V520 GPUs, specify `radeon-pro-v520` .
// - For instance types with NVIDIA T4 GPUs, specify `t4` .
// - For instance types with NVIDIA T4G GPUs, specify `t4g` .
// - For instance types with Xilinx VU9P FPGAs, specify `vu9p` .
// - For instance types with NVIDIA V100 GPUs, specify `v100` .
//
// Default: Any accelerator.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-acceleratornames
//
AcceleratorNames *[]*string `field:"optional" json:"acceleratorNames" yaml:"acceleratorNames"`
// The minimum and maximum amount of total accelerator memory, in MiB.
//
// Default: No minimum or maximum limits.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-acceleratortotalmemorymib
//
AcceleratorTotalMemoryMiB interface{} `field:"optional" json:"acceleratorTotalMemoryMiB" yaml:"acceleratorTotalMemoryMiB"`
// The accelerator types that must be on the instance type.
//
// - To include instance types with GPU hardware, specify `gpu` .
// - To include instance types with FPGA hardware, specify `fpga` .
// - To include instance types with inference hardware, specify `inference` .
//
// Default: Any accelerator type.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-acceleratortypes
//
AcceleratorTypes *[]*string `field:"optional" json:"acceleratorTypes" yaml:"acceleratorTypes"`
// The instance types to apply your specified attributes against.
//
// All other instance types are ignored, even if they match your specified attributes.
//
// You can use strings with one or more wild cards, represented by an asterisk ( `*` ), to allow an instance type, size, or generation. The following are examples: `m5.8xlarge` , `c5*.*` , `m5a.*` , `r*` , `*3*` .
//
// For example, if you specify `c5*` ,Amazon EC2 will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specify `m5a.*` , Amazon EC2 will allow all the M5a instance types, but not the M5n instance types.
//
// > If you specify `AllowedInstanceTypes` , you can't specify `ExcludedInstanceTypes` .
//
// Default: All instance types.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-allowedinstancetypes
//
AllowedInstanceTypes *[]*string `field:"optional" json:"allowedInstanceTypes" yaml:"allowedInstanceTypes"`
// Indicates whether bare metal instance types must be included, excluded, or required.
//
// - To include bare metal instance types, specify `included` .
// - To require only bare metal instance types, specify `required` .
// - To exclude bare metal instance types, specify `excluded` .
//
// Default: `excluded`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-baremetal
//
BareMetal *string `field:"optional" json:"bareMetal" yaml:"bareMetal"`
// The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps.
//
// For more information, see [Amazon EBS–optimized instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) in the *Amazon EC2 User Guide* .
//
// Default: No minimum or maximum limits.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-baselineebsbandwidthmbps
//
BaselineEbsBandwidthMbps interface{} `field:"optional" json:"baselineEbsBandwidthMbps" yaml:"baselineEbsBandwidthMbps"`
// Indicates whether burstable performance T instance types are included, excluded, or required.
//
// For more information, see [Burstable performance instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html) .
//
// - To include burstable performance instance types, specify `included` .
// - To require only burstable performance instance types, specify `required` .
// - To exclude burstable performance instance types, specify `excluded` .
//
// Default: `excluded`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-burstableperformance
//
BurstablePerformance *string `field:"optional" json:"burstablePerformance" yaml:"burstablePerformance"`
// The CPU manufacturers to include.
//
// - For instance types with Intel CPUs, specify `intel` .
// - For instance types with AMD CPUs, specify `amd` .
// - For instance types with AWS CPUs, specify `amazon-web-services` .
//
// > Don't confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template.
//
// Default: Any manufacturer.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-cpumanufacturers
//
CpuManufacturers *[]*string `field:"optional" json:"cpuManufacturers" yaml:"cpuManufacturers"`
// The instance types to exclude.
//
// You can use strings with one or more wild cards, represented by an asterisk ( `*` ), to exclude an instance family, type, size, or generation. The following are examples: `m5.8xlarge` , `c5*.*` , `m5a.*` , `r*` , `*3*` .
//
// For example, if you specify `c5*` ,Amazon EC2 will exclude the entire C5 instance family, which includes all C5a and C5n instance types. If you specify `m5a.*` , Amazon EC2 will exclude all the M5a instance types, but not the M5n instance types.
//
// > If you specify `ExcludedInstanceTypes` , you can't specify `AllowedInstanceTypes` .
//
// Default: No excluded instance types.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-excludedinstancetypes
//
ExcludedInstanceTypes *[]*string `field:"optional" json:"excludedInstanceTypes" yaml:"excludedInstanceTypes"`
// Indicates whether current or previous generation instance types are included.
//
// The current generation instance types are recommended for use. Current generation instance types are typically the latest two to three generations in each instance family. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide* .
//
// For current generation instance types, specify `current` .
//
// For previous generation instance types, specify `previous` .
//
// Default: Current and previous generation instance types.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-instancegenerations
//
InstanceGenerations *[]*string `field:"optional" json:"instanceGenerations" yaml:"instanceGenerations"`
// Indicates whether instance types with instance store volumes are included, excluded, or required.
//
// For more information, [Amazon EC2 instance store](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html) in the *Amazon EC2 User Guide* .
//
// - To include instance types with instance store volumes, specify `included` .
// - To require only instance types with instance store volumes, specify `required` .
// - To exclude instance types with instance store volumes, specify `excluded` .
//
// Default: `included`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-localstorage
//
LocalStorage *string `field:"optional" json:"localStorage" yaml:"localStorage"`
// The type of local storage that is required.
//
// - For instance types with hard disk drive (HDD) storage, specify `hdd` .
// - For instance types with solid state drive (SSD) storage, specify `ssd` .
//
// Default: `hdd` and `ssd`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-localstoragetypes
//
LocalStorageTypes *[]*string `field:"optional" json:"localStorageTypes" yaml:"localStorageTypes"`
// [Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price.
//
// The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold.
//
// The parameter accepts an integer, which Amazon EC2 interprets as a percentage.
//
// If you set `TargetCapacityUnitType` to `vcpu` or `memory-mib` , the price protection threshold is based on the per vCPU or per memory price instead of the per instance price.
//
// > Only one of `SpotMaxPricePercentageOverLowestPrice` or `MaxSpotPriceAsPercentageOfOptimalOnDemandPrice` can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as `999999` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-maxspotpriceaspercentageofoptimalondemandprice
//
MaxSpotPriceAsPercentageOfOptimalOnDemandPrice *float64 `field:"optional" json:"maxSpotPriceAsPercentageOfOptimalOnDemandPrice" yaml:"maxSpotPriceAsPercentageOfOptimalOnDemandPrice"`
// The minimum and maximum amount of memory per vCPU, in GiB.
//
// Default: No minimum or maximum limits.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-memorygibpervcpu
//
MemoryGiBPerVCpu interface{} `field:"optional" json:"memoryGiBPerVCpu" yaml:"memoryGiBPerVCpu"`
// The minimum and maximum amount of memory, in MiB.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-memorymib
//
MemoryMiB interface{} `field:"optional" json:"memoryMiB" yaml:"memoryMiB"`
// The minimum and maximum amount of baseline network bandwidth, in gigabits per second (Gbps).
//
// For more information, see [Amazon EC2 instance network bandwidth](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-network-bandwidth.html) in the *Amazon EC2 User Guide* .
//
// Default: No minimum or maximum limits.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-networkbandwidthgbps
//
NetworkBandwidthGbps interface{} `field:"optional" json:"networkBandwidthGbps" yaml:"networkBandwidthGbps"`
// The minimum and maximum number of network interfaces.
//
// Default: No minimum or maximum limits.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-networkinterfacecount
//
NetworkInterfaceCount interface{} `field:"optional" json:"networkInterfaceCount" yaml:"networkInterfaceCount"`
// [Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price.
//
// The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold.
//
// The parameter accepts an integer, which Amazon EC2 interprets as a percentage.
//
// To indicate no price protection threshold, specify a high value, such as `999999` .
//
// This parameter is not supported for [GetSpotPlacementScores](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html) and [GetInstanceTypesFromInstanceRequirements](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceTypesFromInstanceRequirements.html) .
//
// > If you set `TargetCapacityUnitType` to `vcpu` or `memory-mib` , the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.
//
// Default: `20`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-ondemandmaxpricepercentageoverlowestprice
//
OnDemandMaxPricePercentageOverLowestPrice *float64 `field:"optional" json:"onDemandMaxPricePercentageOverLowestPrice" yaml:"onDemandMaxPricePercentageOverLowestPrice"`
// Indicates whether instance types must support hibernation for On-Demand Instances.
//
// This parameter is not supported for [GetSpotPlacementScores](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html) .
//
// Default: `false`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-requirehibernatesupport
//
RequireHibernateSupport interface{} `field:"optional" json:"requireHibernateSupport" yaml:"requireHibernateSupport"`
// [Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price.
//
// The identified Spot price is the Spot price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified Spot price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose Spot price exceeds your specified threshold.
//
// The parameter accepts an integer, which Amazon EC2 interprets as a percentage.
//
// If you set `TargetCapacityUnitType` to `vcpu` or `memory-mib` , the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.
//
// This parameter is not supported for [GetSpotPlacementScores](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html) and [GetInstanceTypesFromInstanceRequirements](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceTypesFromInstanceRequirements.html) .
//
// > Only one of `SpotMaxPricePercentageOverLowestPrice` or `MaxSpotPriceAsPercentageOfOptimalOnDemandPrice` can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as `999999` .
//
// Default: `100`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-spotmaxpricepercentageoverlowestprice
//
SpotMaxPricePercentageOverLowestPrice *float64 `field:"optional" json:"spotMaxPricePercentageOverLowestPrice" yaml:"spotMaxPricePercentageOverLowestPrice"`
// The minimum and maximum amount of total local storage, in GB.
//
// Default: No minimum or maximum limits.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-totallocalstoragegb
//
TotalLocalStorageGb interface{} `field:"optional" json:"totalLocalStorageGb" yaml:"totalLocalStorageGb"`
// The minimum and maximum number of vCPUs.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html#cfn-ec2-ec2fleet-instancerequirementsrequest-vcpucount
//
VCpuCount interface{} `field:"optional" json:"vCpuCount" yaml:"vCpuCount"`
}
The attributes for the instance types.
When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.
You must specify `VCpuCount` and `MemoryMiB` . All other attributes are optional. Any unspecified optional attribute is set to its default.
When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values.
To limit the list of instance types from which Amazon EC2 can identify matching instance types, you can use one of the following parameters, but not both in the same request:
- `AllowedInstanceTypes` - The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes. - `ExcludedInstanceTypes` - The instance types to exclude from the list, even if they match your specified attributes.
> If you specify `InstanceRequirements` , you can't specify `InstanceType` . > > Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the [launch instance wizard](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-instance-wizard.html) , or with the [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) API or [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) AWS CloudFormation resource, you can't specify `InstanceRequirements` .
For more information, see [Attribute-based instance type selection for EC2 Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html) , [Attribute-based instance type selection for Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-attribute-based-instance-type-selection.html) , and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User 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"
instanceRequirementsRequestProperty := &InstanceRequirementsRequestProperty{
AcceleratorCount: &AcceleratorCountRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
AcceleratorManufacturers: []*string{
jsii.String("acceleratorManufacturers"),
},
AcceleratorNames: []*string{
jsii.String("acceleratorNames"),
},
AcceleratorTotalMemoryMiB: &AcceleratorTotalMemoryMiBRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
AcceleratorTypes: []*string{
jsii.String("acceleratorTypes"),
},
AllowedInstanceTypes: []*string{
jsii.String("allowedInstanceTypes"),
},
BareMetal: jsii.String("bareMetal"),
BaselineEbsBandwidthMbps: &BaselineEbsBandwidthMbpsRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
BurstablePerformance: jsii.String("burstablePerformance"),
CpuManufacturers: []*string{
jsii.String("cpuManufacturers"),
},
ExcludedInstanceTypes: []*string{
jsii.String("excludedInstanceTypes"),
},
InstanceGenerations: []*string{
jsii.String("instanceGenerations"),
},
LocalStorage: jsii.String("localStorage"),
LocalStorageTypes: []*string{
jsii.String("localStorageTypes"),
},
MaxSpotPriceAsPercentageOfOptimalOnDemandPrice: jsii.Number(123),
MemoryGiBPerVCpu: &MemoryGiBPerVCpuRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
MemoryMiB: &MemoryMiBRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
NetworkBandwidthGbps: &NetworkBandwidthGbpsRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
NetworkInterfaceCount: &NetworkInterfaceCountRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
OnDemandMaxPricePercentageOverLowestPrice: jsii.Number(123),
RequireHibernateSupport: jsii.Boolean(false),
SpotMaxPricePercentageOverLowestPrice: jsii.Number(123),
TotalLocalStorageGb: &TotalLocalStorageGBRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
VCpuCount: &VCpuCountRangeRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
}
type CfnEC2Fleet_MaintenanceStrategiesProperty ¶
type CfnEC2Fleet_MaintenanceStrategiesProperty struct {
// The strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an elevated risk of being interrupted.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-maintenancestrategies.html#cfn-ec2-ec2fleet-maintenancestrategies-capacityrebalance
//
CapacityRebalance interface{} `field:"optional" json:"capacityRebalance" yaml:"capacityRebalance"`
}
The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.
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"
maintenanceStrategiesProperty := &MaintenanceStrategiesProperty{
CapacityRebalance: &CapacityRebalanceProperty{
ReplacementStrategy: jsii.String("replacementStrategy"),
TerminationDelay: jsii.Number(123),
},
}
type CfnEC2Fleet_MemoryGiBPerVCpuRequestProperty ¶
type CfnEC2Fleet_MemoryGiBPerVCpuRequestProperty struct {
// The maximum amount of memory per vCPU, in GiB.
//
// To specify no maximum limit, omit this parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-memorygibpervcpurequest.html#cfn-ec2-ec2fleet-memorygibpervcpurequest-max
//
Max *float64 `field:"optional" json:"max" yaml:"max"`
// The minimum amount of memory per vCPU, in GiB.
//
// To specify no minimum limit, omit this parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-memorygibpervcpurequest.html#cfn-ec2-ec2fleet-memorygibpervcpurequest-min
//
Min *float64 `field:"optional" json:"min" yaml:"min"`
}
The minimum and maximum amount of memory per vCPU, in GiB.
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"
memoryGiBPerVCpuRequestProperty := &MemoryGiBPerVCpuRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
}
type CfnEC2Fleet_MemoryMiBRequestProperty ¶
type CfnEC2Fleet_MemoryMiBRequestProperty struct {
// The maximum amount of memory, in MiB.
//
// To specify no maximum limit, omit this parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-memorymibrequest.html#cfn-ec2-ec2fleet-memorymibrequest-max
//
Max *float64 `field:"optional" json:"max" yaml:"max"`
// The minimum amount of memory, in MiB.
//
// To specify no minimum limit, specify `0` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-memorymibrequest.html#cfn-ec2-ec2fleet-memorymibrequest-min
//
Min *float64 `field:"optional" json:"min" yaml:"min"`
}
The minimum and maximum amount of memory, in MiB.
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"
memoryMiBRequestProperty := &MemoryMiBRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
}
type CfnEC2Fleet_NetworkBandwidthGbpsRequestProperty ¶ added in v2.51.0
type CfnEC2Fleet_NetworkBandwidthGbpsRequestProperty struct {
// The maximum amount of network bandwidth, in Gbps.
//
// To specify no maximum limit, omit this parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-networkbandwidthgbpsrequest.html#cfn-ec2-ec2fleet-networkbandwidthgbpsrequest-max
//
Max *float64 `field:"optional" json:"max" yaml:"max"`
// The minimum amount of network bandwidth, in Gbps.
//
// To specify no minimum limit, omit this parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-networkbandwidthgbpsrequest.html#cfn-ec2-ec2fleet-networkbandwidthgbpsrequest-min
//
Min *float64 `field:"optional" json:"min" yaml:"min"`
}
The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).
> Setting the minimum bandwidth does not guarantee that your instance will achieve the minimum bandwidth. Amazon EC2 will identify instance types that support the specified minimum bandwidth, but the actual bandwidth of your instance might go below the specified minimum at times. For more information, see [Available instance bandwidth](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-network-bandwidth.html#available-instance-bandwidth) in the *Amazon EC2 User 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"
networkBandwidthGbpsRequestProperty := &NetworkBandwidthGbpsRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
}
type CfnEC2Fleet_NetworkInterfaceCountRequestProperty ¶
type CfnEC2Fleet_NetworkInterfaceCountRequestProperty struct {
// The maximum number of network interfaces.
//
// To specify no maximum limit, omit this parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-networkinterfacecountrequest.html#cfn-ec2-ec2fleet-networkinterfacecountrequest-max
//
Max *float64 `field:"optional" json:"max" yaml:"max"`
// The minimum number of network interfaces.
//
// To specify no minimum limit, omit this parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-networkinterfacecountrequest.html#cfn-ec2-ec2fleet-networkinterfacecountrequest-min
//
Min *float64 `field:"optional" json:"min" yaml:"min"`
}
The minimum and maximum number of network interfaces.
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"
networkInterfaceCountRequestProperty := &NetworkInterfaceCountRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
}
type CfnEC2Fleet_OnDemandOptionsRequestProperty ¶
type CfnEC2Fleet_OnDemandOptionsRequestProperty struct {
// The strategy that determines the order of the launch template overrides to use in fulfilling On-Demand capacity.
//
// `lowest-price` - EC2 Fleet uses price to determine the order, launching the lowest price first.
//
// `prioritized` - EC2 Fleet uses the priority that you assigned to each launch template override, launching the highest priority first.
//
// Default: `lowest-price`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-ondemandoptionsrequest.html#cfn-ec2-ec2fleet-ondemandoptionsrequest-allocationstrategy
//
AllocationStrategy *string `field:"optional" json:"allocationStrategy" yaml:"allocationStrategy"`
// The strategy for using unused Capacity Reservations for fulfilling On-Demand capacity.
//
// Supported only for fleets of type `instant` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-ondemandoptionsrequest.html#cfn-ec2-ec2fleet-ondemandoptionsrequest-capacityreservationoptions
//
CapacityReservationOptions interface{} `field:"optional" json:"capacityReservationOptions" yaml:"capacityReservationOptions"`
// The maximum amount per hour for On-Demand Instances that you're willing to pay.
//
// > If your fleet includes T instances that are configured as `unlimited` , and if their average CPU usage exceeds the baseline utilization, you will incur a charge for surplus credits. The `MaxTotalPrice` does not account for surplus credits, and, if you use surplus credits, your final cost might be higher than what you specified for `MaxTotalPrice` . For more information, see [Surplus credits can incur charges](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances-unlimited-mode-concepts.html#unlimited-mode-surplus-credits) in the *Amazon EC2 User Guide* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-ondemandoptionsrequest.html#cfn-ec2-ec2fleet-ondemandoptionsrequest-maxtotalprice
//
MaxTotalPrice *string `field:"optional" json:"maxTotalPrice" yaml:"maxTotalPrice"`
// The minimum target capacity for On-Demand Instances in the fleet.
//
// If this minimum capacity isn't reached, no instances are launched.
//
// Constraints: Maximum value of `1000` . Supported only for fleets of type `instant` .
//
// At least one of the following must be specified: `SingleAvailabilityZone` | `SingleInstanceType`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-ondemandoptionsrequest.html#cfn-ec2-ec2fleet-ondemandoptionsrequest-mintargetcapacity
//
MinTargetCapacity *float64 `field:"optional" json:"minTargetCapacity" yaml:"minTargetCapacity"`
// Indicates that the fleet launches all On-Demand Instances into a single Availability Zone.
//
// Supported only for fleets of type `instant` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-ondemandoptionsrequest.html#cfn-ec2-ec2fleet-ondemandoptionsrequest-singleavailabilityzone
//
SingleAvailabilityZone interface{} `field:"optional" json:"singleAvailabilityZone" yaml:"singleAvailabilityZone"`
// Indicates that the fleet uses a single instance type to launch all On-Demand Instances in the fleet.
//
// Supported only for fleets of type `instant` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-ondemandoptionsrequest.html#cfn-ec2-ec2fleet-ondemandoptionsrequest-singleinstancetype
//
SingleInstanceType interface{} `field:"optional" json:"singleInstanceType" yaml:"singleInstanceType"`
}
Specifies the allocation strategy of On-Demand Instances in an EC2 Fleet.
`OnDemandOptionsRequest` is a property of the [AWS::EC2::EC2Fleet](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html) resource.
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"
onDemandOptionsRequestProperty := &OnDemandOptionsRequestProperty{
AllocationStrategy: jsii.String("allocationStrategy"),
CapacityReservationOptions: &CapacityReservationOptionsRequestProperty{
UsageStrategy: jsii.String("usageStrategy"),
},
MaxTotalPrice: jsii.String("maxTotalPrice"),
MinTargetCapacity: jsii.Number(123),
SingleAvailabilityZone: jsii.Boolean(false),
SingleInstanceType: jsii.Boolean(false),
}
type CfnEC2Fleet_PlacementProperty ¶
type CfnEC2Fleet_PlacementProperty struct {
// The affinity setting for the instance on the Dedicated Host.
//
// This parameter is not supported for [CreateFleet](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet) or [ImportInstance](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportInstance.html) .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-placement.html#cfn-ec2-ec2fleet-placement-affinity
//
Affinity *string `field:"optional" json:"affinity" yaml:"affinity"`
// The Availability Zone of the instance.
//
// If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region.
//
// This parameter is not supported for [CreateFleet](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet) .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-placement.html#cfn-ec2-ec2fleet-placement-availabilityzone
//
AvailabilityZone *string `field:"optional" json:"availabilityZone" yaml:"availabilityZone"`
// The name of the placement group that the instance is in.
//
// If you specify `GroupName` , you can't specify `GroupId` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-placement.html#cfn-ec2-ec2fleet-placement-groupname
//
GroupName *string `field:"optional" json:"groupName" yaml:"groupName"`
// The ID of the Dedicated Host on which the instance resides.
//
// This parameter is not supported for [CreateFleet](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet) or [ImportInstance](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportInstance.html) .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-placement.html#cfn-ec2-ec2fleet-placement-hostid
//
HostId *string `field:"optional" json:"hostId" yaml:"hostId"`
// The ARN of the host resource group in which to launch the instances.
//
// If you specify this parameter, either omit the *Tenancy* parameter or set it to `host` .
//
// This parameter is not supported for [CreateFleet](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet) .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-placement.html#cfn-ec2-ec2fleet-placement-hostresourcegrouparn
//
HostResourceGroupArn *string `field:"optional" json:"hostResourceGroupArn" yaml:"hostResourceGroupArn"`
// The number of the partition that the instance is in.
//
// Valid only if the placement group strategy is set to `partition` .
//
// This parameter is not supported for [CreateFleet](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet) .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-placement.html#cfn-ec2-ec2fleet-placement-partitionnumber
//
PartitionNumber *float64 `field:"optional" json:"partitionNumber" yaml:"partitionNumber"`
// Reserved for future use.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-placement.html#cfn-ec2-ec2fleet-placement-spreaddomain
//
SpreadDomain *string `field:"optional" json:"spreadDomain" yaml:"spreadDomain"`
// The tenancy of the instance. An instance with a tenancy of `dedicated` runs on single-tenant hardware.
//
// This parameter is not supported for [CreateFleet](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet) . The `host` tenancy is not supported for [ImportInstance](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportInstance.html) or for T3 instances that are configured for the `unlimited` CPU credit option.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-placement.html#cfn-ec2-ec2fleet-placement-tenancy
//
Tenancy *string `field:"optional" json:"tenancy" yaml:"tenancy"`
}
Describes the placement 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"
placementProperty := &PlacementProperty{
Affinity: jsii.String("affinity"),
AvailabilityZone: jsii.String("availabilityZone"),
GroupName: jsii.String("groupName"),
HostId: jsii.String("hostId"),
HostResourceGroupArn: jsii.String("hostResourceGroupArn"),
PartitionNumber: jsii.Number(123),
SpreadDomain: jsii.String("spreadDomain"),
Tenancy: jsii.String("tenancy"),
}
type CfnEC2Fleet_SpotOptionsRequestProperty ¶
type CfnEC2Fleet_SpotOptionsRequestProperty struct {
// Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the EC2 Fleet.
//
// If the allocation strategy is `lowestPrice` , EC2 Fleet launches instances from the Spot Instance pools with the lowest price. This is the default allocation strategy.
//
// If the allocation strategy is `diversified` , EC2 Fleet launches instances from all the Spot Instance pools that you specify.
//
// If the allocation strategy is `capacityOptimized` , EC2 Fleet launches instances from Spot Instance pools that are optimally chosen based on the available Spot Instance capacity.
//
// *Allowed Values* : `lowestPrice` | `diversified` | `capacityOptimized` | `capacityOptimizedPrioritized`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-spotoptionsrequest.html#cfn-ec2-ec2fleet-spotoptionsrequest-allocationstrategy
//
AllocationStrategy *string `field:"optional" json:"allocationStrategy" yaml:"allocationStrategy"`
// The behavior when a Spot Instance is interrupted.
//
// Default: `terminate`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-spotoptionsrequest.html#cfn-ec2-ec2fleet-spotoptionsrequest-instanceinterruptionbehavior
//
InstanceInterruptionBehavior *string `field:"optional" json:"instanceInterruptionBehavior" yaml:"instanceInterruptionBehavior"`
// The number of Spot pools across which to allocate your target Spot capacity.
//
// Supported only when Spot `AllocationStrategy` is set to `lowest-price` . EC2 Fleet selects the cheapest Spot pools and evenly allocates your target Spot capacity across the number of Spot pools that you specify.
//
// Note that EC2 Fleet attempts to draw Spot Instances from the number of pools that you specify on a best effort basis. If a pool runs out of Spot capacity before fulfilling your target capacity, EC2 Fleet will continue to fulfill your request by drawing from the next cheapest pool. To ensure that your target capacity is met, you might receive Spot Instances from more than the number of pools that you specified. Similarly, if most of the pools have no Spot capacity, you might receive your full target capacity from fewer than the number of pools that you specified.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-spotoptionsrequest.html#cfn-ec2-ec2fleet-spotoptionsrequest-instancepoolstousecount
//
InstancePoolsToUseCount *float64 `field:"optional" json:"instancePoolsToUseCount" yaml:"instancePoolsToUseCount"`
// The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-spotoptionsrequest.html#cfn-ec2-ec2fleet-spotoptionsrequest-maintenancestrategies
//
MaintenanceStrategies interface{} `field:"optional" json:"maintenanceStrategies" yaml:"maintenanceStrategies"`
// The maximum amount per hour for Spot Instances that you're willing to pay.
//
// We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
//
// > If you specify a maximum price, your Spot Instances will be interrupted more frequently than if you do not specify this parameter. > If your fleet includes T instances that are configured as `unlimited` , and if their average CPU usage exceeds the baseline utilization, you will incur a charge for surplus credits. The `MaxTotalPrice` does not account for surplus credits, and, if you use surplus credits, your final cost might be higher than what you specified for `MaxTotalPrice` . For more information, see [Surplus credits can incur charges](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances-unlimited-mode-concepts.html#unlimited-mode-surplus-credits) in the *Amazon EC2 User Guide* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-spotoptionsrequest.html#cfn-ec2-ec2fleet-spotoptionsrequest-maxtotalprice
//
MaxTotalPrice *string `field:"optional" json:"maxTotalPrice" yaml:"maxTotalPrice"`
// The minimum target capacity for Spot Instances in the fleet.
//
// If this minimum capacity isn't reached, no instances are launched.
//
// Constraints: Maximum value of `1000` . Supported only for fleets of type `instant` .
//
// At least one of the following must be specified: `SingleAvailabilityZone` | `SingleInstanceType`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-spotoptionsrequest.html#cfn-ec2-ec2fleet-spotoptionsrequest-mintargetcapacity
//
MinTargetCapacity *float64 `field:"optional" json:"minTargetCapacity" yaml:"minTargetCapacity"`
// Indicates that the fleet launches all Spot Instances into a single Availability Zone.
//
// Supported only for fleets of type `instant` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-spotoptionsrequest.html#cfn-ec2-ec2fleet-spotoptionsrequest-singleavailabilityzone
//
SingleAvailabilityZone interface{} `field:"optional" json:"singleAvailabilityZone" yaml:"singleAvailabilityZone"`
// Indicates that the fleet uses a single instance type to launch all Spot Instances in the fleet.
//
// Supported only for fleets of type `instant` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-spotoptionsrequest.html#cfn-ec2-ec2fleet-spotoptionsrequest-singleinstancetype
//
SingleInstanceType interface{} `field:"optional" json:"singleInstanceType" yaml:"singleInstanceType"`
}
Specifies the configuration of Spot Instances for an EC2 Fleet.
`SpotOptionsRequest` is a property of the [AWS::EC2::EC2Fleet](https://docs.aws.amazon.com//AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html) resource.
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"
spotOptionsRequestProperty := &SpotOptionsRequestProperty{
AllocationStrategy: jsii.String("allocationStrategy"),
InstanceInterruptionBehavior: jsii.String("instanceInterruptionBehavior"),
InstancePoolsToUseCount: jsii.Number(123),
MaintenanceStrategies: &MaintenanceStrategiesProperty{
CapacityRebalance: &CapacityRebalanceProperty{
ReplacementStrategy: jsii.String("replacementStrategy"),
TerminationDelay: jsii.Number(123),
},
},
MaxTotalPrice: jsii.String("maxTotalPrice"),
MinTargetCapacity: jsii.Number(123),
SingleAvailabilityZone: jsii.Boolean(false),
SingleInstanceType: jsii.Boolean(false),
}
type CfnEC2Fleet_TagSpecificationProperty ¶
type CfnEC2Fleet_TagSpecificationProperty struct {
// The type of resource to tag.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-tagspecification.html#cfn-ec2-ec2fleet-tagspecification-resourcetype
//
ResourceType *string `field:"optional" json:"resourceType" yaml:"resourceType"`
// The tags to apply to the resource.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-tagspecification.html#cfn-ec2-ec2fleet-tagspecification-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Specifies the tags to apply to a resource when the resource is being created for an EC2 Fleet.
`TagSpecification` is a property of the [AWS::EC2::EC2Fleet](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html) resource.
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"
tagSpecificationProperty := &TagSpecificationProperty{
ResourceType: jsii.String("resourceType"),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
type CfnEC2Fleet_TargetCapacitySpecificationRequestProperty ¶
type CfnEC2Fleet_TargetCapacitySpecificationRequestProperty struct {
// The number of units to request, filled using the default target capacity type.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-targetcapacityspecificationrequest.html#cfn-ec2-ec2fleet-targetcapacityspecificationrequest-totaltargetcapacity
//
TotalTargetCapacity *float64 `field:"required" json:"totalTargetCapacity" yaml:"totalTargetCapacity"`
// The default target capacity type.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-targetcapacityspecificationrequest.html#cfn-ec2-ec2fleet-targetcapacityspecificationrequest-defaulttargetcapacitytype
//
DefaultTargetCapacityType *string `field:"optional" json:"defaultTargetCapacityType" yaml:"defaultTargetCapacityType"`
// The number of On-Demand units to request.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-targetcapacityspecificationrequest.html#cfn-ec2-ec2fleet-targetcapacityspecificationrequest-ondemandtargetcapacity
//
OnDemandTargetCapacity *float64 `field:"optional" json:"onDemandTargetCapacity" yaml:"onDemandTargetCapacity"`
// The number of Spot units to request.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-targetcapacityspecificationrequest.html#cfn-ec2-ec2fleet-targetcapacityspecificationrequest-spottargetcapacity
//
SpotTargetCapacity *float64 `field:"optional" json:"spotTargetCapacity" yaml:"spotTargetCapacity"`
// The unit for the target capacity. You can specify this parameter only when using attributed-based instance type selection.
//
// Default: `units` (the number of instances).
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-targetcapacityspecificationrequest.html#cfn-ec2-ec2fleet-targetcapacityspecificationrequest-targetcapacityunittype
//
TargetCapacityUnitType *string `field:"optional" json:"targetCapacityUnitType" yaml:"targetCapacityUnitType"`
}
Specifies the number of units to request for an EC2 Fleet.
You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is `maintain` , you can specify a target capacity of `0` and add capacity later.
`TargetCapacitySpecificationRequest` is a property of the [AWS::EC2::EC2Fleet](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html) resource.
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"
targetCapacitySpecificationRequestProperty := &TargetCapacitySpecificationRequestProperty{
TotalTargetCapacity: jsii.Number(123),
// the properties below are optional
DefaultTargetCapacityType: jsii.String("defaultTargetCapacityType"),
OnDemandTargetCapacity: jsii.Number(123),
SpotTargetCapacity: jsii.Number(123),
TargetCapacityUnitType: jsii.String("targetCapacityUnitType"),
}
type CfnEC2Fleet_TotalLocalStorageGBRequestProperty ¶
type CfnEC2Fleet_TotalLocalStorageGBRequestProperty struct {
// The maximum amount of total local storage, in GB.
//
// To specify no maximum limit, omit this parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-totallocalstoragegbrequest.html#cfn-ec2-ec2fleet-totallocalstoragegbrequest-max
//
Max *float64 `field:"optional" json:"max" yaml:"max"`
// The minimum amount of total local storage, in GB.
//
// To specify no minimum limit, omit this parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-totallocalstoragegbrequest.html#cfn-ec2-ec2fleet-totallocalstoragegbrequest-min
//
Min *float64 `field:"optional" json:"min" yaml:"min"`
}
The minimum and maximum amount of total local storage, in GB.
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"
totalLocalStorageGBRequestProperty := &TotalLocalStorageGBRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
}
type CfnEC2Fleet_VCpuCountRangeRequestProperty ¶
type CfnEC2Fleet_VCpuCountRangeRequestProperty struct {
// The maximum number of vCPUs.
//
// To specify no maximum limit, omit this parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-vcpucountrangerequest.html#cfn-ec2-ec2fleet-vcpucountrangerequest-max
//
Max *float64 `field:"optional" json:"max" yaml:"max"`
// The minimum number of vCPUs.
//
// To specify no minimum limit, specify `0` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-vcpucountrangerequest.html#cfn-ec2-ec2fleet-vcpucountrangerequest-min
//
Min *float64 `field:"optional" json:"min" yaml:"min"`
}
The minimum and maximum number of vCPUs.
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"
vCpuCountRangeRequestProperty := &VCpuCountRangeRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
}
type CfnEIP ¶
type CfnEIP interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggable
// The ID that AWS assigns to represent the allocation of the address for use with Amazon VPC.
//
// This is returned only for VPC elastic IP addresses. For example, `eipalloc-5723d13e` .
AttrAllocationId() *string
// The Elastic IP address.
AttrPublicIp() *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 network ( `vpc` ).
Domain() *string
SetDomain(val *string)
// The ID of the instance.
InstanceId() *string
SetInstanceId(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
// A unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses.
NetworkBorderGroup() *string
SetNetworkBorderGroup(val *string)
// The tree node.
Node() constructs.Node
// The ID of an address pool that you own.
PublicIpv4Pool() *string
SetPublicIpv4Pool(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
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
// Any tags assigned to the Elastic IP address.
TagsRaw() *[]*awscdk.CfnTag
SetTagsRaw(val *[]*awscdk.CfnTag)
// The Elastic IP address you are accepting for transfer.
TransferAddress() *string
SetTransferAddress(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{})
}
Specifies an Elastic IP (EIP) address and can, optionally, associate it with an Amazon EC2 instance.
You can allocate an Elastic IP address from an address pool owned by AWS or from an address pool created from a public IPv4 address range that you have brought to AWS for use with your AWS resources using bring your own IP addresses (BYOIP). For more information, see [Bring Your Own IP Addresses (BYOIP)](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html) in the *Amazon EC2 User Guide* .
For more information, see [Elastic IP Addresses](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html) in the *Amazon EC2 User Guide* .
Example:
var listener listener
var eip cfnEIP
listener.AddEndpointGroup(jsii.String("Group"), &EndpointGroupOptions{
Endpoints: []iEndpoint{
ga_endpoints.NewCfnEipEndpoint(eip, &CfnEipEndpointProps{
Weight: jsii.Number(128),
}),
},
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-eip.html
func NewCfnEIP ¶
func NewCfnEIP(scope constructs.Construct, id *string, props *CfnEIPProps) CfnEIP
type CfnEIPAssociation ¶
type CfnEIPAssociation interface {
awscdk.CfnResource
awscdk.IInspectable
// The allocation ID.
AllocationId() *string
SetAllocationId(val *string)
// The ID of the association.
AttrId() *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
// Deprecated: this property has been deprecated.
Eip() *string
// Deprecated: this property has been deprecated.
SetEip(val *string)
// The ID of the instance.
InstanceId() *string
SetInstanceId(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 ID of the network interface.
NetworkInterfaceId() *string
SetNetworkInterfaceId(val *string)
// The tree node.
Node() constructs.Node
// The primary or secondary private IP address to associate with the Elastic IP address.
PrivateIpAddress() *string
SetPrivateIpAddress(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
// 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{})
}
Associates an Elastic IP address with an instance or a network interface.
Before you can use an Elastic IP address, you must allocate it to your account. For more information about working with Elastic IP addresses, see [Elastic IP address concepts and rules](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#vpc-eip-overview) .
You must specify `AllocationId` and either `InstanceId` , `NetworkInterfaceId` , or `PrivateIpAddress` .
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"
cfnEIPAssociation := awscdk.Aws_ec2.NewCfnEIPAssociation(this, jsii.String("MyCfnEIPAssociation"), &CfnEIPAssociationProps{
AllocationId: jsii.String("allocationId"),
Eip: jsii.String("eip"),
InstanceId: jsii.String("instanceId"),
NetworkInterfaceId: jsii.String("networkInterfaceId"),
PrivateIpAddress: jsii.String("privateIpAddress"),
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-eipassociation.html
func NewCfnEIPAssociation ¶
func NewCfnEIPAssociation(scope constructs.Construct, id *string, props *CfnEIPAssociationProps) CfnEIPAssociation
type CfnEIPAssociationProps ¶
type CfnEIPAssociationProps struct {
// The allocation ID.
//
// This is required.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-eipassociation.html#cfn-ec2-eipassociation-allocationid
//
AllocationId *string `field:"optional" json:"allocationId" yaml:"allocationId"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-eipassociation.html#cfn-ec2-eipassociation-eip
//
// Deprecated: this property has been deprecated.
Eip *string `field:"optional" json:"eip" yaml:"eip"`
// The ID of the instance.
//
// The instance must have exactly one attached network interface. You can specify either the instance ID or the network interface ID, but not both.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-eipassociation.html#cfn-ec2-eipassociation-instanceid
//
InstanceId *string `field:"optional" json:"instanceId" yaml:"instanceId"`
// The ID of the network interface.
//
// If the instance has more than one network interface, you must specify a network interface ID.
//
// You can specify either the instance ID or the network interface ID, but not both.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-eipassociation.html#cfn-ec2-eipassociation-networkinterfaceid
//
NetworkInterfaceId *string `field:"optional" json:"networkInterfaceId" yaml:"networkInterfaceId"`
// The primary or secondary private IP address to associate with the Elastic IP address.
//
// If no private IP address is specified, the Elastic IP address is associated with the primary private IP address.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-eipassociation.html#cfn-ec2-eipassociation-privateipaddress
//
PrivateIpAddress *string `field:"optional" json:"privateIpAddress" yaml:"privateIpAddress"`
}
Properties for defining a `CfnEIPAssociation`.
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"
cfnEIPAssociationProps := &CfnEIPAssociationProps{
AllocationId: jsii.String("allocationId"),
Eip: jsii.String("eip"),
InstanceId: jsii.String("instanceId"),
NetworkInterfaceId: jsii.String("networkInterfaceId"),
PrivateIpAddress: jsii.String("privateIpAddress"),
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-eipassociation.html
type CfnEIPProps ¶
type CfnEIPProps struct {
// The network ( `vpc` ).
//
// If you define an Elastic IP address and associate it with a VPC that is defined in the same template, you must declare a dependency on the VPC-gateway attachment by using the [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) on this resource.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-eip.html#cfn-ec2-eip-domain
//
Domain *string `field:"optional" json:"domain" yaml:"domain"`
// The ID of the instance.
//
// > Updates to the `InstanceId` property may require *some interruptions* . Updates on an EIP reassociates the address on its associated resource.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-eip.html#cfn-ec2-eip-instanceid
//
InstanceId *string `field:"optional" json:"instanceId" yaml:"instanceId"`
// A unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses.
//
// Use this parameter to limit the IP address to this location. IP addresses cannot move between network border groups.
//
// Use [DescribeAvailabilityZones](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeAvailabilityZones.html) to view the network border groups.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-eip.html#cfn-ec2-eip-networkbordergroup
//
NetworkBorderGroup *string `field:"optional" json:"networkBorderGroup" yaml:"networkBorderGroup"`
// The ID of an address pool that you own.
//
// Use this parameter to let Amazon EC2 select an address from the address pool.
//
// > Updates to the `PublicIpv4Pool` property may require *some interruptions* . Updates on an EIP reassociates the address on its associated resource.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-eip.html#cfn-ec2-eip-publicipv4pool
//
PublicIpv4Pool *string `field:"optional" json:"publicIpv4Pool" yaml:"publicIpv4Pool"`
// Any tags assigned to the Elastic IP address.
//
// > Updates to the `Tags` property may require *some interruptions* . Updates on an EIP reassociates the address on its associated resource.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-eip.html#cfn-ec2-eip-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
// The Elastic IP address you are accepting for transfer.
//
// You can only accept one transferred address. For more information on Elastic IP address transfers, see [Transfer Elastic IP addresses](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#transfer-EIPs-intro) in the *Amazon Virtual Private Cloud User Guide* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-eip.html#cfn-ec2-eip-transferaddress
//
TransferAddress *string `field:"optional" json:"transferAddress" yaml:"transferAddress"`
}
Properties for defining a `CfnEIP`.
Example:
var instance instance
var myZone hostedZone
elasticIp := ec2.NewCfnEIP(this, jsii.String("EIP"), &CfnEIPProps{
Domain: jsii.String("vpc"),
InstanceId: instance.InstanceId,
})
route53.NewARecord(this, jsii.String("ARecord"), &ARecordProps{
Zone: myZone,
Target: route53.RecordTarget_FromIpAddresses(elasticIp.ref),
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-eip.html
type CfnEgressOnlyInternetGateway ¶
type CfnEgressOnlyInternetGateway interface {
awscdk.CfnResource
awscdk.IInspectable
// The ID of the egress-only internet gateway.
AttrId() *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
// 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 ID of the VPC for which to create the egress-only internet gateway.
VpcId() *string
SetVpcId(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{})
}
[IPv6 only] Specifies an egress-only internet gateway for your VPC.
An egress-only internet gateway is used to enable outbound communication over IPv6 from instances in your VPC to the internet, and prevents hosts outside of your VPC from initiating an IPv6 connection with your instance.
For more information, see [Egress-only internet gateway](https://docs.aws.amazon.com/vpc/latest/userguide/egress-only-internet-gateway.html) in the *Amazon VPC User 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"
cfnEgressOnlyInternetGateway := awscdk.Aws_ec2.NewCfnEgressOnlyInternetGateway(this, jsii.String("MyCfnEgressOnlyInternetGateway"), &CfnEgressOnlyInternetGatewayProps{
VpcId: jsii.String("vpcId"),
})
func NewCfnEgressOnlyInternetGateway ¶
func NewCfnEgressOnlyInternetGateway(scope constructs.Construct, id *string, props *CfnEgressOnlyInternetGatewayProps) CfnEgressOnlyInternetGateway
type CfnEgressOnlyInternetGatewayProps ¶
type CfnEgressOnlyInternetGatewayProps struct {
// The ID of the VPC for which to create the egress-only internet gateway.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-egressonlyinternetgateway.html#cfn-ec2-egressonlyinternetgateway-vpcid
//
VpcId *string `field:"required" json:"vpcId" yaml:"vpcId"`
}
Properties for defining a `CfnEgressOnlyInternetGateway`.
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"
cfnEgressOnlyInternetGatewayProps := &CfnEgressOnlyInternetGatewayProps{
VpcId: jsii.String("vpcId"),
}
type CfnEnclaveCertificateIamRoleAssociation ¶
type CfnEnclaveCertificateIamRoleAssociation interface {
awscdk.CfnResource
awscdk.IInspectable
// The name of the Amazon S3 bucket to which the certificate was uploaded.
AttrCertificateS3BucketName() *string
// The Amazon S3 object key where the certificate, certificate chain, and encrypted private key bundle are stored.
//
// The object key is formatted as follows: `role_arn` / `certificate_arn` .
AttrCertificateS3ObjectKey() *string
// The ID of the AWS KMS key used to encrypt the private key of the certificate.
AttrEncryptionKmsKeyId() *string
// The ARN of the ACM certificate with which to associate the IAM role.
CertificateArn() *string
SetCertificateArn(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
// 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 ARN of the IAM role to associate with the ACM certificate.
RoleArn() *string
SetRoleArn(val *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{})
}
Associates an AWS Identity and Access Management (IAM) role with an AWS Certificate Manager (ACM) certificate.
This enables the certificate to be used by the ACM for Nitro Enclaves application inside an enclave. For more information, see [AWS Certificate Manager for Nitro Enclaves](https://docs.aws.amazon.com/enclaves/latest/user/nitro-enclave-refapp.html) in the *AWS Nitro Enclaves User Guide* .
When the IAM role is associated with the ACM certificate, the certificate, certificate chain, and encrypted private key are placed in an Amazon S3 location that only the associated IAM role can access. The private key of the certificate is encrypted with an AWS managed key that has an attached attestation-based key policy.
To enable the IAM role to access the Amazon S3 object, you must grant it permission to call `s3:GetObject` on the Amazon S3 bucket returned by the command. To enable the IAM role to access the KMS key, you must grant it permission to call `kms:Decrypt` on the KMS key returned by the command. For more information, see [Grant the role permission to access the certificate and encryption key](https://docs.aws.amazon.com/enclaves/latest/user/nitro-enclave-refapp.html#add-policy) in the *AWS Nitro Enclaves User 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"
cfnEnclaveCertificateIamRoleAssociation := awscdk.Aws_ec2.NewCfnEnclaveCertificateIamRoleAssociation(this, jsii.String("MyCfnEnclaveCertificateIamRoleAssociation"), &CfnEnclaveCertificateIamRoleAssociationProps{
CertificateArn: jsii.String("certificateArn"),
RoleArn: jsii.String("roleArn"),
})
func NewCfnEnclaveCertificateIamRoleAssociation ¶
func NewCfnEnclaveCertificateIamRoleAssociation(scope constructs.Construct, id *string, props *CfnEnclaveCertificateIamRoleAssociationProps) CfnEnclaveCertificateIamRoleAssociation
type CfnEnclaveCertificateIamRoleAssociationProps ¶
type CfnEnclaveCertificateIamRoleAssociationProps struct {
// The ARN of the ACM certificate with which to associate the IAM role.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-enclavecertificateiamroleassociation.html#cfn-ec2-enclavecertificateiamroleassociation-certificatearn
//
CertificateArn *string `field:"required" json:"certificateArn" yaml:"certificateArn"`
// The ARN of the IAM role to associate with the ACM certificate.
//
// You can associate up to 16 IAM roles with an ACM certificate.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-enclavecertificateiamroleassociation.html#cfn-ec2-enclavecertificateiamroleassociation-rolearn
//
RoleArn *string `field:"required" json:"roleArn" yaml:"roleArn"`
}
Properties for defining a `CfnEnclaveCertificateIamRoleAssociation`.
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"
cfnEnclaveCertificateIamRoleAssociationProps := &CfnEnclaveCertificateIamRoleAssociationProps{
CertificateArn: jsii.String("certificateArn"),
RoleArn: jsii.String("roleArn"),
}
type CfnFlowLog ¶
type CfnFlowLog interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggable
// The ID of the flow log.
//
// For example, `fl-123456abc123abc1` .
AttrId() *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 ARN of the IAM role that allows the service to publish flow logs across accounts.
DeliverCrossAccountRole() *string
SetDeliverCrossAccountRole(val *string)
// The ARN of the IAM role that allows Amazon EC2 to publish flow logs to the log destination.
DeliverLogsPermissionArn() *string
SetDeliverLogsPermissionArn(val *string)
// The destination options.
DestinationOptions() interface{}
SetDestinationOptions(val interface{})
// The destination for the flow log data.
//
// The meaning of this parameter depends on the destination type.
LogDestination() *string
SetLogDestination(val *string)
// The type of destination for the flow log data.
LogDestinationType() *string
SetLogDestinationType(val *string)
// The fields to include in the flow log record, in the order in which they should appear.
LogFormat() *string
SetLogFormat(val *string)
// The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs.
LogGroupName() *string
SetLogGroupName(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 maximum interval of time during which a flow of packets is captured and aggregated into a flow log record.
MaxAggregationInterval() *float64
SetMaxAggregationInterval(val *float64)
// 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 ID of the resource to monitor.
ResourceId() *string
SetResourceId(val *string)
// The type of resource to monitor.
ResourceType() *string
SetResourceType(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
// The tags to apply to the flow logs.
TagsRaw() *[]*awscdk.CfnTag
SetTagsRaw(val *[]*awscdk.CfnTag)
// The type of traffic to monitor (accepted traffic, rejected traffic, or all traffic).
TrafficType() *string
SetTrafficType(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{})
}
Specifies a VPC flow log that captures IP traffic for a specified network interface, subnet, or VPC.
To view the log data, use Amazon CloudWatch Logs (CloudWatch Logs) to help troubleshoot connection issues. For example, you can use a flow log to investigate why certain traffic isn't reaching an instance, which can help you diagnose overly restrictive security group rules. For more information, see [VPC Flow Logs](https://docs.aws.amazon.com/vpc/latest/userguide/flow-logs.html) in the *Amazon VPC User 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"
var destinationOptions interface{}
cfnFlowLog := awscdk.Aws_ec2.NewCfnFlowLog(this, jsii.String("MyCfnFlowLog"), &CfnFlowLogProps{
ResourceId: jsii.String("resourceId"),
ResourceType: jsii.String("resourceType"),
// the properties below are optional
DeliverCrossAccountRole: jsii.String("deliverCrossAccountRole"),
DeliverLogsPermissionArn: jsii.String("deliverLogsPermissionArn"),
DestinationOptions: destinationOptions,
LogDestination: jsii.String("logDestination"),
LogDestinationType: jsii.String("logDestinationType"),
LogFormat: jsii.String("logFormat"),
LogGroupName: jsii.String("logGroupName"),
MaxAggregationInterval: jsii.Number(123),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
TrafficType: jsii.String("trafficType"),
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html
func NewCfnFlowLog ¶
func NewCfnFlowLog(scope constructs.Construct, id *string, props *CfnFlowLogProps) CfnFlowLog
type CfnFlowLogProps ¶
type CfnFlowLogProps struct {
// The ID of the resource to monitor.
//
// For example, if the resource type is `VPC` , specify the ID of the VPC.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-resourceid
//
ResourceId *string `field:"required" json:"resourceId" yaml:"resourceId"`
// The type of resource to monitor.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-resourcetype
//
ResourceType *string `field:"required" json:"resourceType" yaml:"resourceType"`
// The ARN of the IAM role that allows the service to publish flow logs across accounts.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-delivercrossaccountrole
//
DeliverCrossAccountRole *string `field:"optional" json:"deliverCrossAccountRole" yaml:"deliverCrossAccountRole"`
// The ARN of the IAM role that allows Amazon EC2 to publish flow logs to the log destination.
//
// This parameter is required if the destination type is `cloud-watch-logs` , or if the destination type is `kinesis-data-firehose` and the delivery stream and the resources to monitor are in different accounts.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-deliverlogspermissionarn
//
DeliverLogsPermissionArn *string `field:"optional" json:"deliverLogsPermissionArn" yaml:"deliverLogsPermissionArn"`
// The destination options.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-destinationoptions
//
DestinationOptions interface{} `field:"optional" json:"destinationOptions" yaml:"destinationOptions"`
// The destination for the flow log data. The meaning of this parameter depends on the destination type.
//
// - If the destination type is `cloud-watch-logs` , specify the ARN of a CloudWatch Logs log group. For example:
//
// arn:aws:logs: *region* : *account_id* :log-group: *my_group*
//
// Alternatively, use the `LogGroupName` parameter.
// - If the destination type is `s3` , specify the ARN of an S3 bucket. For example:
//
// arn:aws:s3::: *my_bucket* / *my_subfolder* /
//
// The subfolder is optional. Note that you can't use `AWSLogs` as a subfolder name.
// - If the destination type is `kinesis-data-firehose` , specify the ARN of a Kinesis Data Firehose delivery stream. For example:
//
// arn:aws:firehose: *region* : *account_id* :deliverystream: *my_stream*.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-logdestination
//
LogDestination *string `field:"optional" json:"logDestination" yaml:"logDestination"`
// The type of destination for the flow log data.
//
// Default: `cloud-watch-logs`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-logdestinationtype
//
LogDestinationType *string `field:"optional" json:"logDestinationType" yaml:"logDestinationType"`
// The fields to include in the flow log record, in the order in which they should appear.
//
// If you omit this parameter, the flow log is created using the default format. If you specify this parameter, you must include at least one field. For more information about the available fields, see [Flow log records](https://docs.aws.amazon.com/vpc/latest/userguide/flow-logs.html#flow-log-records) in the *Amazon VPC User Guide* or [Transit Gateway Flow Log records](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-flow-logs.html#flow-log-records) in the *AWS Transit Gateway Guide* .
//
// Specify the fields using the `${field-id}` format, separated by spaces.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-logformat
//
LogFormat *string `field:"optional" json:"logFormat" yaml:"logFormat"`
// The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs.
//
// This parameter is valid only if the destination type is `cloud-watch-logs` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-loggroupname
//
LogGroupName *string `field:"optional" json:"logGroupName" yaml:"logGroupName"`
// The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record.
//
// The possible values are 60 seconds (1 minute) or 600 seconds (10 minutes). This parameter must be 60 seconds for transit gateway resource types.
//
// When a network interface is attached to a [Nitro-based instance](https://docs.aws.amazon.com/ec2/latest/instancetypes/ec2-nitro-instances.html) , the aggregation interval is always 60 seconds or less, regardless of the value that you specify.
//
// Default: 600.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-maxaggregationinterval
//
MaxAggregationInterval *float64 `field:"optional" json:"maxAggregationInterval" yaml:"maxAggregationInterval"`
// The tags to apply to the flow logs.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
// The type of traffic to monitor (accepted traffic, rejected traffic, or all traffic).
//
// This parameter is not supported for transit gateway resource types. It is required for the other resource types.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-traffictype
//
TrafficType *string `field:"optional" json:"trafficType" yaml:"trafficType"`
}
Properties for defining a `CfnFlowLog`.
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"
var destinationOptions interface{}
cfnFlowLogProps := &CfnFlowLogProps{
ResourceId: jsii.String("resourceId"),
ResourceType: jsii.String("resourceType"),
// the properties below are optional
DeliverCrossAccountRole: jsii.String("deliverCrossAccountRole"),
DeliverLogsPermissionArn: jsii.String("deliverLogsPermissionArn"),
DestinationOptions: destinationOptions,
LogDestination: jsii.String("logDestination"),
LogDestinationType: jsii.String("logDestinationType"),
LogFormat: jsii.String("logFormat"),
LogGroupName: jsii.String("logGroupName"),
MaxAggregationInterval: jsii.Number(123),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
TrafficType: jsii.String("trafficType"),
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html
type CfnFlowLog_DestinationOptionsProperty ¶ added in v2.55.0
type CfnFlowLog_DestinationOptionsProperty struct {
// The format for the flow log.
//
// The default is `plain-text` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-flowlog-destinationoptions.html#cfn-ec2-flowlog-destinationoptions-fileformat
//
FileFormat *string `field:"required" json:"fileFormat" yaml:"fileFormat"`
// Indicates whether to use Hive-compatible prefixes for flow logs stored in Amazon S3.
//
// The default is `false` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-flowlog-destinationoptions.html#cfn-ec2-flowlog-destinationoptions-hivecompatiblepartitions
//
HiveCompatiblePartitions interface{} `field:"required" json:"hiveCompatiblePartitions" yaml:"hiveCompatiblePartitions"`
// Indicates whether to partition the flow log per hour.
//
// This reduces the cost and response time for queries. The default is `false` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-flowlog-destinationoptions.html#cfn-ec2-flowlog-destinationoptions-perhourpartition
//
PerHourPartition interface{} `field:"required" json:"perHourPartition" yaml:"perHourPartition"`
}
Describes the destination options for a flow log.
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"
destinationOptionsProperty := &DestinationOptionsProperty{
FileFormat: jsii.String("fileFormat"),
HiveCompatiblePartitions: jsii.Boolean(false),
PerHourPartition: jsii.Boolean(false),
}
type CfnGatewayRouteTableAssociation ¶
type CfnGatewayRouteTableAssociation interface {
awscdk.CfnResource
awscdk.IInspectable
// The ID of the route table association.
AttrAssociationId() *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 ID of the gateway.
GatewayId() *string
SetGatewayId(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 ID of the route table.
RouteTableId() *string
SetRouteTableId(val *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{})
}
Associates a virtual private gateway or internet gateway with a route table.
The gateway and route table must be in the same VPC. This association causes the incoming traffic to the gateway to be routed according to the routes in the route table.
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"
cfnGatewayRouteTableAssociation := awscdk.Aws_ec2.NewCfnGatewayRouteTableAssociation(this, jsii.String("MyCfnGatewayRouteTableAssociation"), &CfnGatewayRouteTableAssociationProps{
GatewayId: jsii.String("gatewayId"),
RouteTableId: jsii.String("routeTableId"),
})
func NewCfnGatewayRouteTableAssociation ¶
func NewCfnGatewayRouteTableAssociation(scope constructs.Construct, id *string, props *CfnGatewayRouteTableAssociationProps) CfnGatewayRouteTableAssociation
type CfnGatewayRouteTableAssociationProps ¶
type CfnGatewayRouteTableAssociationProps struct {
// The ID of the gateway.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-gatewayroutetableassociation.html#cfn-ec2-gatewayroutetableassociation-gatewayid
//
GatewayId *string `field:"required" json:"gatewayId" yaml:"gatewayId"`
// The ID of the route table.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-gatewayroutetableassociation.html#cfn-ec2-gatewayroutetableassociation-routetableid
//
RouteTableId *string `field:"required" json:"routeTableId" yaml:"routeTableId"`
}
Properties for defining a `CfnGatewayRouteTableAssociation`.
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"
cfnGatewayRouteTableAssociationProps := &CfnGatewayRouteTableAssociationProps{
GatewayId: jsii.String("gatewayId"),
RouteTableId: jsii.String("routeTableId"),
}
type CfnHost ¶
type CfnHost interface {
awscdk.CfnResource
awscdk.IInspectable
// The ID of the Outpost hardware asset on which the Dedicated Host is allocated.
AssetId() *string
SetAssetId(val *string)
// The ID of the host.
AttrHostId() *string
// Indicates whether the host accepts any untargeted instance launches that match its instance type configuration, or if it only accepts Host tenancy instance launches that specify its unique host ID.
AutoPlacement() *string
SetAutoPlacement(val *string)
// The Availability Zone in which to allocate the Dedicated Host.
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
// Indicates whether host maintenance is enabled or disabled for the Dedicated Host.
HostMaintenance() *string
SetHostMaintenance(val *string)
// Indicates whether to enable or disable host recovery for the Dedicated Host.
HostRecovery() *string
SetHostRecovery(val *string)
// The instance family supported by the Dedicated Host.
InstanceFamily() *string
SetInstanceFamily(val *string)
// Specifies the instance type to be supported by the Dedicated Hosts.
InstanceType() *string
SetInstanceType(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
// The Amazon Resource Name (ARN) of the AWS Outpost on which the Dedicated Host is allocated.
OutpostArn() *string
SetOutpostArn(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
// 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{})
}
Allocates a fully dedicated physical server for launching EC2 instances.
Because the host is fully dedicated for your use, it can help you address compliance requirements and reduce costs by allowing you to use your existing server-bound software licenses. For more information, see [Dedicated Hosts](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-hosts-overview.html) in the *Amazon EC2 User 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"
cfnHost := awscdk.Aws_ec2.NewCfnHost(this, jsii.String("MyCfnHost"), &CfnHostProps{
AvailabilityZone: jsii.String("availabilityZone"),
// the properties below are optional
AssetId: jsii.String("assetId"),
AutoPlacement: jsii.String("autoPlacement"),
HostMaintenance: jsii.String("hostMaintenance"),
HostRecovery: jsii.String("hostRecovery"),
InstanceFamily: jsii.String("instanceFamily"),
InstanceType: jsii.String("instanceType"),
OutpostArn: jsii.String("outpostArn"),
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-host.html
func NewCfnHost ¶
func NewCfnHost(scope constructs.Construct, id *string, props *CfnHostProps) CfnHost
type CfnHostProps ¶
type CfnHostProps struct {
// The Availability Zone in which to allocate the Dedicated Host.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-host.html#cfn-ec2-host-availabilityzone
//
AvailabilityZone *string `field:"required" json:"availabilityZone" yaml:"availabilityZone"`
// The ID of the Outpost hardware asset on which the Dedicated Host is allocated.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-host.html#cfn-ec2-host-assetid
//
AssetId *string `field:"optional" json:"assetId" yaml:"assetId"`
// Indicates whether the host accepts any untargeted instance launches that match its instance type configuration, or if it only accepts Host tenancy instance launches that specify its unique host ID.
//
// For more information, see [Understanding auto-placement and affinity](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/how-dedicated-hosts-work.html#dedicated-hosts-understanding) in the *Amazon EC2 User Guide* .
//
// Default: `off`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-host.html#cfn-ec2-host-autoplacement
//
AutoPlacement *string `field:"optional" json:"autoPlacement" yaml:"autoPlacement"`
// Indicates whether host maintenance is enabled or disabled for the Dedicated Host.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-host.html#cfn-ec2-host-hostmaintenance
//
HostMaintenance *string `field:"optional" json:"hostMaintenance" yaml:"hostMaintenance"`
// Indicates whether to enable or disable host recovery for the Dedicated Host.
//
// Host recovery is disabled by default. For more information, see [Host recovery](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-hosts-recovery.html) in the *Amazon EC2 User Guide* .
//
// Default: `off`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-host.html#cfn-ec2-host-hostrecovery
//
HostRecovery *string `field:"optional" json:"hostRecovery" yaml:"hostRecovery"`
// The instance family supported by the Dedicated Host.
//
// For example, `m5` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-host.html#cfn-ec2-host-instancefamily
//
InstanceFamily *string `field:"optional" json:"instanceFamily" yaml:"instanceFamily"`
// Specifies the instance type to be supported by the Dedicated Hosts.
//
// If you specify an instance type, the Dedicated Hosts support instances of the specified instance type only.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-host.html#cfn-ec2-host-instancetype
//
InstanceType *string `field:"optional" json:"instanceType" yaml:"instanceType"`
// The Amazon Resource Name (ARN) of the AWS Outpost on which the Dedicated Host is allocated.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-host.html#cfn-ec2-host-outpostarn
//
OutpostArn *string `field:"optional" json:"outpostArn" yaml:"outpostArn"`
}
Properties for defining a `CfnHost`.
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"
cfnHostProps := &CfnHostProps{
AvailabilityZone: jsii.String("availabilityZone"),
// the properties below are optional
AssetId: jsii.String("assetId"),
AutoPlacement: jsii.String("autoPlacement"),
HostMaintenance: jsii.String("hostMaintenance"),
HostRecovery: jsii.String("hostRecovery"),
InstanceFamily: jsii.String("instanceFamily"),
InstanceType: jsii.String("instanceType"),
OutpostArn: jsii.String("outpostArn"),
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-host.html
type CfnIPAM ¶ added in v2.2.0
type CfnIPAM interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggable
// The ARN of the IPAM.
AttrArn() *string
// The ID of the default resource discovery association.
AttrDefaultResourceDiscoveryAssociationId() *string
// The ID of the default resource discovery.
AttrDefaultResourceDiscoveryId() *string
// The ID of the IPAM.
AttrIpamId() *string
// The ID of the default private scope.
AttrPrivateDefaultScopeId() *string
// The ID of the default public scope.
AttrPublicDefaultScopeId() *string
// The number of resource discovery associations.
AttrResourceDiscoveryAssociationCount() *float64
// The number of scopes.
AttrScopeCount() *float64
// 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 description for the IPAM.
Description() *string
SetDescription(val *string)
// Enable this option to use your own GUA ranges as private IPv6 addresses.
EnablePrivateGua() interface{}
SetEnablePrivateGua(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 operating Regions for an IPAM.
OperatingRegions() interface{}
SetOperatingRegions(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
// The key/value combination of a tag assigned to the resource.
TagsRaw() *[]*awscdk.CfnTag
SetTagsRaw(val *[]*awscdk.CfnTag)
// IPAM is offered in a Free Tier and an Advanced Tier.
Tier() *string
SetTier(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{})
}
IPAM is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across AWS Regions and accounts throughout your AWS Organization.
For more information, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide* .
There are AWS Identity and Access Management (IAM) permissions required to fully manage an IPAM in CloudFormation. For more information, see [Example policy](https://docs.aws.amazon.com//vpc/latest/ipam/iam-ipam-policy-examples.html) in the *Amazon VPC IPAM User 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"
cfnIPAM := awscdk.Aws_ec2.NewCfnIPAM(this, jsii.String("MyCfnIPAM"), &CfnIPAMProps{
Description: jsii.String("description"),
EnablePrivateGua: jsii.Boolean(false),
OperatingRegions: []interface{}{
&IpamOperatingRegionProperty{
RegionName: jsii.String("regionName"),
},
},
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
Tier: jsii.String("tier"),
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipam.html
func NewCfnIPAM ¶ added in v2.2.0
func NewCfnIPAM(scope constructs.Construct, id *string, props *CfnIPAMProps) CfnIPAM
type CfnIPAMAllocation ¶ added in v2.2.0
type CfnIPAMAllocation interface {
awscdk.CfnResource
awscdk.IInspectable
// The ID of an allocation.
AttrIpamPoolAllocationId() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// The CIDR you would like to allocate from the IPAM pool.
//
// Note the following:.
Cidr() *string
SetCidr(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
// A description for the allocation.
Description() *string
SetDescription(val *string)
// The ID of the IPAM pool from which you would like to allocate a CIDR.
IpamPoolId() *string
SetIpamPoolId(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 netmask length of the CIDR you would like to allocate from the IPAM pool.
//
// Note the following:.
NetmaskLength() *float64
SetNetmaskLength(val *float64)
// 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{})
}
In IPAM, an allocation is a CIDR assignment from an IPAM pool to another IPAM pool or to a resource.
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"
cfnIPAMAllocation := awscdk.Aws_ec2.NewCfnIPAMAllocation(this, jsii.String("MyCfnIPAMAllocation"), &CfnIPAMAllocationProps{
IpamPoolId: jsii.String("ipamPoolId"),
// the properties below are optional
Cidr: jsii.String("cidr"),
Description: jsii.String("description"),
NetmaskLength: jsii.Number(123),
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamallocation.html
func NewCfnIPAMAllocation ¶ added in v2.2.0
func NewCfnIPAMAllocation(scope constructs.Construct, id *string, props *CfnIPAMAllocationProps) CfnIPAMAllocation
type CfnIPAMAllocationProps ¶ added in v2.2.0
type CfnIPAMAllocationProps struct {
// The ID of the IPAM pool from which you would like to allocate a CIDR.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamallocation.html#cfn-ec2-ipamallocation-ipampoolid
//
IpamPoolId *string `field:"required" json:"ipamPoolId" yaml:"ipamPoolId"`
// The CIDR you would like to allocate from the IPAM pool. Note the following:.
//
// - If there is no DefaultNetmaskLength allocation rule set on the pool, you must specify either the NetmaskLength or the CIDR.
// - If the DefaultNetmaskLength allocation rule is set on the pool, you can specify either the NetmaskLength or the CIDR and the DefaultNetmaskLength allocation rule will be ignored.
//
// Possible values: Any available IPv4 or IPv6 CIDR.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamallocation.html#cfn-ec2-ipamallocation-cidr
//
Cidr *string `field:"optional" json:"cidr" yaml:"cidr"`
// A description for the allocation.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamallocation.html#cfn-ec2-ipamallocation-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// The netmask length of the CIDR you would like to allocate from the IPAM pool. Note the following:.
//
// - If there is no DefaultNetmaskLength allocation rule set on the pool, you must specify either the NetmaskLength or the CIDR.
// - If the DefaultNetmaskLength allocation rule is set on the pool, you can specify either the NetmaskLength or the CIDR and the DefaultNetmaskLength allocation rule will be ignored.
//
// Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamallocation.html#cfn-ec2-ipamallocation-netmasklength
//
NetmaskLength *float64 `field:"optional" json:"netmaskLength" yaml:"netmaskLength"`
}
Properties for defining a `CfnIPAMAllocation`.
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"
cfnIPAMAllocationProps := &CfnIPAMAllocationProps{
IpamPoolId: jsii.String("ipamPoolId"),
// the properties below are optional
Cidr: jsii.String("cidr"),
Description: jsii.String("description"),
NetmaskLength: jsii.Number(123),
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamallocation.html
type CfnIPAMPool ¶ added in v2.2.0
type CfnIPAMPool interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggable
// The address family of the pool.
AddressFamily() *string
SetAddressFamily(val *string)
// The default netmask length for allocations added to this pool.
AllocationDefaultNetmaskLength() *float64
SetAllocationDefaultNetmaskLength(val *float64)
// The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant.
AllocationMaxNetmaskLength() *float64
SetAllocationMaxNetmaskLength(val *float64)
// The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant.
AllocationMinNetmaskLength() *float64
SetAllocationMinNetmaskLength(val *float64)
// Tags that are required for resources that use CIDRs from this IPAM pool.
AllocationResourceTags() interface{}
SetAllocationResourceTags(val interface{})
// The ARN of the IPAM pool.
AttrArn() *string
// The ARN of the IPAM.
AttrIpamArn() *string
// The ID of the IPAM pool.
AttrIpamPoolId() *string
// The ARN of the scope of the IPAM pool.
AttrIpamScopeArn() *string
// The scope of the IPAM.
AttrIpamScopeType() *string
// The depth of pools in your IPAM pool.
//
// The pool depth quota is 10.
AttrPoolDepth() *float64
// The state of the IPAM pool.
AttrState() *string
// A message related to the failed creation of an IPAM pool.
AttrStateMessage() *string
// If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM.
AutoImport() interface{}
SetAutoImport(val interface{})
// Limits which service in AWS that the pool can be used in.
AwsService() *string
SetAwsService(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 description of the IPAM pool.
Description() *string
SetDescription(val *string)
// The ID of the scope in which you would like to create the IPAM pool.
IpamScopeId() *string
SetIpamScopeId(val *string)
// The locale of the IPAM pool.
Locale() *string
SetLocale(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
// Information about the CIDRs provisioned to an IPAM pool.
ProvisionedCidrs() interface{}
SetProvisionedCidrs(val interface{})
// The IP address source for pools in the public scope.
PublicIpSource() *string
SetPublicIpSource(val *string)
// Determines if a pool is publicly advertisable.
PubliclyAdvertisable() interface{}
SetPubliclyAdvertisable(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 ID of the source IPAM pool.
SourceIpamPoolId() *string
SetSourceIpamPoolId(val *string)
// The resource used to provision CIDRs to a resource planning pool.
SourceResource() interface{}
SetSourceResource(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
// The key/value combination of a tag assigned to the 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{})
}
In IPAM, a pool is a collection of contiguous IP addresses CIDRs.
Pools enable you to organize your IP addresses according to your routing and security needs. For example, if you have separate routing and security needs for development and production applications, you can create a pool for each.
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"
cfnIPAMPool := awscdk.Aws_ec2.NewCfnIPAMPool(this, jsii.String("MyCfnIPAMPool"), &CfnIPAMPoolProps{
AddressFamily: jsii.String("addressFamily"),
IpamScopeId: jsii.String("ipamScopeId"),
// the properties below are optional
AllocationDefaultNetmaskLength: jsii.Number(123),
AllocationMaxNetmaskLength: jsii.Number(123),
AllocationMinNetmaskLength: jsii.Number(123),
AllocationResourceTags: []interface{}{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
AutoImport: jsii.Boolean(false),
AwsService: jsii.String("awsService"),
Description: jsii.String("description"),
Locale: jsii.String("locale"),
ProvisionedCidrs: []interface{}{
&ProvisionedCidrProperty{
Cidr: jsii.String("cidr"),
},
},
PublicIpSource: jsii.String("publicIpSource"),
PubliclyAdvertisable: jsii.Boolean(false),
SourceIpamPoolId: jsii.String("sourceIpamPoolId"),
SourceResource: &SourceResourceProperty{
ResourceId: jsii.String("resourceId"),
ResourceOwner: jsii.String("resourceOwner"),
ResourceRegion: jsii.String("resourceRegion"),
ResourceType: jsii.String("resourceType"),
},
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html
func NewCfnIPAMPool ¶ added in v2.2.0
func NewCfnIPAMPool(scope constructs.Construct, id *string, props *CfnIPAMPoolProps) CfnIPAMPool
type CfnIPAMPoolCidr ¶ added in v2.64.0
type CfnIPAMPoolCidr interface {
awscdk.CfnResource
awscdk.IInspectable
// The IPAM pool CIDR ID.
AttrIpamPoolCidrId() *string
// The state of the CIDR.
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 CIDR provisioned to the IPAM pool.
Cidr() *string
SetCidr(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 ID of the IPAM pool.
IpamPoolId() *string
SetIpamPoolId(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 netmask length of the CIDR you'd like to provision to a pool.
NetmaskLength() *float64
SetNetmaskLength(val *float64)
// 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{})
}
A CIDR provisioned to an IPAM pool.
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"
cfnIPAMPoolCidr := awscdk.Aws_ec2.NewCfnIPAMPoolCidr(this, jsii.String("MyCfnIPAMPoolCidr"), &CfnIPAMPoolCidrProps{
IpamPoolId: jsii.String("ipamPoolId"),
// the properties below are optional
Cidr: jsii.String("cidr"),
NetmaskLength: jsii.Number(123),
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampoolcidr.html
func NewCfnIPAMPoolCidr ¶ added in v2.64.0
func NewCfnIPAMPoolCidr(scope constructs.Construct, id *string, props *CfnIPAMPoolCidrProps) CfnIPAMPoolCidr
type CfnIPAMPoolCidrProps ¶ added in v2.64.0
type CfnIPAMPoolCidrProps struct {
// The ID of the IPAM pool.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampoolcidr.html#cfn-ec2-ipampoolcidr-ipampoolid
//
IpamPoolId *string `field:"required" json:"ipamPoolId" yaml:"ipamPoolId"`
// The CIDR provisioned to the IPAM pool.
//
// A CIDR is a representation of an IP address and its associated network mask (or netmask) and refers to a range of IP addresses. An IPv4 CIDR example is `10.24.34.0/23` . An IPv6 CIDR example is `2001:DB8::/32` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampoolcidr.html#cfn-ec2-ipampoolcidr-cidr
//
Cidr *string `field:"optional" json:"cidr" yaml:"cidr"`
// The netmask length of the CIDR you'd like to provision to a pool.
//
// Can be used for provisioning Amazon-provided IPv6 CIDRs to top-level pools and for provisioning CIDRs to pools with source pools. Cannot be used to provision BYOIP CIDRs to top-level pools. "NetmaskLength" or "Cidr" is required.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampoolcidr.html#cfn-ec2-ipampoolcidr-netmasklength
//
NetmaskLength *float64 `field:"optional" json:"netmaskLength" yaml:"netmaskLength"`
}
Properties for defining a `CfnIPAMPoolCidr`.
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"
cfnIPAMPoolCidrProps := &CfnIPAMPoolCidrProps{
IpamPoolId: jsii.String("ipamPoolId"),
// the properties below are optional
Cidr: jsii.String("cidr"),
NetmaskLength: jsii.Number(123),
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampoolcidr.html
type CfnIPAMPoolProps ¶ added in v2.2.0
type CfnIPAMPoolProps struct {
// The address family of the pool.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-addressfamily
//
AddressFamily *string `field:"required" json:"addressFamily" yaml:"addressFamily"`
// The ID of the scope in which you would like to create the IPAM pool.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-ipamscopeid
//
IpamScopeId *string `field:"required" json:"ipamScopeId" yaml:"ipamScopeId"`
// The default netmask length for allocations added to this pool.
//
// If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-allocationdefaultnetmasklength
//
AllocationDefaultNetmaskLength *float64 `field:"optional" json:"allocationDefaultNetmaskLength" yaml:"allocationDefaultNetmaskLength"`
// The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant.
//
// The maximum netmask length must be greater than the minimum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-allocationmaxnetmasklength
//
AllocationMaxNetmaskLength *float64 `field:"optional" json:"allocationMaxNetmaskLength" yaml:"allocationMaxNetmaskLength"`
// The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant.
//
// The minimum netmask length must be less than the maximum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-allocationminnetmasklength
//
AllocationMinNetmaskLength *float64 `field:"optional" json:"allocationMinNetmaskLength" yaml:"allocationMinNetmaskLength"`
// Tags that are required for resources that use CIDRs from this IPAM pool.
//
// Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-allocationresourcetags
//
AllocationResourceTags interface{} `field:"optional" json:"allocationResourceTags" yaml:"allocationResourceTags"`
// If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM.
//
// The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.
//
// A locale must be set on the pool for this feature to work.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-autoimport
//
AutoImport interface{} `field:"optional" json:"autoImport" yaml:"autoImport"`
// Limits which service in AWS that the pool can be used in.
//
// "ec2", for example, allows users to use space for Elastic IP addresses and VPCs.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-awsservice
//
AwsService *string `field:"optional" json:"awsService" yaml:"awsService"`
// The description of the IPAM pool.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// The locale of the IPAM pool.
//
// The locale for the pool should be one of the following:
//
// - An AWS Region where you want this IPAM pool to be available for allocations.
// - The network border group for an AWS Local Zone where you want this IPAM pool to be available for allocations ( [supported Local Zones](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html#byoip-zone-avail) ). This option is only available for IPAM IPv4 pools in the public scope.
//
// If you choose an AWS Region for locale that has not been configured as an operating Region for the IPAM, you'll get an error.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-locale
//
Locale *string `field:"optional" json:"locale" yaml:"locale"`
// Information about the CIDRs provisioned to an IPAM pool.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-provisionedcidrs
//
ProvisionedCidrs interface{} `field:"optional" json:"provisionedCidrs" yaml:"provisionedCidrs"`
// The IP address source for pools in the public scope.
//
// Only used for provisioning IP address CIDRs to pools in the public scope. Default is `BYOIP` . For more information, see [Create IPv6 pools](https://docs.aws.amazon.com//vpc/latest/ipam/intro-create-ipv6-pools.html) in the *Amazon VPC IPAM User Guide* . By default, you can add only one Amazon-provided IPv6 CIDR block to a top-level IPv6 pool. For information on increasing the default limit, see [Quotas for your IPAM](https://docs.aws.amazon.com//vpc/latest/ipam/quotas-ipam.html) in the *Amazon VPC IPAM User Guide* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-publicipsource
//
PublicIpSource *string `field:"optional" json:"publicIpSource" yaml:"publicIpSource"`
// Determines if a pool is publicly advertisable.
//
// This option is not available for pools with AddressFamily set to `ipv4` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-publiclyadvertisable
//
PubliclyAdvertisable interface{} `field:"optional" json:"publiclyAdvertisable" yaml:"publiclyAdvertisable"`
// The ID of the source IPAM pool.
//
// You can use this option to create an IPAM pool within an existing source pool.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-sourceipampoolid
//
SourceIpamPoolId *string `field:"optional" json:"sourceIpamPoolId" yaml:"sourceIpamPoolId"`
// The resource used to provision CIDRs to a resource planning pool.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-sourceresource
//
SourceResource interface{} `field:"optional" json:"sourceResource" yaml:"sourceResource"`
// The key/value combination of a tag assigned to the resource.
//
// Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA` , specify `tag:Owner` for the filter name and `TeamA` for the filter value.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnIPAMPool`.
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"
cfnIPAMPoolProps := &CfnIPAMPoolProps{
AddressFamily: jsii.String("addressFamily"),
IpamScopeId: jsii.String("ipamScopeId"),
// the properties below are optional
AllocationDefaultNetmaskLength: jsii.Number(123),
AllocationMaxNetmaskLength: jsii.Number(123),
AllocationMinNetmaskLength: jsii.Number(123),
AllocationResourceTags: []interface{}{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
AutoImport: jsii.Boolean(false),
AwsService: jsii.String("awsService"),
Description: jsii.String("description"),
Locale: jsii.String("locale"),
ProvisionedCidrs: []interface{}{
&ProvisionedCidrProperty{
Cidr: jsii.String("cidr"),
},
},
PublicIpSource: jsii.String("publicIpSource"),
PubliclyAdvertisable: jsii.Boolean(false),
SourceIpamPoolId: jsii.String("sourceIpamPoolId"),
SourceResource: &SourceResourceProperty{
ResourceId: jsii.String("resourceId"),
ResourceOwner: jsii.String("resourceOwner"),
ResourceRegion: jsii.String("resourceRegion"),
ResourceType: jsii.String("resourceType"),
},
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html
type CfnIPAMPool_ProvisionedCidrProperty ¶ added in v2.2.0
type CfnIPAMPool_ProvisionedCidrProperty struct {
// The CIDR provisioned to the IPAM pool.
//
// A CIDR is a representation of an IP address and its associated network mask (or netmask) and refers to a range of IP addresses. An IPv4 CIDR example is `10.24.34.0/23` . An IPv6 CIDR example is `2001:DB8::/32` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ipampool-provisionedcidr.html#cfn-ec2-ipampool-provisionedcidr-cidr
//
Cidr *string `field:"required" json:"cidr" yaml:"cidr"`
}
The CIDR provisioned to the IPAM pool.
A CIDR is a representation of an IP address and its associated network mask (or netmask) and refers to a range of IP addresses. An IPv4 CIDR example is `10.24.34.0/23` . An IPv6 CIDR example is `2001:DB8::/32` .
> This resource type does not allow you to provision a CIDR using the netmask length. To provision a CIDR using netmask length, use [AWS::EC2::IPAMPoolCidr](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampoolcidr.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"
provisionedCidrProperty := &ProvisionedCidrProperty{
Cidr: jsii.String("cidr"),
}
type CfnIPAMPool_SourceResourceProperty ¶ added in v2.122.0
type CfnIPAMPool_SourceResourceProperty struct {
// The source resource ID.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ipampool-sourceresource.html#cfn-ec2-ipampool-sourceresource-resourceid
//
ResourceId *string `field:"required" json:"resourceId" yaml:"resourceId"`
// The source resource owner.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ipampool-sourceresource.html#cfn-ec2-ipampool-sourceresource-resourceowner
//
ResourceOwner *string `field:"required" json:"resourceOwner" yaml:"resourceOwner"`
// The source resource Region.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ipampool-sourceresource.html#cfn-ec2-ipampool-sourceresource-resourceregion
//
ResourceRegion *string `field:"required" json:"resourceRegion" yaml:"resourceRegion"`
// The source resource type.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ipampool-sourceresource.html#cfn-ec2-ipampool-sourceresource-resourcetype
//
ResourceType *string `field:"required" json:"resourceType" yaml:"resourceType"`
}
The resource used to provision CIDRs to a resource planning pool.
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"
sourceResourceProperty := &SourceResourceProperty{
ResourceId: jsii.String("resourceId"),
ResourceOwner: jsii.String("resourceOwner"),
ResourceRegion: jsii.String("resourceRegion"),
ResourceType: jsii.String("resourceType"),
}
type CfnIPAMProps ¶ added in v2.2.0
type CfnIPAMProps struct {
// The description for the IPAM.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipam.html#cfn-ec2-ipam-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// Enable this option to use your own GUA ranges as private IPv6 addresses.
//
// This option is disabled by default.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipam.html#cfn-ec2-ipam-enableprivategua
//
EnablePrivateGua interface{} `field:"optional" json:"enablePrivateGua" yaml:"enablePrivateGua"`
// The operating Regions for an IPAM.
//
// Operating Regions are AWS Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the AWS Regions you select as operating Regions.
//
// For more information about operating Regions, see [Create an IPAM](https://docs.aws.amazon.com//vpc/latest/ipam/create-ipam.html) in the *Amazon VPC IPAM User Guide* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipam.html#cfn-ec2-ipam-operatingregions
//
OperatingRegions interface{} `field:"optional" json:"operatingRegions" yaml:"operatingRegions"`
// The key/value combination of a tag assigned to the resource.
//
// Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA` , specify `tag:Owner` for the filter name and `TeamA` for the filter value.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipam.html#cfn-ec2-ipam-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
// IPAM is offered in a Free Tier and an Advanced Tier.
//
// For more information about the features available in each tier and the costs associated with the tiers, see the [VPC IPAM product pricing page](https://docs.aws.amazon.com//vpc/pricing/) .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipam.html#cfn-ec2-ipam-tier
//
Tier *string `field:"optional" json:"tier" yaml:"tier"`
}
Properties for defining a `CfnIPAM`.
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"
cfnIPAMProps := &CfnIPAMProps{
Description: jsii.String("description"),
EnablePrivateGua: jsii.Boolean(false),
OperatingRegions: []interface{}{
&IpamOperatingRegionProperty{
RegionName: jsii.String("regionName"),
},
},
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
Tier: jsii.String("tier"),
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipam.html
type CfnIPAMResourceDiscovery ¶ added in v2.64.0
type CfnIPAMResourceDiscovery interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggable
// The resource discovery ARN.
AttrIpamResourceDiscoveryArn() *string
// The resource discovery ID.
AttrIpamResourceDiscoveryId() *string
// The resource discovery Region.
AttrIpamResourceDiscoveryRegion() *string
// Defines if the resource discovery is the default.
//
// The default resource discovery is the resource discovery automatically created when you create an IPAM.
AttrIsDefault() awscdk.IResolvable
// The owner ID.
AttrOwnerId() *string
// The resource discovery's state.
//
// - `create-in-progress` - Resource discovery is being created.
// - `create-complete` - Resource discovery creation is complete.
// - `create-failed` - Resource discovery creation has failed.
// - `modify-in-progress` - Resource discovery is being modified.
// - `modify-complete` - Resource discovery modification is complete.
// - `modify-failed` - Resource discovery modification has failed.
// - `delete-in-progress` - Resource discovery is being deleted.
// - `delete-complete` - Resource discovery deletion is complete.
// - `delete-failed` - Resource discovery deletion has failed.
// - `isolate-in-progress` - AWS account that created the resource discovery has been removed and the resource discovery is being isolated.
// - `isolate-complete` - Resource discovery isolation is complete.
// - `restore-in-progress` - AWS account that created the resource discovery and was isolated has been restored.
AttrState() *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 resource discovery description.
Description() *string
SetDescription(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
// The operating Regions for the resource discovery.
OperatingRegions() interface{}
SetOperatingRegions(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
// A tag is a label that you assign to an AWS 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{})
}
A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.
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"
cfnIPAMResourceDiscovery := awscdk.Aws_ec2.NewCfnIPAMResourceDiscovery(this, jsii.String("MyCfnIPAMResourceDiscovery"), &CfnIPAMResourceDiscoveryProps{
Description: jsii.String("description"),
OperatingRegions: []interface{}{
&IpamOperatingRegionProperty{
RegionName: jsii.String("regionName"),
},
},
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
func NewCfnIPAMResourceDiscovery ¶ added in v2.64.0
func NewCfnIPAMResourceDiscovery(scope constructs.Construct, id *string, props *CfnIPAMResourceDiscoveryProps) CfnIPAMResourceDiscovery
type CfnIPAMResourceDiscoveryAssociation ¶ added in v2.64.0
type CfnIPAMResourceDiscoveryAssociation interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggable
// The IPAM ARN.
AttrIpamArn() *string
// The IPAM home Region.
AttrIpamRegion() *string
// The resource discovery association ARN.
AttrIpamResourceDiscoveryAssociationArn() *string
// The resource discovery association ID.
AttrIpamResourceDiscoveryAssociationId() *string
// Defines if the resource discovery is the default.
//
// When you create an IPAM, a default resource discovery is created for your IPAM and it's associated with your IPAM.
AttrIsDefault() awscdk.IResolvable
// The owner ID.
AttrOwnerId() *string
// The resource discovery status.
//
// - `active` - Connection or permissions required to read the results of the resource discovery are intact.
// - `not-found` - Connection or permissions required to read the results of the resource discovery are broken. This may happen if the owner of the resource discovery stopped sharing it or deleted the resource discovery. Verify the resource discovery still exists and the AWS RAM resource share is still intact.
AttrResourceDiscoveryStatus() *string
// The lifecycle state of the association when you associate or disassociate a resource discovery.
//
// - `associate-in-progress` - Resource discovery is being associated.
// - `associate-complete` - Resource discovery association is complete.
// - `associate-failed` - Resource discovery association has failed.
// - `disassociate-in-progress` - Resource discovery is being disassociated.
// - `disassociate-complete` - Resource discovery disassociation is complete.
// - `disassociate-failed` - Resource discovery disassociation has failed.
// - `isolate-in-progress` - AWS account that created the resource discovery association has been removed and the resource discovery associatation is being isolated.
// - `isolate-complete` - Resource discovery isolation is complete..
// - `restore-in-progress` - Resource discovery is being restored.
AttrState() *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 IPAM ID.
IpamId() *string
SetIpamId(val *string)
// The resource discovery ID.
IpamResourceDiscoveryId() *string
SetIpamResourceDiscoveryId(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
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
// A tag is a label that you assign to an AWS 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{})
}
An IPAM resource discovery association.
An associated resource discovery is a resource discovery that has been associated with an IPAM. IPAM aggregates the resource CIDRs discovered by the associated resource discovery.
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"
cfnIPAMResourceDiscoveryAssociation := awscdk.Aws_ec2.NewCfnIPAMResourceDiscoveryAssociation(this, jsii.String("MyCfnIPAMResourceDiscoveryAssociation"), &CfnIPAMResourceDiscoveryAssociationProps{
IpamId: jsii.String("ipamId"),
IpamResourceDiscoveryId: jsii.String("ipamResourceDiscoveryId"),
// the properties below are optional
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
func NewCfnIPAMResourceDiscoveryAssociation ¶ added in v2.64.0
func NewCfnIPAMResourceDiscoveryAssociation(scope constructs.Construct, id *string, props *CfnIPAMResourceDiscoveryAssociationProps) CfnIPAMResourceDiscoveryAssociation
type CfnIPAMResourceDiscoveryAssociationProps ¶ added in v2.64.0
type CfnIPAMResourceDiscoveryAssociationProps struct {
// The IPAM ID.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamresourcediscoveryassociation.html#cfn-ec2-ipamresourcediscoveryassociation-ipamid
//
IpamId *string `field:"required" json:"ipamId" yaml:"ipamId"`
// The resource discovery ID.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamresourcediscoveryassociation.html#cfn-ec2-ipamresourcediscoveryassociation-ipamresourcediscoveryid
//
IpamResourceDiscoveryId *string `field:"required" json:"ipamResourceDiscoveryId" yaml:"ipamResourceDiscoveryId"`
// A tag is a label that you assign to an AWS resource.
//
// Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your AWS costs.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamresourcediscoveryassociation.html#cfn-ec2-ipamresourcediscoveryassociation-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnIPAMResourceDiscoveryAssociation`.
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"
cfnIPAMResourceDiscoveryAssociationProps := &CfnIPAMResourceDiscoveryAssociationProps{
IpamId: jsii.String("ipamId"),
IpamResourceDiscoveryId: jsii.String("ipamResourceDiscoveryId"),
// the properties below are optional
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
type CfnIPAMResourceDiscoveryProps ¶ added in v2.64.0
type CfnIPAMResourceDiscoveryProps struct {
// The resource discovery description.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamresourcediscovery.html#cfn-ec2-ipamresourcediscovery-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// The operating Regions for the resource discovery.
//
// Operating Regions are AWS Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the AWS Regions you select as operating Regions.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamresourcediscovery.html#cfn-ec2-ipamresourcediscovery-operatingregions
//
OperatingRegions interface{} `field:"optional" json:"operatingRegions" yaml:"operatingRegions"`
// A tag is a label that you assign to an AWS resource.
//
// Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your AWS costs.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamresourcediscovery.html#cfn-ec2-ipamresourcediscovery-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnIPAMResourceDiscovery`.
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"
cfnIPAMResourceDiscoveryProps := &CfnIPAMResourceDiscoveryProps{
Description: jsii.String("description"),
OperatingRegions: []interface{}{
&IpamOperatingRegionProperty{
RegionName: jsii.String("regionName"),
},
},
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
type CfnIPAMResourceDiscovery_IpamOperatingRegionProperty ¶ added in v2.64.0
type CfnIPAMResourceDiscovery_IpamOperatingRegionProperty struct {
// The name of the operating Region.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ipamresourcediscovery-ipamoperatingregion.html#cfn-ec2-ipamresourcediscovery-ipamoperatingregion-regionname
//
RegionName *string `field:"required" json:"regionName" yaml:"regionName"`
}
The operating Regions for an IPAM.
Operating Regions are AWS Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the AWS Regions you select as operating Regions.
For more information about operating Regions, see [Create an IPAM](https://docs.aws.amazon.com//vpc/latest/ipam/create-ipam.html) in the *Amazon VPC IPAM User 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"
ipamOperatingRegionProperty := &IpamOperatingRegionProperty{
RegionName: jsii.String("regionName"),
}
type CfnIPAMScope ¶ added in v2.2.0
type CfnIPAMScope interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggable
// The ARN of the scope.
AttrArn() *string
// The ARN of an IPAM.
AttrIpamArn() *string
// The ID of an IPAM scope.
AttrIpamScopeId() *string
// The type of the scope.
AttrIpamScopeType() *string
// Defines if the scope is the default scope or not.
AttrIsDefault() awscdk.IResolvable
// The number of pools in a scope.
AttrPoolCount() *float64
// 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 description of the scope.
Description() *string
SetDescription(val *string)
// The ID of the IPAM for which you're creating this scope.
IpamId() *string
SetIpamId(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
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
// The key/value combination of a tag assigned to the 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{})
}
In IPAM, a scope is the highest-level container within IPAM.
An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.
For more information, see [How IPAM works](https://docs.aws.amazon.com//vpc/latest/ipam/how-it-works-ipam.html) in the *Amazon VPC IPAM User 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"
cfnIPAMScope := awscdk.Aws_ec2.NewCfnIPAMScope(this, jsii.String("MyCfnIPAMScope"), &CfnIPAMScopeProps{
IpamId: jsii.String("ipamId"),
// the properties below are optional
Description: jsii.String("description"),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamscope.html
func NewCfnIPAMScope ¶ added in v2.2.0
func NewCfnIPAMScope(scope constructs.Construct, id *string, props *CfnIPAMScopeProps) CfnIPAMScope
type CfnIPAMScopeProps ¶ added in v2.2.0
type CfnIPAMScopeProps struct {
// The ID of the IPAM for which you're creating this scope.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamscope.html#cfn-ec2-ipamscope-ipamid
//
IpamId *string `field:"required" json:"ipamId" yaml:"ipamId"`
// The description of the scope.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamscope.html#cfn-ec2-ipamscope-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// The key/value combination of a tag assigned to the resource.
//
// Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA` , specify `tag:Owner` for the filter name and `TeamA` for the filter value.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamscope.html#cfn-ec2-ipamscope-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnIPAMScope`.
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"
cfnIPAMScopeProps := &CfnIPAMScopeProps{
IpamId: jsii.String("ipamId"),
// the properties below are optional
Description: jsii.String("description"),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamscope.html
type CfnIPAM_IpamOperatingRegionProperty ¶ added in v2.2.0
type CfnIPAM_IpamOperatingRegionProperty struct {
// The name of the operating Region.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ipam-ipamoperatingregion.html#cfn-ec2-ipam-ipamoperatingregion-regionname
//
RegionName *string `field:"required" json:"regionName" yaml:"regionName"`
}
The operating Regions for an IPAM.
Operating Regions are AWS Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the AWS Regions you select as operating Regions.
For more information about operating Regions, see [Create an IPAM](https://docs.aws.amazon.com//vpc/latest/ipam/create-ipam.html) in the *Amazon VPC IPAM User 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"
ipamOperatingRegionProperty := &IpamOperatingRegionProperty{
RegionName: jsii.String("regionName"),
}
type CfnInstance ¶
type CfnInstance interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggable
// This property is reserved for internal use.
AdditionalInfo() *string
SetAdditionalInfo(val *string)
// Indicates whether the instance is associated with a dedicated host.
Affinity() *string
SetAffinity(val *string)
AttrAvailabilityZone() *string
// The ID of the instance.
AttrInstanceId() *string
// The private DNS name of the specified instance.
//
// For example: `ip-10-24-34-0.ec2.internal` .
AttrPrivateDnsName() *string
// The private IP address of the specified instance.
//
// For example: `10.24.34.0` .
AttrPrivateIp() *string
// The public DNS name of the specified instance.
//
// For example: `ec2-107-20-50-45.compute-1.amazonaws.com` .
AttrPublicDnsName() *string
// The public IP address of the specified instance.
//
// For example: `192.0.2.0` .
AttrPublicIp() *string
// The current state of the instance.
AttrState() awscdk.IResolvable
// The ID of the VPC in which the instance is running.
AttrVpcId() *string
// The Availability Zone of the instance.
AvailabilityZone() *string
SetAvailabilityZone(val *string)
// The block device mapping entries that defines the block devices to attach to the instance at launch.
BlockDeviceMappings() interface{}
SetBlockDeviceMappings(val interface{})
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// The CPU options for the instance.
CpuOptions() interface{}
SetCpuOptions(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
// The credit option for CPU usage of the burstable performance instance.
CreditSpecification() interface{}
SetCreditSpecification(val interface{})
// If you set this parameter to `true` , you can't terminate the instance using the Amazon EC2 console, CLI, or API;.
DisableApiTermination() interface{}
SetDisableApiTermination(val interface{})
// Indicates whether the instance is optimized for Amazon EBS I/O.
EbsOptimized() interface{}
SetEbsOptimized(val interface{})
// An elastic GPU to associate with the instance.
ElasticGpuSpecifications() interface{}
SetElasticGpuSpecifications(val interface{})
// An elastic inference accelerator to associate with the instance.
ElasticInferenceAccelerators() interface{}
SetElasticInferenceAccelerators(val interface{})
// Indicates whether the instance is enabled for AWS Nitro Enclaves.
EnclaveOptions() interface{}
SetEnclaveOptions(val interface{})
// Indicates whether an instance is enabled for hibernation.
HibernationOptions() interface{}
SetHibernationOptions(val interface{})
// If you specify host for the `Affinity` property, the ID of a dedicated host that the instance is associated with.
HostId() *string
SetHostId(val *string)
// The ARN of the host resource group in which to launch the instances.
HostResourceGroupArn() *string
SetHostResourceGroupArn(val *string)
// The name of an IAM instance profile.
IamInstanceProfile() *string
SetIamInstanceProfile(val *string)
// The ID of the AMI.
ImageId() *string
SetImageId(val *string)
// Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
InstanceInitiatedShutdownBehavior() *string
SetInstanceInitiatedShutdownBehavior(val *string)
// The instance type.
//
// For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide* .
InstanceType() *string
SetInstanceType(val *string)
// The number of IPv6 addresses to associate with the primary network interface.
Ipv6AddressCount() *float64
SetIpv6AddressCount(val *float64)
// The IPv6 addresses from the range of the subnet to associate with the primary network interface.
Ipv6Addresses() interface{}
SetIpv6Addresses(val interface{})
// The ID of the kernel.
KernelId() *string
SetKernelId(val *string)
// The name of the key pair.
//
// You can create a key pair using [CreateKeyPair](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateKeyPair.html) or [ImportKeyPair](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportKeyPair.html) .
KeyName() *string
SetKeyName(val *string)
// The launch template.
LaunchTemplate() interface{}
SetLaunchTemplate(val interface{})
// The license configurations.
LicenseSpecifications() interface{}
SetLicenseSpecifications(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
// Specifies whether detailed monitoring is enabled for the instance.
Monitoring() interface{}
SetMonitoring(val interface{})
// The network interfaces to associate with the instance.
NetworkInterfaces() interface{}
SetNetworkInterfaces(val interface{})
// The tree node.
Node() constructs.Node
// The name of an existing placement group that you want to launch the instance into (cluster | partition | spread).
PlacementGroupName() *string
SetPlacementGroupName(val *string)
// The options for the instance hostname.
PrivateDnsNameOptions() interface{}
SetPrivateDnsNameOptions(val interface{})
// The primary IPv4 address.
//
// You must specify a value from the IPv4 address range of the subnet.
PrivateIpAddress() *string
SetPrivateIpAddress(val *string)
// Indicates whether to assign the tags from the instance to all of the volumes attached to the instance at launch.
PropagateTagsToVolumeOnCreation() interface{}
SetPropagateTagsToVolumeOnCreation(val interface{})
// The ID of the RAM disk to select.
RamdiskId() *string
SetRamdiskId(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 IDs of the security groups.
SecurityGroupIds() *[]*string
SetSecurityGroupIds(val *[]*string)
// [Default VPC] The names of the security groups.
//
// For a nondefault VPC, you must use security group IDs instead.
SecurityGroups() *[]*string
SetSecurityGroups(val *[]*string)
// Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives.
SourceDestCheck() interface{}
SetSourceDestCheck(val interface{})
// The SSM [document](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html) and parameter values in AWS Systems Manager to associate with this instance. To use this property, you must specify an IAM instance profile role for the instance. For more information, see [Create an IAM instance profile for Systems Manager](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-configuring-access-role.html) in the *AWS Systems Manager User Guide* .
SsmAssociations() interface{}
SetSsmAssociations(val interface{})
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// The ID of the subnet to launch the instance into.
SubnetId() *string
SetSubnetId(val *string)
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
// The tags to add to the instance.
TagsRaw() *[]*awscdk.CfnTag
SetTagsRaw(val *[]*awscdk.CfnTag)
// The tenancy of the instance.
Tenancy() *string
SetTenancy(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{}
// The parameters or scripts to store as user data.
UserData() *string
SetUserData(val *string)
// The volumes to attach to the instance.
Volumes() interface{}
SetVolumes(val 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{})
}
Specifies an EC2 instance.
If an Elastic IP address is attached to your instance, AWS CloudFormation reattaches the Elastic IP address after it updates the instance. For more information about updating stacks, see [AWS CloudFormation Stacks Updates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.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"
cfnInstance := awscdk.Aws_ec2.NewCfnInstance(this, jsii.String("MyCfnInstance"), &CfnInstanceProps{
AdditionalInfo: jsii.String("additionalInfo"),
Affinity: jsii.String("affinity"),
AvailabilityZone: jsii.String("availabilityZone"),
BlockDeviceMappings: []interface{}{
&BlockDeviceMappingProperty{
DeviceName: jsii.String("deviceName"),
// the properties below are optional
Ebs: &EbsProperty{
DeleteOnTermination: jsii.Boolean(false),
Encrypted: jsii.Boolean(false),
Iops: jsii.Number(123),
KmsKeyId: jsii.String("kmsKeyId"),
SnapshotId: jsii.String("snapshotId"),
VolumeSize: jsii.Number(123),
VolumeType: jsii.String("volumeType"),
},
NoDevice: &NoDeviceProperty{
},
VirtualName: jsii.String("virtualName"),
},
},
CpuOptions: &CpuOptionsProperty{
CoreCount: jsii.Number(123),
ThreadsPerCore: jsii.Number(123),
},
CreditSpecification: &CreditSpecificationProperty{
CpuCredits: jsii.String("cpuCredits"),
},
DisableApiTermination: jsii.Boolean(false),
EbsOptimized: jsii.Boolean(false),
ElasticGpuSpecifications: []interface{}{
&ElasticGpuSpecificationProperty{
Type: jsii.String("type"),
},
},
ElasticInferenceAccelerators: []interface{}{
&ElasticInferenceAcceleratorProperty{
Type: jsii.String("type"),
// the properties below are optional
Count: jsii.Number(123),
},
},
EnclaveOptions: &EnclaveOptionsProperty{
Enabled: jsii.Boolean(false),
},
HibernationOptions: &HibernationOptionsProperty{
Configured: jsii.Boolean(false),
},
HostId: jsii.String("hostId"),
HostResourceGroupArn: jsii.String("hostResourceGroupArn"),
IamInstanceProfile: jsii.String("iamInstanceProfile"),
ImageId: jsii.String("imageId"),
InstanceInitiatedShutdownBehavior: jsii.String("instanceInitiatedShutdownBehavior"),
InstanceType: jsii.String("instanceType"),
Ipv6AddressCount: jsii.Number(123),
Ipv6Addresses: []interface{}{
&InstanceIpv6AddressProperty{
Ipv6Address: jsii.String("ipv6Address"),
},
},
KernelId: jsii.String("kernelId"),
KeyName: jsii.String("keyName"),
LaunchTemplate: &LaunchTemplateSpecificationProperty{
Version: jsii.String("version"),
// the properties below are optional
LaunchTemplateId: jsii.String("launchTemplateId"),
LaunchTemplateName: jsii.String("launchTemplateName"),
},
LicenseSpecifications: []interface{}{
&LicenseSpecificationProperty{
LicenseConfigurationArn: jsii.String("licenseConfigurationArn"),
},
},
Monitoring: jsii.Boolean(false),
NetworkInterfaces: []interface{}{
&NetworkInterfaceProperty{
DeviceIndex: jsii.String("deviceIndex"),
// the properties below are optional
AssociateCarrierIpAddress: jsii.Boolean(false),
AssociatePublicIpAddress: jsii.Boolean(false),
DeleteOnTermination: jsii.Boolean(false),
Description: jsii.String("description"),
GroupSet: []*string{
jsii.String("groupSet"),
},
Ipv6AddressCount: jsii.Number(123),
Ipv6Addresses: []interface{}{
&InstanceIpv6AddressProperty{
Ipv6Address: jsii.String("ipv6Address"),
},
},
NetworkInterfaceId: jsii.String("networkInterfaceId"),
PrivateIpAddress: jsii.String("privateIpAddress"),
PrivateIpAddresses: []interface{}{
&PrivateIpAddressSpecificationProperty{
Primary: jsii.Boolean(false),
PrivateIpAddress: jsii.String("privateIpAddress"),
},
},
SecondaryPrivateIpAddressCount: jsii.Number(123),
SubnetId: jsii.String("subnetId"),
},
},
PlacementGroupName: jsii.String("placementGroupName"),
PrivateDnsNameOptions: &PrivateDnsNameOptionsProperty{
EnableResourceNameDnsAaaaRecord: jsii.Boolean(false),
EnableResourceNameDnsARecord: jsii.Boolean(false),
HostnameType: jsii.String("hostnameType"),
},
PrivateIpAddress: jsii.String("privateIpAddress"),
PropagateTagsToVolumeOnCreation: jsii.Boolean(false),
RamdiskId: jsii.String("ramdiskId"),
SecurityGroupIds: []*string{
jsii.String("securityGroupIds"),
},
SecurityGroups: []*string{
jsii.String("securityGroups"),
},
SourceDestCheck: jsii.Boolean(false),
SsmAssociations: []interface{}{
&SsmAssociationProperty{
DocumentName: jsii.String("documentName"),
// the properties below are optional
AssociationParameters: []interface{}{
&AssociationParameterProperty{
Key: jsii.String("key"),
Value: []*string{
jsii.String("value"),
},
},
},
},
},
SubnetId: jsii.String("subnetId"),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
Tenancy: jsii.String("tenancy"),
UserData: jsii.String("userData"),
Volumes: []interface{}{
&VolumeProperty{
Device: jsii.String("device"),
VolumeId: jsii.String("volumeId"),
},
},
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html
func NewCfnInstance ¶
func NewCfnInstance(scope constructs.Construct, id *string, props *CfnInstanceProps) CfnInstance
type CfnInstanceConnectEndpoint ¶ added in v2.97.0
type CfnInstanceConnectEndpoint interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggableV2
// The ID of the EC2 Instance Connect Endpoint.
AttrId() *string
// Tag Manager which manages the tags for this resource.
CdkTagManager() awscdk.TagManager
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
ClientToken() *string
SetClientToken(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 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 the client IP address is preserved as the source.
//
// The following are the possible values.
PreserveClientIp() interface{}
SetPreserveClientIp(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
// One or more security groups to associate with the endpoint.
SecurityGroupIds() *[]*string
SetSecurityGroupIds(val *[]*string)
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// The ID of the subnet in which to create the EC2 Instance Connect Endpoint.
SubnetId() *string
SetSubnetId(val *string)
// The tags to apply to the EC2 Instance Connect Endpoint during creation.
Tags() *[]*awscdk.CfnTag
SetTags(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{})
}
Creates an EC2 Instance Connect Endpoint.
An EC2 Instance Connect Endpoint allows you to connect to an instance, without requiring the instance to have a public IPv4 address. For more information, see [Connect to your instances without requiring a public IPv4 address using EC2 Instance Connect Endpoint](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Connect-using-EC2-Instance-Connect-Endpoint.html) in the *Amazon EC2 User 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"
cfnInstanceConnectEndpoint := awscdk.Aws_ec2.NewCfnInstanceConnectEndpoint(this, jsii.String("MyCfnInstanceConnectEndpoint"), &CfnInstanceConnectEndpointProps{
SubnetId: jsii.String("subnetId"),
// the properties below are optional
ClientToken: jsii.String("clientToken"),
PreserveClientIp: jsii.Boolean(false),
SecurityGroupIds: []*string{
jsii.String("securityGroupIds"),
},
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
func NewCfnInstanceConnectEndpoint ¶ added in v2.97.0
func NewCfnInstanceConnectEndpoint(scope constructs.Construct, id *string, props *CfnInstanceConnectEndpointProps) CfnInstanceConnectEndpoint
type CfnInstanceConnectEndpointProps ¶ added in v2.97.0
type CfnInstanceConnectEndpointProps struct {
// The ID of the subnet in which to create the EC2 Instance Connect Endpoint.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instanceconnectendpoint.html#cfn-ec2-instanceconnectendpoint-subnetid
//
SubnetId *string `field:"required" json:"subnetId" yaml:"subnetId"`
// Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instanceconnectendpoint.html#cfn-ec2-instanceconnectendpoint-clienttoken
//
ClientToken *string `field:"optional" json:"clientToken" yaml:"clientToken"`
// Indicates whether the client IP address is preserved as the source. The following are the possible values.
//
// - `true` - Use the client IP address as the source.
// - `false` - Use the network interface IP address as the source.
//
// Default: `false`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instanceconnectendpoint.html#cfn-ec2-instanceconnectendpoint-preserveclientip
//
PreserveClientIp interface{} `field:"optional" json:"preserveClientIp" yaml:"preserveClientIp"`
// One or more security groups to associate with the endpoint.
//
// If you don't specify a security group, the default security group for your VPC will be associated with the endpoint.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instanceconnectendpoint.html#cfn-ec2-instanceconnectendpoint-securitygroupids
//
SecurityGroupIds *[]*string `field:"optional" json:"securityGroupIds" yaml:"securityGroupIds"`
// The tags to apply to the EC2 Instance Connect Endpoint during creation.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instanceconnectendpoint.html#cfn-ec2-instanceconnectendpoint-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnInstanceConnectEndpoint`.
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"
cfnInstanceConnectEndpointProps := &CfnInstanceConnectEndpointProps{
SubnetId: jsii.String("subnetId"),
// the properties below are optional
ClientToken: jsii.String("clientToken"),
PreserveClientIp: jsii.Boolean(false),
SecurityGroupIds: []*string{
jsii.String("securityGroupIds"),
},
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
type CfnInstanceProps ¶
type CfnInstanceProps struct {
// This property is reserved for internal use.
//
// If you use it, the stack fails with this error: `Bad property set: [Testing this property] (Service: AmazonEC2; Status Code: 400; Error Code: InvalidParameterCombination; Request ID: 0XXXXXX-49c7-4b40-8bcc-76885dcXXXXX)` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-additionalinfo
//
AdditionalInfo *string `field:"optional" json:"additionalInfo" yaml:"additionalInfo"`
// Indicates whether the instance is associated with a dedicated host.
//
// If you want the instance to always restart on the same host on which it was launched, specify `host` . If you want the instance to restart on any available host, but try to launch onto the last host it ran on (on a best-effort basis), specify `default` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-affinity
//
Affinity *string `field:"optional" json:"affinity" yaml:"affinity"`
// The Availability Zone of the instance.
//
// If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region.
//
// This parameter is not supported by [DescribeImageAttribute](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeImageAttribute.html) .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-availabilityzone
//
AvailabilityZone *string `field:"optional" json:"availabilityZone" yaml:"availabilityZone"`
// The block device mapping entries that defines the block devices to attach to the instance at launch.
//
// By default, the block devices specified in the block device mapping for the AMI are used. You can override the AMI block device mapping using the instance block device mapping. For the root volume, you can override only the volume size, volume type, volume encryption settings, and the `DeleteOnTermination` setting.
//
// > After the instance is running, you can modify only the `DeleteOnTermination` parameter for the attached volumes without interrupting the instance. Modifying any other parameter results in instance [replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-blockdevicemappings
//
BlockDeviceMappings interface{} `field:"optional" json:"blockDeviceMappings" yaml:"blockDeviceMappings"`
// The CPU options for the instance.
//
// For more information, see [Optimize CPU options](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html) in the *Amazon Elastic Compute Cloud User Guide* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-cpuoptions
//
CpuOptions interface{} `field:"optional" json:"cpuOptions" yaml:"cpuOptions"`
// The credit option for CPU usage of the burstable performance instance.
//
// Valid values are `standard` and `unlimited` . To change this attribute after launch, use [ModifyInstanceCreditSpecification](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyInstanceCreditSpecification.html) . For more information, see [Burstable performance instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html) in the *Amazon EC2 User Guide* .
//
// Default: `standard` (T2 instances) or `unlimited` (T3/T3a/T4g instances)
//
// For T3 instances with `host` tenancy, only `standard` is supported.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-creditspecification
//
CreditSpecification interface{} `field:"optional" json:"creditSpecification" yaml:"creditSpecification"`
// If you set this parameter to `true` , you can't terminate the instance using the Amazon EC2 console, CLI, or API;
//
// otherwise, you can. To change this attribute after launch, use [ModifyInstanceAttribute](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyInstanceAttribute.html) . Alternatively, if you set `InstanceInitiatedShutdownBehavior` to `terminate` , you can terminate the instance by running the shutdown command from the instance.
//
// Default: `false`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-disableapitermination
//
DisableApiTermination interface{} `field:"optional" json:"disableApiTermination" yaml:"disableApiTermination"`
// Indicates whether the instance is optimized for Amazon EBS I/O.
//
// This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.
//
// Default: `false`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-ebsoptimized
//
EbsOptimized interface{} `field:"optional" json:"ebsOptimized" yaml:"ebsOptimized"`
// An elastic GPU to associate with the instance.
//
// > Amazon Elastic Graphics reached end of life on January 8, 2024.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-elasticgpuspecifications
//
ElasticGpuSpecifications interface{} `field:"optional" json:"elasticGpuSpecifications" yaml:"elasticGpuSpecifications"`
// An elastic inference accelerator to associate with the instance.
//
// > Amazon Elastic Inference (EI) is no longer available to new customers. For more information, see [Amazon Elastic Inference FAQs](https://docs.aws.amazon.com/machine-learning/elastic-inference/faqs/) .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-elasticinferenceaccelerators
//
ElasticInferenceAccelerators interface{} `field:"optional" json:"elasticInferenceAccelerators" yaml:"elasticInferenceAccelerators"`
// Indicates whether the instance is enabled for AWS Nitro Enclaves.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-enclaveoptions
//
EnclaveOptions interface{} `field:"optional" json:"enclaveOptions" yaml:"enclaveOptions"`
// Indicates whether an instance is enabled for hibernation.
//
// This parameter is valid only if the instance meets the [hibernation prerequisites](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/hibernating-prerequisites.html) . For more information, see [Hibernate your Amazon EC2 instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html) in the *Amazon EC2 User Guide* .
//
// You can't enable hibernation and AWS Nitro Enclaves on the same instance.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-hibernationoptions
//
HibernationOptions interface{} `field:"optional" json:"hibernationOptions" yaml:"hibernationOptions"`
// If you specify host for the `Affinity` property, the ID of a dedicated host that the instance is associated with.
//
// If you don't specify an ID, Amazon EC2 launches the instance onto any available, compatible dedicated host in your account. This type of launch is called an untargeted launch. Note that for untargeted launches, you must have a compatible, dedicated host available to successfully launch instances.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-hostid
//
HostId *string `field:"optional" json:"hostId" yaml:"hostId"`
// The ARN of the host resource group in which to launch the instances.
//
// If you specify a host resource group ARN, omit the *Tenancy* parameter or set it to `host` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-hostresourcegrouparn
//
HostResourceGroupArn *string `field:"optional" json:"hostResourceGroupArn" yaml:"hostResourceGroupArn"`
// The name of an IAM instance profile.
//
// To create a new IAM instance profile, use the [AWS::IAM::InstanceProfile](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html) resource.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-iaminstanceprofile
//
IamInstanceProfile *string `field:"optional" json:"iamInstanceProfile" yaml:"iamInstanceProfile"`
// The ID of the AMI.
//
// An AMI ID is required to launch an instance and must be specified here or in a launch template.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-imageid
//
ImageId *string `field:"optional" json:"imageId" yaml:"imageId"`
// Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
//
// Default: `stop`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-instanceinitiatedshutdownbehavior
//
InstanceInitiatedShutdownBehavior *string `field:"optional" json:"instanceInitiatedShutdownBehavior" yaml:"instanceInitiatedShutdownBehavior"`
// The instance type. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide* .
//
// When you change your EBS-backed instance type, instance restart or replacement behavior depends on the instance type compatibility between the old and new types. An instance with an instance store volume as the root volume is always replaced. For more information, see [Change the instance type](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-resize.html) in the *Amazon EC2 User Guide* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-instancetype
//
InstanceType *string `field:"optional" json:"instanceType" yaml:"instanceType"`
// The number of IPv6 addresses to associate with the primary network interface.
//
// Amazon EC2 chooses the IPv6 addresses from the range of your subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch.
//
// You cannot specify this option and the network interfaces option in the same request.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-ipv6addresscount
//
Ipv6AddressCount *float64 `field:"optional" json:"ipv6AddressCount" yaml:"ipv6AddressCount"`
// The IPv6 addresses from the range of the subnet to associate with the primary network interface.
//
// You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch.
//
// You cannot specify this option and the network interfaces option in the same request.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-ipv6addresses
//
Ipv6Addresses interface{} `field:"optional" json:"ipv6Addresses" yaml:"ipv6Addresses"`
// The ID of the kernel.
//
// > We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see [PV-GRUB](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html) in the *Amazon EC2 User Guide* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-kernelid
//
KernelId *string `field:"optional" json:"kernelId" yaml:"kernelId"`
// The name of the key pair. You can create a key pair using [CreateKeyPair](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateKeyPair.html) or [ImportKeyPair](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportKeyPair.html) .
//
// > If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-keyname
//
KeyName *string `field:"optional" json:"keyName" yaml:"keyName"`
// The launch template.
//
// Any additional parameters that you specify for the new instance overwrite the corresponding parameters included in the launch template.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-launchtemplate
//
LaunchTemplate interface{} `field:"optional" json:"launchTemplate" yaml:"launchTemplate"`
// The license configurations.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-licensespecifications
//
LicenseSpecifications interface{} `field:"optional" json:"licenseSpecifications" yaml:"licenseSpecifications"`
// Specifies whether detailed monitoring is enabled for the instance.
//
// Specify `true` to enable detailed monitoring. Otherwise, basic monitoring is enabled. For more information about detailed monitoring, see [Enable or turn off detailed monitoring for your instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-cloudwatch-new.html) in the *Amazon EC2 User Guide* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-monitoring
//
Monitoring interface{} `field:"optional" json:"monitoring" yaml:"monitoring"`
// The network interfaces to associate with the instance.
//
// > If you use this property to point to a network interface, you must terminate the original interface before attaching a new one to allow the update of the instance to succeed.
// >
// > If this resource has a public IP address and is also in a VPC that is defined in the same template, you must use the [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) to declare a dependency on the VPC-gateway attachment.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-networkinterfaces
//
NetworkInterfaces interface{} `field:"optional" json:"networkInterfaces" yaml:"networkInterfaces"`
// The name of an existing placement group that you want to launch the instance into (cluster | partition | spread).
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-placementgroupname
//
PlacementGroupName *string `field:"optional" json:"placementGroupName" yaml:"placementGroupName"`
// The options for the instance hostname.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-privatednsnameoptions
//
PrivateDnsNameOptions interface{} `field:"optional" json:"privateDnsNameOptions" yaml:"privateDnsNameOptions"`
// The primary IPv4 address. You must specify a value from the IPv4 address range of the subnet.
//
// Only one private IP address can be designated as primary. You can't specify this option if you've specified the option to designate a private IP address as the primary IP address in a network interface specification. You cannot specify this option if you're launching more than one instance in the request.
//
// You cannot specify this option and the network interfaces option in the same request.
//
// If you make an update to an instance that requires replacement, you must assign a new private IP address. During a replacement, AWS CloudFormation creates a new instance but doesn't delete the old instance until the stack has successfully updated. If the stack update fails, AWS CloudFormation uses the old instance to roll back the stack to the previous working state. The old and new instances cannot have the same private IP address.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-privateipaddress
//
PrivateIpAddress *string `field:"optional" json:"privateIpAddress" yaml:"privateIpAddress"`
// Indicates whether to assign the tags from the instance to all of the volumes attached to the instance at launch.
//
// If you specify `true` and you assign tags to the instance, those tags are automatically assigned to all of the volumes that you attach to the instance at launch. If you specify `false` , those tags are not assigned to the attached volumes.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-propagatetagstovolumeoncreation
//
PropagateTagsToVolumeOnCreation interface{} `field:"optional" json:"propagateTagsToVolumeOnCreation" yaml:"propagateTagsToVolumeOnCreation"`
// The ID of the RAM disk to select.
//
// Some kernels require additional drivers at launch. Check the kernel requirements for information about whether you need to specify a RAM disk. To find kernel requirements, go to the AWS Resource Center and search for the kernel ID.
//
// > We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see [PV-GRUB](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html) in the *Amazon EC2 User Guide* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-ramdiskid
//
RamdiskId *string `field:"optional" json:"ramdiskId" yaml:"ramdiskId"`
// The IDs of the security groups.
//
// You can specify the IDs of existing security groups and references to resources created by the stack template.
//
// If you specify a network interface, you must specify any security groups as part of the network interface.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-securitygroupids
//
SecurityGroupIds *[]*string `field:"optional" json:"securityGroupIds" yaml:"securityGroupIds"`
// [Default VPC] The names of the security groups. For a nondefault VPC, you must use security group IDs instead.
//
// You cannot specify this option and the network interfaces option in the same request. The list can contain both the name of existing Amazon EC2 security groups or references to AWS::EC2::SecurityGroup resources created in the template.
//
// Default: Amazon EC2 uses the default security group.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-securitygroups
//
SecurityGroups *[]*string `field:"optional" json:"securityGroups" yaml:"securityGroups"`
// Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives.
//
// If the value is `true` , source/destination checks are enabled; otherwise, they are disabled. The default value is `true` . You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-sourcedestcheck
//
SourceDestCheck interface{} `field:"optional" json:"sourceDestCheck" yaml:"sourceDestCheck"`
// The SSM [document](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html) and parameter values in AWS Systems Manager to associate with this instance. To use this property, you must specify an IAM instance profile role for the instance. For more information, see [Create an IAM instance profile for Systems Manager](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-configuring-access-role.html) in the *AWS Systems Manager User Guide* .
//
// > You can associate only one document with an instance.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-ssmassociations
//
SsmAssociations interface{} `field:"optional" json:"ssmAssociations" yaml:"ssmAssociations"`
// The ID of the subnet to launch the instance into.
//
// If you specify a network interface, you must specify any subnets as part of the network interface instead of using this parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-subnetid
//
SubnetId *string `field:"optional" json:"subnetId" yaml:"subnetId"`
// The tags to add to the instance.
//
// These tags are not applied to the EBS volumes, such as the root volume, unless [PropagateTagsToVolumeOnCreation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-propagatetagstovolumeoncreation) is `true` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
// The tenancy of the instance.
//
// An instance with a tenancy of `dedicated` runs on single-tenant hardware.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-tenancy
//
Tenancy *string `field:"optional" json:"tenancy" yaml:"tenancy"`
// The parameters or scripts to store as user data.
//
// Any scripts in user data are run when you launch the instance. User data is limited to 16 KB. You must provide base64-encoded text. For more information, see [Fn::Base64](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-base64.html) .
//
// If the root volume is an EBS volume and you update user data, CloudFormation restarts the instance. If the root volume is an instance store volume and you update user data, the instance is replaced.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-userdata
//
UserData *string `field:"optional" json:"userData" yaml:"userData"`
// The volumes to attach to the instance.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-volumes
//
Volumes interface{} `field:"optional" json:"volumes" yaml:"volumes"`
}
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{
AdditionalInfo: jsii.String("additionalInfo"),
Affinity: jsii.String("affinity"),
AvailabilityZone: jsii.String("availabilityZone"),
BlockDeviceMappings: []interface{}{
&BlockDeviceMappingProperty{
DeviceName: jsii.String("deviceName"),
// the properties below are optional
Ebs: &EbsProperty{
DeleteOnTermination: jsii.Boolean(false),
Encrypted: jsii.Boolean(false),
Iops: jsii.Number(123),
KmsKeyId: jsii.String("kmsKeyId"),
SnapshotId: jsii.String("snapshotId"),
VolumeSize: jsii.Number(123),
VolumeType: jsii.String("volumeType"),
},
NoDevice: &NoDeviceProperty{
},
VirtualName: jsii.String("virtualName"),
},
},
CpuOptions: &CpuOptionsProperty{
CoreCount: jsii.Number(123),
ThreadsPerCore: jsii.Number(123),
},
CreditSpecification: &CreditSpecificationProperty{
CpuCredits: jsii.String("cpuCredits"),
},
DisableApiTermination: jsii.Boolean(false),
EbsOptimized: jsii.Boolean(false),
ElasticGpuSpecifications: []interface{}{
&ElasticGpuSpecificationProperty{
Type: jsii.String("type"),
},
},
ElasticInferenceAccelerators: []interface{}{
&ElasticInferenceAcceleratorProperty{
Type: jsii.String("type"),
// the properties below are optional
Count: jsii.Number(123),
},
},
EnclaveOptions: &EnclaveOptionsProperty{
Enabled: jsii.Boolean(false),
},
HibernationOptions: &HibernationOptionsProperty{
Configured: jsii.Boolean(false),
},
HostId: jsii.String("hostId"),
HostResourceGroupArn: jsii.String("hostResourceGroupArn"),
IamInstanceProfile: jsii.String("iamInstanceProfile"),
ImageId: jsii.String("imageId"),
InstanceInitiatedShutdownBehavior: jsii.String("instanceInitiatedShutdownBehavior"),
InstanceType: jsii.String("instanceType"),
Ipv6AddressCount: jsii.Number(123),
Ipv6Addresses: []interface{}{
&InstanceIpv6AddressProperty{
Ipv6Address: jsii.String("ipv6Address"),
},
},
KernelId: jsii.String("kernelId"),
KeyName: jsii.String("keyName"),
LaunchTemplate: &LaunchTemplateSpecificationProperty{
Version: jsii.String("version"),
// the properties below are optional
LaunchTemplateId: jsii.String("launchTemplateId"),
LaunchTemplateName: jsii.String("launchTemplateName"),
},
LicenseSpecifications: []interface{}{
&LicenseSpecificationProperty{
LicenseConfigurationArn: jsii.String("licenseConfigurationArn"),
},
},
Monitoring: jsii.Boolean(false),
NetworkInterfaces: []interface{}{
&NetworkInterfaceProperty{
DeviceIndex: jsii.String("deviceIndex"),
// the properties below are optional
AssociateCarrierIpAddress: jsii.Boolean(false),
AssociatePublicIpAddress: jsii.Boolean(false),
DeleteOnTermination: jsii.Boolean(false),
Description: jsii.String("description"),
GroupSet: []*string{
jsii.String("groupSet"),
},
Ipv6AddressCount: jsii.Number(123),
Ipv6Addresses: []interface{}{
&InstanceIpv6AddressProperty{
Ipv6Address: jsii.String("ipv6Address"),
},
},
NetworkInterfaceId: jsii.String("networkInterfaceId"),
PrivateIpAddress: jsii.String("privateIpAddress"),
PrivateIpAddresses: []interface{}{
&PrivateIpAddressSpecificationProperty{
Primary: jsii.Boolean(false),
PrivateIpAddress: jsii.String("privateIpAddress"),
},
},
SecondaryPrivateIpAddressCount: jsii.Number(123),
SubnetId: jsii.String("subnetId"),
},
},
PlacementGroupName: jsii.String("placementGroupName"),
PrivateDnsNameOptions: &PrivateDnsNameOptionsProperty{
EnableResourceNameDnsAaaaRecord: jsii.Boolean(false),
EnableResourceNameDnsARecord: jsii.Boolean(false),
HostnameType: jsii.String("hostnameType"),
},
PrivateIpAddress: jsii.String("privateIpAddress"),
PropagateTagsToVolumeOnCreation: jsii.Boolean(false),
RamdiskId: jsii.String("ramdiskId"),
SecurityGroupIds: []*string{
jsii.String("securityGroupIds"),
},
SecurityGroups: []*string{
jsii.String("securityGroups"),
},
SourceDestCheck: jsii.Boolean(false),
SsmAssociations: []interface{}{
&SsmAssociationProperty{
DocumentName: jsii.String("documentName"),
// the properties below are optional
AssociationParameters: []interface{}{
&AssociationParameterProperty{
Key: jsii.String("key"),
Value: []*string{
jsii.String("value"),
},
},
},
},
},
SubnetId: jsii.String("subnetId"),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
Tenancy: jsii.String("tenancy"),
UserData: jsii.String("userData"),
Volumes: []interface{}{
&VolumeProperty{
Device: jsii.String("device"),
VolumeId: jsii.String("volumeId"),
},
},
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html
type CfnInstance_AssociationParameterProperty ¶
type CfnInstance_AssociationParameterProperty struct {
// The name of an input parameter that is in the associated SSM document.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-associationparameter.html#cfn-ec2-instance-associationparameter-key
//
Key *string `field:"required" json:"key" yaml:"key"`
// The value of an input parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-associationparameter.html#cfn-ec2-instance-associationparameter-value
//
Value *[]*string `field:"required" json:"value" yaml:"value"`
}
Specifies input parameter values for an SSM document in AWS Systems Manager .
`AssociationParameter` is a property of the [SsmAssociation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-ssmassociation.html) property type.
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"
associationParameterProperty := &AssociationParameterProperty{
Key: jsii.String("key"),
Value: []*string{
jsii.String("value"),
},
}
type CfnInstance_BlockDeviceMappingProperty ¶
type CfnInstance_BlockDeviceMappingProperty struct {
// The device name (for example, `/dev/sdh` or `xvdh` ).
//
// > After the instance is running, this parameter is used to specify the device name of the block device mapping to update.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-blockdevicemapping.html#cfn-ec2-instance-blockdevicemapping-devicename
//
DeviceName *string `field:"required" json:"deviceName" yaml:"deviceName"`
// Parameters used to automatically set up EBS volumes when the instance is launched.
//
// > After the instance is running, you can modify only the `DeleteOnTermination` parameter for the attached volumes without interrupting the instance. Modifying any other parameter results in instance [replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-blockdevicemapping.html#cfn-ec2-instance-blockdevicemapping-ebs
//
Ebs interface{} `field:"optional" json:"ebs" yaml:"ebs"`
// To omit the device from the block device mapping, specify an empty string.
//
// > After the instance is running, modifying this parameter results in instance [replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-blockdevicemapping.html#cfn-ec2-instance-blockdevicemapping-nodevice
//
NoDevice interface{} `field:"optional" json:"noDevice" yaml:"noDevice"`
// The virtual device name ( `ephemeral` N).
//
// The name must be in the form `ephemeral` *X* where *X* is a number starting from zero (0). For example, an instance type with 2 available instance store volumes can specify mappings for `ephemeral0` and `ephemeral1` . The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.
//
// NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.
//
// *Constraints* : For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
//
// > After the instance is running, modifying this parameter results in instance [replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-blockdevicemapping.html#cfn-ec2-instance-blockdevicemapping-virtualname
//
VirtualName *string `field:"optional" json:"virtualName" yaml:"virtualName"`
}
Specifies a block device mapping for an instance.
You must specify exactly one of the following properties: `VirtualName` , `Ebs` , or `NoDevice` .
`BlockDeviceMapping` is a property of the [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) resource.
> After the instance is running, you can modify only the `DeleteOnTermination` parameter for the attached volumes without interrupting the instance. Modifying any other parameter results in instance [replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) .
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"
blockDeviceMappingProperty := &BlockDeviceMappingProperty{
DeviceName: jsii.String("deviceName"),
// the properties below are optional
Ebs: &EbsProperty{
DeleteOnTermination: jsii.Boolean(false),
Encrypted: jsii.Boolean(false),
Iops: jsii.Number(123),
KmsKeyId: jsii.String("kmsKeyId"),
SnapshotId: jsii.String("snapshotId"),
VolumeSize: jsii.Number(123),
VolumeType: jsii.String("volumeType"),
},
NoDevice: &NoDeviceProperty{
},
VirtualName: jsii.String("virtualName"),
}
type CfnInstance_CpuOptionsProperty ¶
type CfnInstance_CpuOptionsProperty struct {
// The number of CPU cores for the instance.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-cpuoptions.html#cfn-ec2-instance-cpuoptions-corecount
//
CoreCount *float64 `field:"optional" json:"coreCount" yaml:"coreCount"`
// The number of threads per CPU core.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-cpuoptions.html#cfn-ec2-instance-cpuoptions-threadspercore
//
ThreadsPerCore *float64 `field:"optional" json:"threadsPerCore" yaml:"threadsPerCore"`
}
Specifies the CPU options for the instance.
When you specify CPU options, you must specify both the number of CPU cores and threads per core.
Modifying the CPU options for an instance results in instance [replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) .
For more information, see [Optimize CPU options](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html) in the *Amazon Elastic Compute Cloud User 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"
cpuOptionsProperty := &CpuOptionsProperty{
CoreCount: jsii.Number(123),
ThreadsPerCore: jsii.Number(123),
}
type CfnInstance_CreditSpecificationProperty ¶
type CfnInstance_CreditSpecificationProperty struct {
// The credit option for CPU usage of the instance.
//
// Valid values: `standard` | `unlimited`
//
// T3 instances with `host` tenancy do not support the `unlimited` CPU credit option.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-creditspecification.html#cfn-ec2-instance-creditspecification-cpucredits
//
CpuCredits *string `field:"optional" json:"cpuCredits" yaml:"cpuCredits"`
}
Specifies the credit option for CPU usage of a T instance.
`CreditSpecification` is a property of the [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) resource.
For more information, see [Burstable performance instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html) in the *Amazon EC2 User 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"
creditSpecificationProperty := &CreditSpecificationProperty{
CpuCredits: jsii.String("cpuCredits"),
}
type CfnInstance_EbsProperty ¶
type CfnInstance_EbsProperty struct {
// Indicates whether the EBS volume is deleted on instance termination.
//
// For more information, see [Preserving Amazon EBS volumes on instance termination](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/terminating-instances.html#preserving-volumes-on-termination) in the *Amazon EC2 User Guide* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-ebs.html#cfn-ec2-instance-ebs-deleteontermination
//
DeleteOnTermination interface{} `field:"optional" json:"deleteOnTermination" yaml:"deleteOnTermination"`
// Indicates whether the volume should be encrypted.
//
// The effect of setting the encryption state to `true` depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see [Encryption by default](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-by-default) in the *Amazon Elastic Compute Cloud User Guide* .
//
// Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see [Supported instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#EBSEncryption_supported_instances) .
//
// > After the instance is running, modifying this parameter results in instance [replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-ebs.html#cfn-ec2-instance-ebs-encrypted
//
Encrypted interface{} `field:"optional" json:"encrypted" yaml:"encrypted"`
// The number of I/O operations per second (IOPS).
//
// For `gp3` , `io1` , and `io2` volumes, this represents the number of IOPS that are provisioned for the volume. For `gp2` volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
//
// The following are the supported values for each volume type:
//
// - `gp3` : 3,000-16,000 IOPS
// - `io1` : 100-64,000 IOPS
// - `io2` : 100-64,000 IOPS
//
// For `io1` and `io2` volumes, we guarantee 64,000 IOPS only for [Instances built on the Nitro System](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances) . Other instance families guarantee performance up to 32,000 IOPS.
//
// This parameter is required for `io1` and `io2` volumes. The default for `gp3` volumes is 3,000 IOPS. This parameter is not supported for `gp2` , `st1` , `sc1` , or `standard` volumes.
//
// > After the instance is running, modifying this parameter results in instance [replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-ebs.html#cfn-ec2-instance-ebs-iops
//
Iops *float64 `field:"optional" json:"iops" yaml:"iops"`
// The identifier of the AWS KMS key to use for Amazon EBS encryption.
//
// If `KmsKeyId` is specified, the encrypted state must be `true` . If the encrypted state is `true` but you do not specify `KmsKeyId` , your KMS key for EBS is used.
//
// You can specify the KMS key using any of the following:
//
// - Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
// - Key alias. For example, alias/ExampleAlias.
// - Key ARN. For example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
// - Alias ARN. For example, arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias.
//
// > After the instance is running, modifying this parameter results in instance [replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-ebs.html#cfn-ec2-instance-ebs-kmskeyid
//
KmsKeyId *string `field:"optional" json:"kmsKeyId" yaml:"kmsKeyId"`
// The ID of the snapshot.
//
// If you specify both `SnapshotId` and `VolumeSize` , `VolumeSize` must be equal or greater than the size of the snapshot.
//
// > After the instance is running, modifying this parameter results in instance [replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-ebs.html#cfn-ec2-instance-ebs-snapshotid
//
SnapshotId *string `field:"optional" json:"snapshotId" yaml:"snapshotId"`
// The size of the volume, in GiBs.
//
// You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.
//
// The following are the supported volumes sizes for each volume type:
//
// - `gp2` and `gp3` :1-16,384
// - `io1` and `io2` : 4-16,384
// - `st1` and `sc1` : 125-16,384
// - `standard` : 1-1,024
//
// > After the instance is running, modifying this parameter results in instance [replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-ebs.html#cfn-ec2-instance-ebs-volumesize
//
VolumeSize *float64 `field:"optional" json:"volumeSize" yaml:"volumeSize"`
// The volume type.
//
// For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) in the *Amazon EC2 User Guide* . If the volume type is `io1` or `io2` , you must specify the IOPS that the volume supports.
//
// > After the instance is running, modifying this parameter results in instance [replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-ebs.html#cfn-ec2-instance-ebs-volumetype
//
VolumeType *string `field:"optional" json:"volumeType" yaml:"volumeType"`
}
Specifies a block device for an EBS volume.
`Ebs` is a property of the [BlockDeviceMapping](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-blockdevicemapping.html) property type.
> After the instance is running, you can modify only the `DeleteOnTermination` parameters for the attached volumes without interrupting the instance. Modifying any other parameter results in instance [replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) .
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"
ebsProperty := &EbsProperty{
DeleteOnTermination: jsii.Boolean(false),
Encrypted: jsii.Boolean(false),
Iops: jsii.Number(123),
KmsKeyId: jsii.String("kmsKeyId"),
SnapshotId: jsii.String("snapshotId"),
VolumeSize: jsii.Number(123),
VolumeType: jsii.String("volumeType"),
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-ebs.html
type CfnInstance_ElasticGpuSpecificationProperty ¶
type CfnInstance_ElasticGpuSpecificationProperty struct {
// The type of Elastic Graphics accelerator.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-elasticgpuspecification.html#cfn-ec2-instance-elasticgpuspecification-type
//
Type *string `field:"required" json:"type" yaml:"type"`
}
> Amazon Elastic Graphics reached end of life on January 8, 2024.
For workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, G4dn, or G5 instances.
Specifies the type of Elastic GPU. An Elastic GPU is a GPU resource that you can attach to your Amazon EC2 instance to accelerate the graphics performance of your applications.
`ElasticGpuSpecification` is a property of the [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) resource.
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"
elasticGpuSpecificationProperty := &ElasticGpuSpecificationProperty{
Type: jsii.String("type"),
}
type CfnInstance_ElasticInferenceAcceleratorProperty ¶
type CfnInstance_ElasticInferenceAcceleratorProperty struct {
// The type of elastic inference accelerator.
//
// The possible values are `eia1.medium` , `eia1.large` , `eia1.xlarge` , `eia2.medium` , `eia2.large` , and `eia2.xlarge` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-elasticinferenceaccelerator.html#cfn-ec2-instance-elasticinferenceaccelerator-type
//
Type *string `field:"required" json:"type" yaml:"type"`
// The number of elastic inference accelerators to attach to the instance.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-elasticinferenceaccelerator.html#cfn-ec2-instance-elasticinferenceaccelerator-count
//
Count *float64 `field:"optional" json:"count" yaml:"count"`
}
Specifies the Elastic Inference Accelerator for the instance.
`ElasticInferenceAccelerator` is a property of the [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) resource.
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"
elasticInferenceAcceleratorProperty := &ElasticInferenceAcceleratorProperty{
Type: jsii.String("type"),
// the properties below are optional
Count: jsii.Number(123),
}
type CfnInstance_EnclaveOptionsProperty ¶
type CfnInstance_EnclaveOptionsProperty struct {
// If this parameter is set to `true` , the instance is enabled for AWS Nitro Enclaves;
//
// otherwise, it is not enabled for AWS Nitro Enclaves.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-enclaveoptions.html#cfn-ec2-instance-enclaveoptions-enabled
//
Enabled interface{} `field:"optional" json:"enabled" yaml:"enabled"`
}
Indicates whether the instance is enabled for AWS Nitro Enclaves.
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"
enclaveOptionsProperty := &EnclaveOptionsProperty{
Enabled: jsii.Boolean(false),
}
type CfnInstance_HibernationOptionsProperty ¶
type CfnInstance_HibernationOptionsProperty struct {
// Set to `true` to enable your instance for hibernation.
//
// For Spot Instances, if you set `Configured` to `true` , either omit the `InstanceInterruptionBehavior` parameter (for [`SpotMarketOptions`](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SpotMarketOptions.html) ), or set it to `hibernate` . When `Configured` is true:
//
// - If you omit `InstanceInterruptionBehavior` , it defaults to `hibernate` .
// - If you set `InstanceInterruptionBehavior` to a value other than `hibernate` , you'll get an error.
//
// Default: `false`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-hibernationoptions.html#cfn-ec2-instance-hibernationoptions-configured
//
// Default: - false.
//
Configured interface{} `field:"optional" json:"configured" yaml:"configured"`
}
Specifies the hibernation options for the instance.
`HibernationOptions` is a property of the [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) resource.
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"
hibernationOptionsProperty := &HibernationOptionsProperty{
Configured: jsii.Boolean(false),
}
type CfnInstance_InstanceIpv6AddressProperty ¶
type CfnInstance_InstanceIpv6AddressProperty struct {
// The IPv6 address.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-instanceipv6address.html#cfn-ec2-instance-instanceipv6address-ipv6address
//
Ipv6Address *string `field:"required" json:"ipv6Address" yaml:"ipv6Address"`
}
Specifies the IPv6 address for the instance.
`InstanceIpv6Address` is a property of the [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) resource.
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"
instanceIpv6AddressProperty := &InstanceIpv6AddressProperty{
Ipv6Address: jsii.String("ipv6Address"),
}
type CfnInstance_LaunchTemplateSpecificationProperty ¶
type CfnInstance_LaunchTemplateSpecificationProperty struct {
// The version number of the launch template. You must specify this property.
//
// To specify the default version of the template, use the `Fn::GetAtt` intrinsic function to retrieve the `DefaultVersionNumber` attribute of the launch template. To specify the latest version of the template, use `Fn::GetAtt` to retrieve the `LatestVersionNumber` attribute. For more information, see [AWS::EC2:LaunchTemplate return values for Fn::GetAtt](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#aws-resource-ec2-launchtemplate-return-values-fn--getatt) .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-launchtemplatespecification.html#cfn-ec2-instance-launchtemplatespecification-version
//
Version *string `field:"required" json:"version" yaml:"version"`
// The ID of the launch template.
//
// You must specify either the launch template ID or the launch template name, but not both.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-launchtemplatespecification.html#cfn-ec2-instance-launchtemplatespecification-launchtemplateid
//
LaunchTemplateId *string `field:"optional" json:"launchTemplateId" yaml:"launchTemplateId"`
// The name of the launch template.
//
// You must specify either the launch template ID or the launch template name, but not both.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-launchtemplatespecification.html#cfn-ec2-instance-launchtemplatespecification-launchtemplatename
//
LaunchTemplateName *string `field:"optional" json:"launchTemplateName" yaml:"launchTemplateName"`
}
Specifies a launch template to use when launching an Amazon EC2 instance.
You must specify the following:
- The ID or the name of the launch template, but not both. - The version of the launch template.
For information about creating a launch template, see [AWS::EC2::LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html) and [Create a launch template](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html#create-launch-template) in the *Amazon EC2 User Guide* . For example launch templates, see the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#aws-resource-ec2-launchtemplate--examples) for `AWS::EC2::LaunchTemplate` .
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"
launchTemplateSpecificationProperty := &LaunchTemplateSpecificationProperty{
Version: jsii.String("version"),
// the properties below are optional
LaunchTemplateId: jsii.String("launchTemplateId"),
LaunchTemplateName: jsii.String("launchTemplateName"),
}
type CfnInstance_LicenseSpecificationProperty ¶
type CfnInstance_LicenseSpecificationProperty struct {
// The Amazon Resource Name (ARN) of the license configuration.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-licensespecification.html#cfn-ec2-instance-licensespecification-licenseconfigurationarn
//
LicenseConfigurationArn *string `field:"required" json:"licenseConfigurationArn" yaml:"licenseConfigurationArn"`
}
Specifies the license configuration to use.
`LicenseSpecification` is a property of the [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) resource.
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"
licenseSpecificationProperty := &LicenseSpecificationProperty{
LicenseConfigurationArn: jsii.String("licenseConfigurationArn"),
}
type CfnInstance_NetworkInterfaceProperty ¶
type CfnInstance_NetworkInterfaceProperty struct {
// The position of the network interface in the attachment order.
//
// A primary network interface has a device index of 0.
//
// If you create a network interface when launching an instance, you must specify the device index.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-networkinterface.html#cfn-ec2-instance-networkinterface-deviceindex
//
DeviceIndex *string `field:"required" json:"deviceIndex" yaml:"deviceIndex"`
// Indicates whether to assign a carrier IP address to the network interface.
//
// You can only assign a carrier IP address to a network interface that is in a subnet in a Wavelength Zone. For more information about carrier IP addresses, see [Carrier IP address](https://docs.aws.amazon.com/wavelength/latest/developerguide/how-wavelengths-work.html#provider-owned-ip) in the *AWS Wavelength Developer Guide* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-networkinterface.html#cfn-ec2-instance-networkinterface-associatecarrieripaddress
//
AssociateCarrierIpAddress interface{} `field:"optional" json:"associateCarrierIpAddress" yaml:"associateCarrierIpAddress"`
// Indicates whether to assign a public IPv4 address to an instance.
//
// Applies only if creating a network interface when launching an instance. The network interface must be the primary network interface. If launching into a default subnet, the default value is `true` .
//
// AWS charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the *Public IPv4 Address* tab on the [VPC pricing page](https://docs.aws.amazon.com/vpc/pricing/) .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-networkinterface.html#cfn-ec2-instance-networkinterface-associatepublicipaddress
//
AssociatePublicIpAddress interface{} `field:"optional" json:"associatePublicIpAddress" yaml:"associatePublicIpAddress"`
// Indicates whether the network interface is deleted when the instance is terminated.
//
// Applies only if creating a network interface when launching an instance.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-networkinterface.html#cfn-ec2-instance-networkinterface-deleteontermination
//
DeleteOnTermination interface{} `field:"optional" json:"deleteOnTermination" yaml:"deleteOnTermination"`
// The description of the network interface.
//
// Applies only if creating a network interface when launching an instance.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-networkinterface.html#cfn-ec2-instance-networkinterface-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// The IDs of the security groups for the network interface.
//
// Applies only if creating a network interface when launching an instance.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-networkinterface.html#cfn-ec2-instance-networkinterface-groupset
//
GroupSet *[]*string `field:"optional" json:"groupSet" yaml:"groupSet"`
// A number of IPv6 addresses to assign to the network interface.
//
// Amazon EC2 chooses the IPv6 addresses from the range of the subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-networkinterface.html#cfn-ec2-instance-networkinterface-ipv6addresscount
//
Ipv6AddressCount *float64 `field:"optional" json:"ipv6AddressCount" yaml:"ipv6AddressCount"`
// The IPv6 addresses to assign to the network interface.
//
// You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-networkinterface.html#cfn-ec2-instance-networkinterface-ipv6addresses
//
Ipv6Addresses interface{} `field:"optional" json:"ipv6Addresses" yaml:"ipv6Addresses"`
// The ID of the network interface, when attaching an existing network interface.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-networkinterface.html#cfn-ec2-instance-networkinterface-networkinterfaceid
//
NetworkInterfaceId *string `field:"optional" json:"networkInterfaceId" yaml:"networkInterfaceId"`
// The private IPv4 address of the network interface.
//
// Applies only if creating a network interface when launching an instance.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-networkinterface.html#cfn-ec2-instance-networkinterface-privateipaddress
//
PrivateIpAddress *string `field:"optional" json:"privateIpAddress" yaml:"privateIpAddress"`
// One or more private IPv4 addresses to assign to the network interface.
//
// Only one private IPv4 address can be designated as primary.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-networkinterface.html#cfn-ec2-instance-networkinterface-privateipaddresses
//
PrivateIpAddresses interface{} `field:"optional" json:"privateIpAddresses" yaml:"privateIpAddresses"`
// The number of secondary private IPv4 addresses.
//
// You can't specify this option and specify more than one private IP address using the private IP addresses option.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-networkinterface.html#cfn-ec2-instance-networkinterface-secondaryprivateipaddresscount
//
SecondaryPrivateIpAddressCount *float64 `field:"optional" json:"secondaryPrivateIpAddressCount" yaml:"secondaryPrivateIpAddressCount"`
// The ID of the subnet associated with the network interface.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-networkinterface.html#cfn-ec2-instance-networkinterface-subnetid
//
SubnetId *string `field:"optional" json:"subnetId" yaml:"subnetId"`
}
Specifies a network interface that is to be attached to an instance.
You can create a network interface when launching an instance. For an example, see the [AWS::EC2::Instance examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#aws-properties-ec2-instance--examples--Automatically_assign_a_public_IP_address) .
Alternatively, you can attach an existing network interface when launching an instance. For an example, see the [AWS::EC2:NetworkInterface examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#aws-resource-ec2-networkinterface--examples) .
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"
networkInterfaceProperty := &NetworkInterfaceProperty{
DeviceIndex: jsii.String("deviceIndex"),
// the properties below are optional
AssociateCarrierIpAddress: jsii.Boolean(false),
AssociatePublicIpAddress: jsii.Boolean(false),
DeleteOnTermination: jsii.Boolean(false),
Description: jsii.String("description"),
GroupSet: []*string{
jsii.String("groupSet"),
},
Ipv6AddressCount: jsii.Number(123),
Ipv6Addresses: []interface{}{
&InstanceIpv6AddressProperty{
Ipv6Address: jsii.String("ipv6Address"),
},
},
NetworkInterfaceId: jsii.String("networkInterfaceId"),
PrivateIpAddress: jsii.String("privateIpAddress"),
PrivateIpAddresses: []interface{}{
&PrivateIpAddressSpecificationProperty{
Primary: jsii.Boolean(false),
PrivateIpAddress: jsii.String("privateIpAddress"),
},
},
SecondaryPrivateIpAddressCount: jsii.Number(123),
SubnetId: jsii.String("subnetId"),
}
type CfnInstance_NoDeviceProperty ¶
type CfnInstance_NoDeviceProperty struct {
}
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"
noDeviceProperty := &NoDeviceProperty{
}
type CfnInstance_PrivateDnsNameOptionsProperty ¶ added in v2.13.0
type CfnInstance_PrivateDnsNameOptionsProperty struct {
// Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.
//
// For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *Amazon Elastic Compute Cloud User Guide* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-privatednsnameoptions.html#cfn-ec2-instance-privatednsnameoptions-enableresourcenamednsaaaarecord
//
EnableResourceNameDnsAaaaRecord interface{} `field:"optional" json:"enableResourceNameDnsAaaaRecord" yaml:"enableResourceNameDnsAaaaRecord"`
// Indicates whether to respond to DNS queries for instance hostnames with DNS A records.
//
// For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *Amazon Elastic Compute Cloud User Guide* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-privatednsnameoptions.html#cfn-ec2-instance-privatednsnameoptions-enableresourcenamednsarecord
//
EnableResourceNameDnsARecord interface{} `field:"optional" json:"enableResourceNameDnsARecord" yaml:"enableResourceNameDnsARecord"`
// The type of hostnames to assign to instances in the subnet at launch.
//
// For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance IPv4 address or the instance ID. For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *Amazon Elastic Compute Cloud User Guide* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-privatednsnameoptions.html#cfn-ec2-instance-privatednsnameoptions-hostnametype
//
HostnameType *string `field:"optional" json:"hostnameType" yaml:"hostnameType"`
}
The type of hostnames to assign to instances in the subnet at launch.
For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance IPv4 address or the instance ID. For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *Amazon Elastic Compute Cloud User 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"
privateDnsNameOptionsProperty := &PrivateDnsNameOptionsProperty{
EnableResourceNameDnsAaaaRecord: jsii.Boolean(false),
EnableResourceNameDnsARecord: jsii.Boolean(false),
HostnameType: jsii.String("hostnameType"),
}
type CfnInstance_PrivateIpAddressSpecificationProperty ¶
type CfnInstance_PrivateIpAddressSpecificationProperty struct {
// Indicates whether the private IPv4 address is the primary private IPv4 address.
//
// Only one IPv4 address can be designated as primary.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-privateipaddressspecification.html#cfn-ec2-instance-privateipaddressspecification-primary
//
Primary interface{} `field:"required" json:"primary" yaml:"primary"`
// The private IPv4 address.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-privateipaddressspecification.html#cfn-ec2-instance-privateipaddressspecification-privateipaddress
//
PrivateIpAddress *string `field:"required" json:"privateIpAddress" yaml:"privateIpAddress"`
}
Specifies a secondary private IPv4 address for a network interface.
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"
privateIpAddressSpecificationProperty := &PrivateIpAddressSpecificationProperty{
Primary: jsii.Boolean(false),
PrivateIpAddress: jsii.String("privateIpAddress"),
}
type CfnInstance_SsmAssociationProperty ¶
type CfnInstance_SsmAssociationProperty struct {
// The name of an SSM document to associate with the instance.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-ssmassociation.html#cfn-ec2-instance-ssmassociation-documentname
//
DocumentName *string `field:"required" json:"documentName" yaml:"documentName"`
// The input parameter values to use with the associated SSM document.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-ssmassociation.html#cfn-ec2-instance-ssmassociation-associationparameters
//
AssociationParameters interface{} `field:"optional" json:"associationParameters" yaml:"associationParameters"`
}
Specifies the SSM document and parameter values in AWS Systems Manager to associate with an instance.
`SsmAssociations` is a property of the [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) resource.
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"
ssmAssociationProperty := &SsmAssociationProperty{
DocumentName: jsii.String("documentName"),
// the properties below are optional
AssociationParameters: []interface{}{
&AssociationParameterProperty{
Key: jsii.String("key"),
Value: []*string{
jsii.String("value"),
},
},
},
}
type CfnInstance_StateProperty ¶ added in v2.141.0
type CfnInstance_StateProperty struct {
// The state of the instance as a 16-bit unsigned integer.
//
// The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.
//
// The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.
//
// The valid values for instance-state-code will all be in the range of the low byte and they are:
//
// - `0` : `pending`
// - `16` : `running`
// - `32` : `shutting-down`
// - `48` : `terminated`
// - `64` : `stopping`
// - `80` : `stopped`
//
// You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-state.html#cfn-ec2-instance-state-code
//
Code *string `field:"optional" json:"code" yaml:"code"`
// The current state of the instance.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-state.html#cfn-ec2-instance-state-name
//
Name *string `field:"optional" json:"name" yaml:"name"`
}
Describes the current state 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.String("code"),
Name: jsii.String("name"),
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-state.html
type CfnInstance_VolumeProperty ¶
type CfnInstance_VolumeProperty struct {
// The device name (for example, `/dev/sdh` or `xvdh` ).
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-volume.html#cfn-ec2-instance-volume-device
//
Device *string `field:"required" json:"device" yaml:"device"`
// The ID of the EBS volume.
//
// The volume and instance must be within the same Availability Zone.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-volume.html#cfn-ec2-instance-volume-volumeid
//
VolumeId *string `field:"required" json:"volumeId" yaml:"volumeId"`
}
Specifies a volume to attach to an instance.
`Volume` is an embedded property of the [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) resource.
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"
volumeProperty := &VolumeProperty{
Device: jsii.String("device"),
VolumeId: jsii.String("volumeId"),
}
type CfnInternetGateway ¶
type CfnInternetGateway interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggable
// The ID of the internet gateway.
AttrInternetGatewayId() *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
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
// Any tags to assign to the internet gateway.
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{})
}
Allocates an internet gateway for use with a VPC.
After creating the Internet gateway, you then attach it to a VPC.
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"
cfnInternetGateway := awscdk.Aws_ec2.NewCfnInternetGateway(this, jsii.String("MyCfnInternetGateway"), &CfnInternetGatewayProps{
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-internetgateway.html
func NewCfnInternetGateway ¶
func NewCfnInternetGateway(scope constructs.Construct, id *string, props *CfnInternetGatewayProps) CfnInternetGateway
type CfnInternetGatewayProps ¶
type CfnInternetGatewayProps struct {
// Any tags to assign to the internet gateway.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-internetgateway.html#cfn-ec2-internetgateway-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnInternetGateway`.
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"
cfnInternetGatewayProps := &CfnInternetGatewayProps{
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-internetgateway.html
type CfnKeyPair ¶ added in v2.25.0
type CfnKeyPair interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggable
// If you created the key pair using Amazon EC2:.
//
// - For RSA key pairs, the key fingerprint is the SHA-1 digest of the DER encoded private key.
// - For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with [OpenSSH 6.8](https://docs.aws.amazon.com/http://www.openssh.com/txt/release-6.8) .
//
// If you imported the key pair to Amazon EC2:
//
// - For RSA key pairs, the key fingerprint is the MD5 public key fingerprint as specified in section 4 of RFC 4716.
// - For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with [OpenSSH 6.8](https://docs.aws.amazon.com/http://www.openssh.com/txt/release-6.8) .
AttrKeyFingerprint() *string
// The ID of the key pair.
AttrKeyPairId() *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 format of the key pair.
KeyFormat() *string
SetKeyFormat(val *string)
// A unique name for the key pair.
KeyName() *string
SetKeyName(val *string)
// The type of key pair.
//
// Note that ED25519 keys are not supported for Windows instances.
KeyType() *string
SetKeyType(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
// The public key material.
PublicKeyMaterial() *string
SetPublicKeyMaterial(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
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
// The tags to apply to the key pair.
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{})
}
Specifies a key pair for use with an Amazon Elastic Compute Cloud instance as follows:.
- To import an existing key pair, include the `PublicKeyMaterial` property. - To create a new key pair, omit the `PublicKeyMaterial` property.
When you import an existing key pair, you specify the public key material for the key. We assume that you have the private key material for the key. AWS CloudFormation does not create or return the private key material when you import a key pair.
When you create a new key pair, the private key is saved to AWS Systems Manager Parameter Store, using a parameter with the following name: `/ec2/keypair/{key_pair_id}` . For more information about retrieving private key, and the required permissions, see [Create a key pair using AWS CloudFormation](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/create-key-pairs.html#create-key-pair-cloudformation) in the *Amazon EC2 User Guide* .
When AWS CloudFormation deletes a key pair that was created or imported by a stack, it also deletes the parameter that was used to store the private key material in Parameter Store.
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"
cfnKeyPair := awscdk.Aws_ec2.NewCfnKeyPair(this, jsii.String("MyCfnKeyPair"), &CfnKeyPairProps{
KeyName: jsii.String("keyName"),
// the properties below are optional
KeyFormat: jsii.String("keyFormat"),
KeyType: jsii.String("keyType"),
PublicKeyMaterial: jsii.String("publicKeyMaterial"),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-keypair.html
func NewCfnKeyPair ¶ added in v2.25.0
func NewCfnKeyPair(scope constructs.Construct, id *string, props *CfnKeyPairProps) CfnKeyPair
type CfnKeyPairProps ¶ added in v2.25.0
type CfnKeyPairProps struct {
// A unique name for the key pair.
//
// Constraints: Up to 255 ASCII characters.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-keypair.html#cfn-ec2-keypair-keyname
//
KeyName *string `field:"required" json:"keyName" yaml:"keyName"`
// The format of the key pair.
//
// Default: `pem`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-keypair.html#cfn-ec2-keypair-keyformat
//
// Default: - "pem".
//
KeyFormat *string `field:"optional" json:"keyFormat" yaml:"keyFormat"`
// The type of key pair. Note that ED25519 keys are not supported for Windows instances.
//
// If the `PublicKeyMaterial` property is specified, the `KeyType` property is ignored, and the key type is inferred from the `PublicKeyMaterial` value.
//
// Default: `rsa`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-keypair.html#cfn-ec2-keypair-keytype
//
// Default: - "rsa".
//
KeyType *string `field:"optional" json:"keyType" yaml:"keyType"`
// The public key material.
//
// The `PublicKeyMaterial` property is used to import a key pair. If this property is not specified, then a new key pair will be created.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-keypair.html#cfn-ec2-keypair-publickeymaterial
//
PublicKeyMaterial *string `field:"optional" json:"publicKeyMaterial" yaml:"publicKeyMaterial"`
// The tags to apply to the key pair.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-keypair.html#cfn-ec2-keypair-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnKeyPair`.
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"
cfnKeyPairProps := &CfnKeyPairProps{
KeyName: jsii.String("keyName"),
// the properties below are optional
KeyFormat: jsii.String("keyFormat"),
KeyType: jsii.String("keyType"),
PublicKeyMaterial: jsii.String("publicKeyMaterial"),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-keypair.html
type CfnLaunchTemplate ¶
type CfnLaunchTemplate interface {
awscdk.CfnResource
awscdk.IInspectable
// The default version of the launch template, such as 2.
//
// The default version of a launch template cannot be specified in AWS CloudFormation . The default version can be set in the Amazon EC2 console or by using the `modify-launch-template` AWS CLI command.
AttrDefaultVersionNumber() *string
// The latest version of the launch template, such as `5` .
AttrLatestVersionNumber() *string
// The ID of the launch template.
AttrLaunchTemplateId() *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 information for the launch template.
LaunchTemplateData() interface{}
SetLaunchTemplateData(val interface{})
// A name for the launch template.
LaunchTemplateName() *string
SetLaunchTemplateName(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
// The tags to apply to the launch template on creation.
TagSpecifications() interface{}
SetTagSpecifications(val interface{})
// 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{}
// A description for the first version of the launch template.
VersionDescription() *string
SetVersionDescription(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{})
}
Specifies the properties for creating a launch template.
The minimum required properties for specifying a launch template are as follows:
- You must specify at least one property for the launch template data. - You can optionally specify a name for the launch template. If you do not specify a name, AWS CloudFormation creates a name for you.
A launch template can contain some or all of the configuration information to launch an instance. When you launch an instance using a launch template, instance properties that are not specified in the launch template use default values, except the `ImageId` property, which has no default value. If you do not specify an AMI ID for the launch template `ImageId` property, you must specify an AMI ID for the instance `ImageId` property.
For more information, see [Launch an instance from a launch template](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html) in the *Amazon EC2 User Guide* .
Example:
var cluster cluster
userData := `MIME-Version: 1.0
Content-Type: multipart/mixed; boundary="==MYBOUNDARY=="
--==MYBOUNDARY==
Content-Type: text/x-shellscript; charset="us-ascii"
#!/bin/bash
echo "Running custom user data script"
--==MYBOUNDARY==--\\
`
lt := ec2.NewCfnLaunchTemplate(this, jsii.String("LaunchTemplate"), &CfnLaunchTemplateProps{
LaunchTemplateData: &LaunchTemplateDataProperty{
InstanceType: jsii.String("t3.small"),
UserData: awscdk.Fn_Base64(userData),
},
})
cluster.AddNodegroupCapacity(jsii.String("extra-ng"), &NodegroupOptions{
LaunchTemplateSpec: &LaunchTemplateSpec{
Id: lt.ref,
Version: lt.AttrLatestVersionNumber,
},
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html
func NewCfnLaunchTemplate ¶
func NewCfnLaunchTemplate(scope constructs.Construct, id *string, props *CfnLaunchTemplateProps) CfnLaunchTemplate
type CfnLaunchTemplateProps ¶
type CfnLaunchTemplateProps struct {
// The information for the launch template.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-launchtemplatedata
//
LaunchTemplateData interface{} `field:"required" json:"launchTemplateData" yaml:"launchTemplateData"`
// A name for the launch template.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-launchtemplatename
//
LaunchTemplateName *string `field:"optional" json:"launchTemplateName" yaml:"launchTemplateName"`
// The tags to apply to the launch template on creation.
//
// To tag the launch template, the resource type must be `launch-template` .
//
// To specify the tags for resources that are created during instance launch, use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications) .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-tagspecifications
//
TagSpecifications interface{} `field:"optional" json:"tagSpecifications" yaml:"tagSpecifications"`
// A description for the first version of the launch template.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-versiondescription
//
VersionDescription *string `field:"optional" json:"versionDescription" yaml:"versionDescription"`
}
Properties for defining a `CfnLaunchTemplate`.
Example:
var cluster cluster
userData := `MIME-Version: 1.0
Content-Type: multipart/mixed; boundary="==MYBOUNDARY=="
--==MYBOUNDARY==
Content-Type: text/x-shellscript; charset="us-ascii"
#!/bin/bash
echo "Running custom user data script"
--==MYBOUNDARY==--\\
`
lt := ec2.NewCfnLaunchTemplate(this, jsii.String("LaunchTemplate"), &CfnLaunchTemplateProps{
LaunchTemplateData: &LaunchTemplateDataProperty{
InstanceType: jsii.String("t3.small"),
UserData: awscdk.Fn_Base64(userData),
},
})
cluster.AddNodegroupCapacity(jsii.String("extra-ng"), &NodegroupOptions{
LaunchTemplateSpec: &LaunchTemplateSpec{
Id: lt.ref,
Version: lt.AttrLatestVersionNumber,
},
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html
type CfnLaunchTemplate_AcceleratorCountProperty ¶
type CfnLaunchTemplate_AcceleratorCountProperty struct {
// The maximum number of accelerators.
//
// To specify no maximum limit, omit this parameter. To exclude accelerator-enabled instance types, set `Max` to `0` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-acceleratorcount.html#cfn-ec2-launchtemplate-acceleratorcount-max
//
Max *float64 `field:"optional" json:"max" yaml:"max"`
// The minimum number of accelerators.
//
// To specify no minimum limit, omit this parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-acceleratorcount.html#cfn-ec2-launchtemplate-acceleratorcount-min
//
Min *float64 `field:"optional" json:"min" yaml:"min"`
}
The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) on 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"
acceleratorCountProperty := &AcceleratorCountProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
}
type CfnLaunchTemplate_AcceleratorTotalMemoryMiBProperty ¶
type CfnLaunchTemplate_AcceleratorTotalMemoryMiBProperty struct {
// The maximum amount of accelerator memory, in MiB.
//
// To specify no maximum limit, omit this parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-acceleratortotalmemorymib.html#cfn-ec2-launchtemplate-acceleratortotalmemorymib-max
//
Max *float64 `field:"optional" json:"max" yaml:"max"`
// The minimum amount of accelerator memory, in MiB.
//
// To specify no minimum limit, omit this parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-acceleratortotalmemorymib.html#cfn-ec2-launchtemplate-acceleratortotalmemorymib-min
//
Min *float64 `field:"optional" json:"min" yaml:"min"`
}
The minimum and maximum amount of total accelerator memory, in MiB.
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"
acceleratorTotalMemoryMiBProperty := &AcceleratorTotalMemoryMiBProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
}
type CfnLaunchTemplate_BaselineEbsBandwidthMbpsProperty ¶
type CfnLaunchTemplate_BaselineEbsBandwidthMbpsProperty struct {
// The maximum baseline bandwidth, in Mbps.
//
// To specify no maximum limit, omit this parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-baselineebsbandwidthmbps.html#cfn-ec2-launchtemplate-baselineebsbandwidthmbps-max
//
Max *float64 `field:"optional" json:"max" yaml:"max"`
// The minimum baseline bandwidth, in Mbps.
//
// To specify no minimum limit, omit this parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-baselineebsbandwidthmbps.html#cfn-ec2-launchtemplate-baselineebsbandwidthmbps-min
//
Min *float64 `field:"optional" json:"min" yaml:"min"`
}
The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps.
For more information, see [Amazon EBS–optimized instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) in the *Amazon EC2 User 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"
baselineEbsBandwidthMbpsProperty := &BaselineEbsBandwidthMbpsProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
}
type CfnLaunchTemplate_BlockDeviceMappingProperty ¶
type CfnLaunchTemplate_BlockDeviceMappingProperty struct {
// The device name (for example, /dev/sdh or xvdh).
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping.html#cfn-ec2-launchtemplate-blockdevicemapping-devicename
//
DeviceName *string `field:"optional" json:"deviceName" yaml:"deviceName"`
// Parameters used to automatically set up EBS volumes when the instance is launched.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping.html#cfn-ec2-launchtemplate-blockdevicemapping-ebs
//
Ebs interface{} `field:"optional" json:"ebs" yaml:"ebs"`
// To omit the device from the block device mapping, specify an empty string.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping.html#cfn-ec2-launchtemplate-blockdevicemapping-nodevice
//
NoDevice *string `field:"optional" json:"noDevice" yaml:"noDevice"`
// The virtual device name (ephemeralN).
//
// Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping.html#cfn-ec2-launchtemplate-blockdevicemapping-virtualname
//
VirtualName *string `field:"optional" json:"virtualName" yaml:"virtualName"`
}
Specifies a block device mapping for a launch template.
You must specify `DeviceName` plus exactly one of the following properties: `Ebs` , `NoDevice` , or `VirtualName` .
`BlockDeviceMapping` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.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"
blockDeviceMappingProperty := &BlockDeviceMappingProperty{
DeviceName: jsii.String("deviceName"),
Ebs: &EbsProperty{
DeleteOnTermination: jsii.Boolean(false),
Encrypted: jsii.Boolean(false),
Iops: jsii.Number(123),
KmsKeyId: jsii.String("kmsKeyId"),
SnapshotId: jsii.String("snapshotId"),
Throughput: jsii.Number(123),
VolumeSize: jsii.Number(123),
VolumeType: jsii.String("volumeType"),
},
NoDevice: jsii.String("noDevice"),
VirtualName: jsii.String("virtualName"),
}
type CfnLaunchTemplate_CapacityReservationSpecificationProperty ¶
type CfnLaunchTemplate_CapacityReservationSpecificationProperty struct {
// Indicates the instance's Capacity Reservation preferences. Possible preferences include:.
//
// - `open` - The instance can run in any `open` Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).
// - `none` - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-capacityreservationspecification.html#cfn-ec2-launchtemplate-capacityreservationspecification-capacityreservationpreference
//
CapacityReservationPreference *string `field:"optional" json:"capacityReservationPreference" yaml:"capacityReservationPreference"`
// Information about the target Capacity Reservation or Capacity Reservation group.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-capacityreservationspecification.html#cfn-ec2-launchtemplate-capacityreservationspecification-capacityreservationtarget
//
CapacityReservationTarget interface{} `field:"optional" json:"capacityReservationTarget" yaml:"capacityReservationTarget"`
}
Specifies an instance's Capacity Reservation targeting option. You can specify only one option at a time.
`CapacityReservationSpecification` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.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"
capacityReservationSpecificationProperty := &CapacityReservationSpecificationProperty{
CapacityReservationPreference: jsii.String("capacityReservationPreference"),
CapacityReservationTarget: &CapacityReservationTargetProperty{
CapacityReservationId: jsii.String("capacityReservationId"),
CapacityReservationResourceGroupArn: jsii.String("capacityReservationResourceGroupArn"),
},
}
type CfnLaunchTemplate_CapacityReservationTargetProperty ¶
type CfnLaunchTemplate_CapacityReservationTargetProperty struct {
// The ID of the Capacity Reservation in which to run the instance.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-capacityreservationtarget.html#cfn-ec2-launchtemplate-capacityreservationtarget-capacityreservationid
//
CapacityReservationId *string `field:"optional" json:"capacityReservationId" yaml:"capacityReservationId"`
// The ARN of the Capacity Reservation resource group in which to run the instance.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-capacityreservationtarget.html#cfn-ec2-launchtemplate-capacityreservationtarget-capacityreservationresourcegrouparn
//
CapacityReservationResourceGroupArn *string `field:"optional" json:"capacityReservationResourceGroupArn" yaml:"capacityReservationResourceGroupArn"`
}
Specifies a target Capacity Reservation.
`CapacityReservationTarget` is a property of the [Amazon EC2 LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html) property type.
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"
capacityReservationTargetProperty := &CapacityReservationTargetProperty{
CapacityReservationId: jsii.String("capacityReservationId"),
CapacityReservationResourceGroupArn: jsii.String("capacityReservationResourceGroupArn"),
}
type CfnLaunchTemplate_ConnectionTrackingSpecificationProperty ¶ added in v2.112.0
type CfnLaunchTemplate_ConnectionTrackingSpecificationProperty struct {
// Timeout (in seconds) for idle TCP connections in an established state.
//
// Min: 60 seconds. Max: 432000 seconds (5 days). Default: 432000 seconds. Recommended: Less than 432000 seconds.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-connectiontrackingspecification.html#cfn-ec2-launchtemplate-connectiontrackingspecification-tcpestablishedtimeout
//
TcpEstablishedTimeout *float64 `field:"optional" json:"tcpEstablishedTimeout" yaml:"tcpEstablishedTimeout"`
// Timeout (in seconds) for idle UDP flows classified as streams which have seen more than one request-response transaction.
//
// Min: 60 seconds. Max: 180 seconds (3 minutes). Default: 180 seconds.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-connectiontrackingspecification.html#cfn-ec2-launchtemplate-connectiontrackingspecification-udpstreamtimeout
//
UdpStreamTimeout *float64 `field:"optional" json:"udpStreamTimeout" yaml:"udpStreamTimeout"`
// Timeout (in seconds) for idle UDP flows that have seen traffic only in a single direction or a single request-response transaction.
//
// Min: 30 seconds. Max: 60 seconds. Default: 30 seconds.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-connectiontrackingspecification.html#cfn-ec2-launchtemplate-connectiontrackingspecification-udptimeout
//
UdpTimeout *float64 `field:"optional" json:"udpTimeout" yaml:"udpTimeout"`
}
A security group connection tracking specification that enables you to set the idle timeout for connection tracking on an Elastic network interface.
For more information, see [Connection tracking timeouts](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-connection-tracking.html#connection-tracking-timeouts) in the *Amazon EC2 User 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"
connectionTrackingSpecificationProperty := &ConnectionTrackingSpecificationProperty{
TcpEstablishedTimeout: jsii.Number(123),
UdpStreamTimeout: jsii.Number(123),
UdpTimeout: jsii.Number(123),
}
type CfnLaunchTemplate_CpuOptionsProperty ¶
type CfnLaunchTemplate_CpuOptionsProperty struct {
// Indicates whether to enable the instance for AMD SEV-SNP.
//
// AMD SEV-SNP is supported with M6a, R6a, and C6a instance types only. For more information, see [AMD SEV-SNP](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/sev-snp.html) .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-cpuoptions.html#cfn-ec2-launchtemplate-cpuoptions-amdsevsnp
//
AmdSevSnp *string `field:"optional" json:"amdSevSnp" yaml:"amdSevSnp"`
// The number of CPU cores for the instance.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-cpuoptions.html#cfn-ec2-launchtemplate-cpuoptions-corecount
//
CoreCount *float64 `field:"optional" json:"coreCount" yaml:"coreCount"`
// The number of threads per CPU core.
//
// To disable multithreading for the instance, specify a value of `1` . Otherwise, specify the default value of `2` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-cpuoptions.html#cfn-ec2-launchtemplate-cpuoptions-threadspercore
//
ThreadsPerCore *float64 `field:"optional" json:"threadsPerCore" yaml:"threadsPerCore"`
}
Specifies the CPU options for an instance.
For more information, see [Optimize CPU options](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html) in the *Amazon Elastic Compute Cloud User Guide* .
`CpuOptions` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.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"
cpuOptionsProperty := &CpuOptionsProperty{
AmdSevSnp: jsii.String("amdSevSnp"),
CoreCount: jsii.Number(123),
ThreadsPerCore: jsii.Number(123),
}
type CfnLaunchTemplate_CreditSpecificationProperty ¶
type CfnLaunchTemplate_CreditSpecificationProperty struct {
// The credit option for CPU usage of a T instance.
//
// Valid values: `standard` | `unlimited`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-creditspecification.html#cfn-ec2-launchtemplate-creditspecification-cpucredits
//
CpuCredits *string `field:"optional" json:"cpuCredits" yaml:"cpuCredits"`
}
Specifies the credit option for CPU usage of a T2, T3, or T3a instance.
`CreditSpecification` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.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"
creditSpecificationProperty := &CreditSpecificationProperty{
CpuCredits: jsii.String("cpuCredits"),
}
type CfnLaunchTemplate_EbsProperty ¶
type CfnLaunchTemplate_EbsProperty struct {
// Indicates whether the EBS volume is deleted on instance termination.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-ebs.html#cfn-ec2-launchtemplate-ebs-deleteontermination
//
DeleteOnTermination interface{} `field:"optional" json:"deleteOnTermination" yaml:"deleteOnTermination"`
// Indicates whether the EBS volume is encrypted.
//
// Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-ebs.html#cfn-ec2-launchtemplate-ebs-encrypted
//
Encrypted interface{} `field:"optional" json:"encrypted" yaml:"encrypted"`
// The number of I/O operations per second (IOPS).
//
// For `gp3` , `io1` , and `io2` volumes, this represents the number of IOPS that are provisioned for the volume. For `gp2` volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
//
// The following are the supported values for each volume type:
//
// - `gp3` : 3,000 - 16,000 IOPS
// - `io1` : 100 - 64,000 IOPS
// - `io2` : 100 - 256,000 IOPS
//
// For `io2` volumes, you can achieve up to 256,000 IOPS on [instances built on the Nitro System](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances) . On other instances, you can achieve performance up to 32,000 IOPS.
//
// This parameter is supported for `io1` , `io2` , and `gp3` volumes only.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-ebs.html#cfn-ec2-launchtemplate-ebs-iops
//
Iops *float64 `field:"optional" json:"iops" yaml:"iops"`
// The ARN of the symmetric AWS Key Management Service ( AWS KMS ) CMK used for encryption.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-ebs.html#cfn-ec2-launchtemplate-ebs-kmskeyid
//
KmsKeyId *string `field:"optional" json:"kmsKeyId" yaml:"kmsKeyId"`
// The ID of the snapshot.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-ebs.html#cfn-ec2-launchtemplate-ebs-snapshotid
//
SnapshotId *string `field:"optional" json:"snapshotId" yaml:"snapshotId"`
// The throughput to provision for a `gp3` volume, with a maximum of 1,000 MiB/s.
//
// Valid Range: Minimum value of 125. Maximum value of 1000.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-ebs.html#cfn-ec2-launchtemplate-ebs-throughput
//
Throughput *float64 `field:"optional" json:"throughput" yaml:"throughput"`
// The size of the volume, in GiBs.
//
// You must specify either a snapshot ID or a volume size. The following are the supported volumes sizes for each volume type:
//
// - `gp2` and `gp3` : 1 - 16,384 GiB
// - `io1` : 4 - 16,384 GiB
// - `io2` : 4 - 65,536 GiB
// - `st1` and `sc1` : 125 - 16,384 GiB
// - `standard` : 1 - 1024 GiB.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-ebs.html#cfn-ec2-launchtemplate-ebs-volumesize
//
VolumeSize *float64 `field:"optional" json:"volumeSize" yaml:"volumeSize"`
// The volume type.
//
// For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volume-types.html) in the *Amazon EBS User Guide* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-ebs.html#cfn-ec2-launchtemplate-ebs-volumetype
//
VolumeType *string `field:"optional" json:"volumeType" yaml:"volumeType"`
}
Parameters for a block device for an EBS volume in an Amazon EC2 launch template.
`Ebs` is a property of [AWS::EC2::LaunchTemplate BlockDeviceMapping](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping.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"
ebsProperty := &EbsProperty{
DeleteOnTermination: jsii.Boolean(false),
Encrypted: jsii.Boolean(false),
Iops: jsii.Number(123),
KmsKeyId: jsii.String("kmsKeyId"),
SnapshotId: jsii.String("snapshotId"),
Throughput: jsii.Number(123),
VolumeSize: jsii.Number(123),
VolumeType: jsii.String("volumeType"),
}
type CfnLaunchTemplate_ElasticGpuSpecificationProperty ¶
type CfnLaunchTemplate_ElasticGpuSpecificationProperty struct {
// The type of Elastic Graphics accelerator.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-elasticgpuspecification.html#cfn-ec2-launchtemplate-elasticgpuspecification-type
//
Type *string `field:"optional" json:"type" yaml:"type"`
}
> Amazon Elastic Graphics reached end of life on January 8, 2024.
For workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, G4dn, or G5 instances.
Specifies a specification for an Elastic GPU for an Amazon EC2 launch template.
`ElasticGpuSpecification` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.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"
elasticGpuSpecificationProperty := &ElasticGpuSpecificationProperty{
Type: jsii.String("type"),
}
type CfnLaunchTemplate_EnaSrdSpecificationProperty ¶ added in v2.109.0
type CfnLaunchTemplate_EnaSrdSpecificationProperty struct {
// Indicates whether ENA Express is enabled for the network interface.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-enasrdspecification.html#cfn-ec2-launchtemplate-enasrdspecification-enasrdenabled
//
EnaSrdEnabled interface{} `field:"optional" json:"enaSrdEnabled" yaml:"enaSrdEnabled"`
// Configures ENA Express for UDP network traffic.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-enasrdspecification.html#cfn-ec2-launchtemplate-enasrdspecification-enasrdudpspecification
//
EnaSrdUdpSpecification interface{} `field:"optional" json:"enaSrdUdpSpecification" yaml:"enaSrdUdpSpecification"`
}
ENA Express uses AWS Scalable Reliable Datagram (SRD) technology to increase the maximum bandwidth used per stream and minimize tail latency of network traffic between EC2 instances.
With ENA Express, you can communicate between two EC2 instances in the same subnet within the same account, or in different accounts. Both sending and receiving instances must have ENA Express enabled.
To improve the reliability of network packet delivery, ENA Express reorders network packets on the receiving end by default. However, some UDP-based applications are designed to handle network packets that are out of order to reduce the overhead for packet delivery at the network layer. When ENA Express is enabled, you can specify whether UDP network traffic uses it.
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"
enaSrdSpecificationProperty := &EnaSrdSpecificationProperty{
EnaSrdEnabled: jsii.Boolean(false),
EnaSrdUdpSpecification: &EnaSrdUdpSpecificationProperty{
EnaSrdUdpEnabled: jsii.Boolean(false),
},
}
type CfnLaunchTemplate_EnaSrdUdpSpecificationProperty ¶ added in v2.109.0
type CfnLaunchTemplate_EnaSrdUdpSpecificationProperty struct {
// Indicates whether UDP traffic to and from the instance uses ENA Express.
//
// To specify this setting, you must first enable ENA Express.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-enasrdudpspecification.html#cfn-ec2-launchtemplate-enasrdudpspecification-enasrdudpenabled
//
EnaSrdUdpEnabled interface{} `field:"optional" json:"enaSrdUdpEnabled" yaml:"enaSrdUdpEnabled"`
}
ENA Express is compatible with both TCP and UDP transport protocols.
When it's enabled, TCP traffic automatically uses it. However, some UDP-based applications are designed to handle network packets that are out of order, without a need for retransmission, such as live video broadcasting or other near-real-time applications. For UDP traffic, you can specify whether to use ENA Express, based on your application environment needs.
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"
enaSrdUdpSpecificationProperty := &EnaSrdUdpSpecificationProperty{
EnaSrdUdpEnabled: jsii.Boolean(false),
}
type CfnLaunchTemplate_EnclaveOptionsProperty ¶
type CfnLaunchTemplate_EnclaveOptionsProperty struct {
// If this parameter is set to `true` , the instance is enabled for AWS Nitro Enclaves;
//
// otherwise, it is not enabled for AWS Nitro Enclaves.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-enclaveoptions.html#cfn-ec2-launchtemplate-enclaveoptions-enabled
//
Enabled interface{} `field:"optional" json:"enabled" yaml:"enabled"`
}
Indicates whether the instance is enabled for AWS Nitro Enclaves.
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"
enclaveOptionsProperty := &EnclaveOptionsProperty{
Enabled: jsii.Boolean(false),
}
type CfnLaunchTemplate_HibernationOptionsProperty ¶
type CfnLaunchTemplate_HibernationOptionsProperty struct {
// If you set this parameter to `true` , the instance is enabled for hibernation.
//
// Default: `false`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-hibernationoptions.html#cfn-ec2-launchtemplate-hibernationoptions-configured
//
Configured interface{} `field:"optional" json:"configured" yaml:"configured"`
}
Specifies whether your instance is configured for hibernation.
This parameter is valid only if the instance meets the [hibernation prerequisites](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html#hibernating-prerequisites) . For more information, see [Hibernate Your Instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html) in the *Amazon EC2 User Guide* .
`HibernationOptions` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.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"
hibernationOptionsProperty := &HibernationOptionsProperty{
Configured: jsii.Boolean(false),
}
type CfnLaunchTemplate_IamInstanceProfileProperty ¶
type CfnLaunchTemplate_IamInstanceProfileProperty struct {
// The Amazon Resource Name (ARN) of the instance profile.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-iaminstanceprofile.html#cfn-ec2-launchtemplate-iaminstanceprofile-arn
//
Arn *string `field:"optional" json:"arn" yaml:"arn"`
// The name of the instance profile.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-iaminstanceprofile.html#cfn-ec2-launchtemplate-iaminstanceprofile-name
//
Name *string `field:"optional" json:"name" yaml:"name"`
}
Specifies an IAM instance profile, which is a container for an IAM role for your instance.
You can use an IAM role to distribute your AWS credentials to your instances.
If you are creating the launch template for use with an Amazon EC2 Auto Scaling group, you can specify either the name or the ARN of the instance profile, but not both.
`IamInstanceProfile` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.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"
iamInstanceProfileProperty := &IamInstanceProfileProperty{
Arn: jsii.String("arn"),
Name: jsii.String("name"),
}
type CfnLaunchTemplate_InstanceMarketOptionsProperty ¶
type CfnLaunchTemplate_InstanceMarketOptionsProperty struct {
// The market type.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-instancemarketoptions.html#cfn-ec2-launchtemplate-instancemarketoptions-markettype
//
MarketType *string `field:"optional" json:"marketType" yaml:"marketType"`
// The options for Spot Instances.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-instancemarketoptions.html#cfn-ec2-launchtemplate-instancemarketoptions-spotoptions
//
SpotOptions interface{} `field:"optional" json:"spotOptions" yaml:"spotOptions"`
}
Specifies the market (purchasing) option for an instance.
`InstanceMarketOptions` is a property of the [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.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"
instanceMarketOptionsProperty := &InstanceMarketOptionsProperty{
MarketType: jsii.String("marketType"),
SpotOptions: &SpotOptionsProperty{
BlockDurationMinutes: jsii.Number(123),
InstanceInterruptionBehavior: jsii.String("instanceInterruptionBehavior"),
MaxPrice: jsii.String("maxPrice"),
SpotInstanceType: jsii.String("spotInstanceType"),
ValidUntil: jsii.String("validUntil"),
},
}
type CfnLaunchTemplate_InstanceRequirementsProperty ¶ added in v2.9.0
type CfnLaunchTemplate_InstanceRequirementsProperty struct {
// The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) on an instance.
//
// To exclude accelerator-enabled instance types, set `Max` to `0` .
//
// Default: No minimum or maximum limits.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-instancerequirements.html#cfn-ec2-launchtemplate-instancerequirements-acceleratorcount
//
AcceleratorCount interface{} `field:"optional" json:"acceleratorCount" yaml:"acceleratorCount"`
// Indicates whether instance types must have accelerators by specific manufacturers.
//
// - For instance types with AWS devices, specify `amazon-web-services` .
// - For instance types with AMD devices, specify `amd` .
// - For instance types with Habana devices, specify `habana` .
// - For instance types with NVIDIA devices, specify `nvidia` .
// - For instance types with Xilinx devices, specify `xilinx` .
//
// Default: Any manufacturer.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-instancerequirements.html#cfn-ec2-launchtemplate-instancerequirements-acceleratormanufacturers
//
AcceleratorManufacturers *[]*string `field:"optional" json:"acceleratorManufacturers" yaml:"acceleratorManufacturers"`
// The accelerators that must be on the instance type.
//
// - For instance types with NVIDIA A10G GPUs, specify `a10g` .
// - For instance types with NVIDIA A100 GPUs, specify `a100` .
// - For instance types with NVIDIA H100 GPUs, specify `h100` .
// - For instance types with AWS Inferentia chips, specify `inferentia` .
// - For instance types with NVIDIA GRID K520 GPUs, specify `k520` .
// - For instance types with NVIDIA K80 GPUs, specify `k80` .
// - For instance types with NVIDIA M60 GPUs, specify `m60` .
// - For instance types with AMD Radeon Pro V520 GPUs, specify `radeon-pro-v520` .
// - For instance types with NVIDIA T4 GPUs, specify `t4` .
// - For instance types with NVIDIA T4G GPUs, specify `t4g` .
// - For instance types with Xilinx VU9P FPGAs, specify `vu9p` .
// - For instance types with NVIDIA V100 GPUs, specify `v100` .
//
// Default: Any accelerator.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-instancerequirements.html#cfn-ec2-launchtemplate-instancerequirements-acceleratornames
//
AcceleratorNames *[]*string `field:"optional" json:"acceleratorNames" yaml:"acceleratorNames"`
// The minimum and maximum amount of total accelerator memory, in MiB.
//
// Default: No minimum or maximum limits.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-instancerequirements.html#cfn-ec2-launchtemplate-instancerequirements-acceleratortotalmemorymib
//
AcceleratorTotalMemoryMiB interface{} `field:"optional" json:"acceleratorTotalMemoryMiB" yaml:"acceleratorTotalMemoryMiB"`
// The accelerator types that must be on the instance type.
//
// - For instance types with GPU accelerators, specify `gpu` .
// - For instance types with FPGA accelerators, specify `fpga` .
// - For instance types with inference accelerators, specify `inference` .
//
// Default: Any accelerator type.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-instancerequirements.html#cfn-ec2-launchtemplate-instancerequirements-acceleratortypes
//
AcceleratorTypes *[]*string `field:"optional" json:"acceleratorTypes" yaml:"acceleratorTypes"`
// The instance types to apply your specified attributes against.
//
// All other instance types are ignored, even if they match your specified attributes.
//
// You can use strings with one or more wild cards, represented by an asterisk ( `*` ), to allow an instance type, size, or generation. The following are examples: `m5.8xlarge` , `c5*.*` , `m5a.*` , `r*` , `*3*` .
//
// For example, if you specify `c5*` ,Amazon EC2 will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specify `m5a.*` , Amazon EC2 will allow all the M5a instance types, but not the M5n instance types.
//
// > If you specify `AllowedInstanceTypes` , you can't specify `ExcludedInstanceTypes` .
//
// Default: All instance types.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-instancerequirements.html#cfn-ec2-launchtemplate-instancerequirements-allowedinstancetypes
//
AllowedInstanceTypes *[]*string `field:"optional" json:"allowedInstanceTypes" yaml:"allowedInstanceTypes"`
// Indicates whether bare metal instance types must be included, excluded, or required.
//
// - To include bare metal instance types, specify `included` .
// - To require only bare metal instance types, specify `required` .
// - To exclude bare metal instance types, specify `excluded` .
//
// Default: `excluded`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-instancerequirements.html#cfn-ec2-launchtemplate-instancerequirements-baremetal
//
BareMetal *string `field:"optional" json:"bareMetal" yaml:"bareMetal"`
// The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps.
//
// For more information, see [Amazon EBS–optimized instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) in the *Amazon EC2 User Guide* .
//
// Default: No minimum or maximum limits.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-instancerequirements.html#cfn-ec2-launchtemplate-instancerequirements-baselineebsbandwidthmbps
//
BaselineEbsBandwidthMbps interface{} `field:"optional" json:"baselineEbsBandwidthMbps" yaml:"baselineEbsBandwidthMbps"`
// Indicates whether burstable performance T instance types are included, excluded, or required.
//
// For more information, see [Burstable performance instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html) .
//
// - To include burstable performance instance types, specify `included` .
// - To require only burstable performance instance types, specify `required` .
// - To exclude burstable performance instance types, specify `excluded` .
//
// Default: `excluded`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-instancerequirements.html#cfn-ec2-launchtemplate-instancerequirements-burstableperformance
//
BurstablePerformance *string `field:"optional" json:"burstablePerformance" yaml:"burstablePerformance"`
// The CPU manufacturers to include.
//
// - For instance types with Intel CPUs, specify `intel` .
// - For instance types with AMD CPUs, specify `amd` .
// - For instance types with AWS CPUs, specify `amazon-web-services` .
//
// > Don't confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template.
//
// Default: Any manufacturer.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-instancerequirements.html#cfn-ec2-launchtemplate-instancerequirements-cpumanufacturers
//
CpuManufacturers *[]*string `field:"optional" json:"cpuManufacturers" yaml:"cpuManufacturers"`
// The instance types to exclude.
//
// You can use strings with one or more wild cards, represented by an asterisk ( `*` ), to exclude an instance type, size, or generation. The following are examples: `m5.8xlarge` , `c5*.*` , `m5a.*` , `r*` , `*3*` .
//
// For example, if you specify `c5*` ,Amazon EC2 will exclude the entire C5 instance family, which includes all C5a and C5n instance types. If you specify `m5a.*` , Amazon EC2 will exclude all the M5a instance types, but not the M5n instance types.
//
// > If you specify `ExcludedInstanceTypes` , you can't specify `AllowedInstanceTypes` .
//
// Default: No excluded instance types.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-instancerequirements.html#cfn-ec2-launchtemplate-instancerequirements-excludedinstancetypes
//
ExcludedInstanceTypes *[]*string `field:"optional" json:"excludedInstanceTypes" yaml:"excludedInstanceTypes"`
// Indicates whether current or previous generation instance types are included.
//
// The current generation instance types are recommended for use. Current generation instance types are typically the latest two to three generations in each instance family. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide* .
//
// For current generation instance types, specify `current` .
//
// For previous generation instance types, specify `previous` .
//
// Default: Current and previous generation instance types.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-instancerequirements.html#cfn-ec2-launchtemplate-instancerequirements-instancegenerations
//
InstanceGenerations *[]*string `field:"optional" json:"instanceGenerations" yaml:"instanceGenerations"`
// Indicates whether instance types with instance store volumes are included, excluded, or required.
//
// For more information, [Amazon EC2 instance store](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html) in the *Amazon EC2 User Guide* .
//
// - To include instance types with instance store volumes, specify `included` .
// - To require only instance types with instance store volumes, specify `required` .
// - To exclude instance types with instance store volumes, specify `excluded` .
//
// Default: `included`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-instancerequirements.html#cfn-ec2-launchtemplate-instancerequirements-localstorage
//
LocalStorage *string `field:"optional" json:"localStorage" yaml:"localStorage"`
// The type of local storage that is required.
//
// - For instance types with hard disk drive (HDD) storage, specify `hdd` .
// - For instance types with solid state drive (SSD) storage, specify `ssd` .
//
// Default: `hdd` and `ssd`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-instancerequirements.html#cfn-ec2-launchtemplate-instancerequirements-localstoragetypes
//
LocalStorageTypes *[]*string `field:"optional" json:"localStorageTypes" yaml:"localStorageTypes"`
// [Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price.
//
// The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold.
//
// The parameter accepts an integer, which Amazon EC2 interprets as a percentage.
//
// If you set `TargetCapacityUnitType` to `vcpu` or `memory-mib` , the price protection threshold is based on the per vCPU or per memory price instead of the per instance price.
//
// > Only one of `SpotMaxPricePercentageOverLowestPrice` or `MaxSpotPriceAsPercentageOfOptimalOnDemandPrice` can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as `999999` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-instancerequirements.html#cfn-ec2-launchtemplate-instancerequirements-maxspotpriceaspercentageofoptimalondemandprice
//
MaxSpotPriceAsPercentageOfOptimalOnDemandPrice *float64 `field:"optional" json:"maxSpotPriceAsPercentageOfOptimalOnDemandPrice" yaml:"maxSpotPriceAsPercentageOfOptimalOnDemandPrice"`
// The minimum and maximum amount of memory per vCPU, in GiB.
//
// Default: No minimum or maximum limits.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-instancerequirements.html#cfn-ec2-launchtemplate-instancerequirements-memorygibpervcpu
//
MemoryGiBPerVCpu interface{} `field:"optional" json:"memoryGiBPerVCpu" yaml:"memoryGiBPerVCpu"`
// The minimum and maximum amount of memory, in MiB.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-instancerequirements.html#cfn-ec2-launchtemplate-instancerequirements-memorymib
//
MemoryMiB interface{} `field:"optional" json:"memoryMiB" yaml:"memoryMiB"`
// The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).
//
// Default: No minimum or maximum limits.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-instancerequirements.html#cfn-ec2-launchtemplate-instancerequirements-networkbandwidthgbps
//
NetworkBandwidthGbps interface{} `field:"optional" json:"networkBandwidthGbps" yaml:"networkBandwidthGbps"`
// The minimum and maximum number of network interfaces.
//
// Default: No minimum or maximum limits.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-instancerequirements.html#cfn-ec2-launchtemplate-instancerequirements-networkinterfacecount
//
NetworkInterfaceCount interface{} `field:"optional" json:"networkInterfaceCount" yaml:"networkInterfaceCount"`
// [Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price.
//
// The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold.
//
// The parameter accepts an integer, which Amazon EC2 interprets as a percentage.
//
// To turn off price protection, specify a high value, such as `999999` .
//
// This parameter is not supported for [GetSpotPlacementScores](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html) and [GetInstanceTypesFromInstanceRequirements](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceTypesFromInstanceRequirements.html) .
//
// > If you set `TargetCapacityUnitType` to `vcpu` or `memory-mib` , the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.
//
// Default: `20`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-instancerequirements.html#cfn-ec2-launchtemplate-instancerequirements-ondemandmaxpricepercentageoverlowestprice
//
OnDemandMaxPricePercentageOverLowestPrice *float64 `field:"optional" json:"onDemandMaxPricePercentageOverLowestPrice" yaml:"onDemandMaxPricePercentageOverLowestPrice"`
// Indicates whether instance types must support hibernation for On-Demand Instances.
//
// This parameter is not supported for [GetSpotPlacementScores](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html) .
//
// Default: `false`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-instancerequirements.html#cfn-ec2-launchtemplate-instancerequirements-requirehibernatesupport
//
RequireHibernateSupport interface{} `field:"optional" json:"requireHibernateSupport" yaml:"requireHibernateSupport"`
// [Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price.
//
// The identified Spot price is the Spot price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified Spot price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose Spot price exceeds your specified threshold.
//
// The parameter accepts an integer, which Amazon EC2 interprets as a percentage.
//
// If you set `TargetCapacityUnitType` to `vcpu` or `memory-mib` , the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.
//
// This parameter is not supported for [GetSpotPlacementScores](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html) and [GetInstanceTypesFromInstanceRequirements](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceTypesFromInstanceRequirements.html) .
//
// > Only one of `SpotMaxPricePercentageOverLowestPrice` or `MaxSpotPriceAsPercentageOfOptimalOnDemandPrice` can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as `999999` .
//
// Default: `100`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-instancerequirements.html#cfn-ec2-launchtemplate-instancerequirements-spotmaxpricepercentageoverlowestprice
//
SpotMaxPricePercentageOverLowestPrice *float64 `field:"optional" json:"spotMaxPricePercentageOverLowestPrice" yaml:"spotMaxPricePercentageOverLowestPrice"`
// The minimum and maximum amount of total local storage, in GB.
//
// Default: No minimum or maximum limits.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-instancerequirements.html#cfn-ec2-launchtemplate-instancerequirements-totallocalstoragegb
//
TotalLocalStorageGb interface{} `field:"optional" json:"totalLocalStorageGb" yaml:"totalLocalStorageGb"`
// The minimum and maximum number of vCPUs.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-instancerequirements.html#cfn-ec2-launchtemplate-instancerequirements-vcpucount
//
VCpuCount interface{} `field:"optional" json:"vCpuCount" yaml:"vCpuCount"`
}
The attributes for the instance types.
When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.
You must specify `VCpuCount` and `MemoryMiB` . All other attributes are optional. Any unspecified optional attribute is set to its default.
When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values.
To limit the list of instance types from which Amazon EC2 can identify matching instance types, you can use one of the following parameters, but not both in the same request:
- `AllowedInstanceTypes` - The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes. - `ExcludedInstanceTypes` - The instance types to exclude from the list, even if they match your specified attributes.
> If you specify `InstanceRequirements` , you can't specify `InstanceType` . > > Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the [launch instance wizard](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-instance-wizard.html) , or with the [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) API or [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) AWS CloudFormation resource, you can't specify `InstanceRequirements` .
For more information, see [Attribute-based instance type selection for EC2 Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html) , [Attribute-based instance type selection for Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-attribute-based-instance-type-selection.html) , and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User 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"
instanceRequirementsProperty := &InstanceRequirementsProperty{
AcceleratorCount: &AcceleratorCountProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
AcceleratorManufacturers: []*string{
jsii.String("acceleratorManufacturers"),
},
AcceleratorNames: []*string{
jsii.String("acceleratorNames"),
},
AcceleratorTotalMemoryMiB: &AcceleratorTotalMemoryMiBProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
AcceleratorTypes: []*string{
jsii.String("acceleratorTypes"),
},
AllowedInstanceTypes: []*string{
jsii.String("allowedInstanceTypes"),
},
BareMetal: jsii.String("bareMetal"),
BaselineEbsBandwidthMbps: &BaselineEbsBandwidthMbpsProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
BurstablePerformance: jsii.String("burstablePerformance"),
CpuManufacturers: []*string{
jsii.String("cpuManufacturers"),
},
ExcludedInstanceTypes: []*string{
jsii.String("excludedInstanceTypes"),
},
InstanceGenerations: []*string{
jsii.String("instanceGenerations"),
},
LocalStorage: jsii.String("localStorage"),
LocalStorageTypes: []*string{
jsii.String("localStorageTypes"),
},
MaxSpotPriceAsPercentageOfOptimalOnDemandPrice: jsii.Number(123),
MemoryGiBPerVCpu: &MemoryGiBPerVCpuProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
MemoryMiB: &MemoryMiBProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
NetworkBandwidthGbps: &NetworkBandwidthGbpsProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
NetworkInterfaceCount: &NetworkInterfaceCountProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
OnDemandMaxPricePercentageOverLowestPrice: jsii.Number(123),
RequireHibernateSupport: jsii.Boolean(false),
SpotMaxPricePercentageOverLowestPrice: jsii.Number(123),
TotalLocalStorageGb: &TotalLocalStorageGBProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
VCpuCount: &VCpuCountProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
}
type CfnLaunchTemplate_Ipv4PrefixSpecificationProperty ¶ added in v2.18.0
type CfnLaunchTemplate_Ipv4PrefixSpecificationProperty struct {
// The IPv4 prefix.
//
// For information, see [Assigning prefixes to network interfaces](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-prefix-eni.html) in the *Amazon EC2 User Guide* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-ipv4prefixspecification.html#cfn-ec2-launchtemplate-ipv4prefixspecification-ipv4prefix
//
Ipv4Prefix *string `field:"optional" json:"ipv4Prefix" yaml:"ipv4Prefix"`
}
Specifies an IPv4 prefix for a network interface.
`Ipv4PrefixSpecification` is a property of [AWS::EC2::LaunchTemplate NetworkInterface](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.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"
ipv4PrefixSpecificationProperty := &Ipv4PrefixSpecificationProperty{
Ipv4Prefix: jsii.String("ipv4Prefix"),
}
type CfnLaunchTemplate_Ipv6AddProperty ¶
type CfnLaunchTemplate_Ipv6AddProperty struct {
// One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet.
//
// You can't use this option if you're specifying a number of IPv6 addresses.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-ipv6add.html#cfn-ec2-launchtemplate-ipv6add-ipv6address
//
Ipv6Address *string `field:"optional" json:"ipv6Address" yaml:"ipv6Address"`
}
Specifies an IPv6 address in an Amazon EC2 launch template.
`Ipv6Add` is a property of [AWS::EC2::LaunchTemplate NetworkInterface](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.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"
ipv6AddProperty := &Ipv6AddProperty{
Ipv6Address: jsii.String("ipv6Address"),
}
type CfnLaunchTemplate_Ipv6PrefixSpecificationProperty ¶ added in v2.18.0
type CfnLaunchTemplate_Ipv6PrefixSpecificationProperty struct {
// The IPv6 prefix.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-ipv6prefixspecification.html#cfn-ec2-launchtemplate-ipv6prefixspecification-ipv6prefix
//
Ipv6Prefix *string `field:"optional" json:"ipv6Prefix" yaml:"ipv6Prefix"`
}
Specifies an IPv6 prefix for a network interface.
`Ipv6PrefixSpecification` is a property of [AWS::EC2::LaunchTemplate NetworkInterface](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.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"
ipv6PrefixSpecificationProperty := &Ipv6PrefixSpecificationProperty{
Ipv6Prefix: jsii.String("ipv6Prefix"),
}
type CfnLaunchTemplate_LaunchTemplateDataProperty ¶
type CfnLaunchTemplate_LaunchTemplateDataProperty struct {
// The block device mapping.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-blockdevicemappings
//
BlockDeviceMappings interface{} `field:"optional" json:"blockDeviceMappings" yaml:"blockDeviceMappings"`
// The Capacity Reservation targeting option.
//
// If you do not specify this parameter, the instance's Capacity Reservation preference defaults to `open` , which enables it to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-capacityreservationspecification
//
CapacityReservationSpecification interface{} `field:"optional" json:"capacityReservationSpecification" yaml:"capacityReservationSpecification"`
// The CPU options for the instance.
//
// For more information, see [Optimize CPU options](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html) in the *Amazon EC2 User Guide* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-cpuoptions
//
CpuOptions interface{} `field:"optional" json:"cpuOptions" yaml:"cpuOptions"`
// The credit option for CPU usage of the instance.
//
// Valid only for T instances.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-creditspecification
//
CreditSpecification interface{} `field:"optional" json:"creditSpecification" yaml:"creditSpecification"`
// Indicates whether to enable the instance for stop protection.
//
// For more information, see [Enable stop protection for your instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-stop-protection.html) in the *Amazon EC2 User Guide* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-disableapistop
//
DisableApiStop interface{} `field:"optional" json:"disableApiStop" yaml:"disableApiStop"`
// If you set this parameter to `true` , you can't terminate the instance using the Amazon EC2 console, CLI, or API;
//
// otherwise, you can. To change this attribute after launch, use [ModifyInstanceAttribute](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyInstanceAttribute.html) . Alternatively, if you set `InstanceInitiatedShutdownBehavior` to `terminate` , you can terminate the instance by running the shutdown command from the instance.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-disableapitermination
//
DisableApiTermination interface{} `field:"optional" json:"disableApiTermination" yaml:"disableApiTermination"`
// Indicates whether the instance is optimized for Amazon EBS I/O.
//
// This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-ebsoptimized
//
EbsOptimized interface{} `field:"optional" json:"ebsOptimized" yaml:"ebsOptimized"`
// Deprecated.
//
// > Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, G4dn, or G5 instances.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-elasticgpuspecifications
//
ElasticGpuSpecifications interface{} `field:"optional" json:"elasticGpuSpecifications" yaml:"elasticGpuSpecifications"`
// An elastic inference accelerator to associate with the instance.
//
// Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads.
//
// You cannot specify accelerators from different generations in the same request.
//
// > Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-elasticinferenceaccelerators
//
ElasticInferenceAccelerators interface{} `field:"optional" json:"elasticInferenceAccelerators" yaml:"elasticInferenceAccelerators"`
// Indicates whether the instance is enabled for AWS Nitro Enclaves.
//
// For more information, see [What is AWS Nitro Enclaves?](https://docs.aws.amazon.com/enclaves/latest/user/nitro-enclave.html) in the *AWS Nitro Enclaves User Guide* .
//
// You can't enable AWS Nitro Enclaves and hibernation on the same instance.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-enclaveoptions
//
EnclaveOptions interface{} `field:"optional" json:"enclaveOptions" yaml:"enclaveOptions"`
// Indicates whether an instance is enabled for hibernation.
//
// This parameter is valid only if the instance meets the [hibernation prerequisites](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/hibernating-prerequisites.html) . For more information, see [Hibernate your Amazon EC2 instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html) in the *Amazon EC2 User Guide* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-hibernationoptions
//
HibernationOptions interface{} `field:"optional" json:"hibernationOptions" yaml:"hibernationOptions"`
// The name or Amazon Resource Name (ARN) of an IAM instance profile.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-iaminstanceprofile
//
IamInstanceProfile interface{} `field:"optional" json:"iamInstanceProfile" yaml:"iamInstanceProfile"`
// The ID of the AMI.
//
// Alternatively, you can specify a Systems Manager parameter, which will resolve to an AMI ID on launch.
//
// Valid formats:
//
// - `ami-0ac394d6a3example`
// - `resolve:ssm:parameter-name`
// - `resolve:ssm:parameter-name:version-number`
// - `resolve:ssm:parameter-name:label`
//
// For more information, see [Use a Systems Manager parameter to find an AMI](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html#using-systems-manager-parameter-to-find-AMI) in the *Amazon Elastic Compute Cloud User Guide* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-imageid
//
ImageId *string `field:"optional" json:"imageId" yaml:"imageId"`
// Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
//
// Default: `stop`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-instanceinitiatedshutdownbehavior
//
InstanceInitiatedShutdownBehavior *string `field:"optional" json:"instanceInitiatedShutdownBehavior" yaml:"instanceInitiatedShutdownBehavior"`
// The market (purchasing) option for the instances.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-instancemarketoptions
//
InstanceMarketOptions interface{} `field:"optional" json:"instanceMarketOptions" yaml:"instanceMarketOptions"`
// The attributes for the instance types.
//
// When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.
//
// You must specify `VCpuCount` and `MemoryMiB` . All other attributes are optional. Any unspecified optional attribute is set to its default.
//
// When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values.
//
// To limit the list of instance types from which Amazon EC2 can identify matching instance types, you can use one of the following parameters, but not both in the same request:
//
// - `AllowedInstanceTypes` - The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes.
// - `ExcludedInstanceTypes` - The instance types to exclude from the list, even if they match your specified attributes.
//
// > If you specify `InstanceRequirements` , you can't specify `InstanceType` .
// >
// > Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the [launch instance wizard](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-instance-wizard.html) , or with the [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) API or [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) AWS CloudFormation resource, you can't specify `InstanceRequirements` .
//
// For more information, see [Attribute-based instance type selection for EC2 Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html) , [Attribute-based instance type selection for Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-attribute-based-instance-type-selection.html) , and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-instancerequirements
//
InstanceRequirements interface{} `field:"optional" json:"instanceRequirements" yaml:"instanceRequirements"`
// The instance type. For more information, see [Amazon EC2 instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide* .
//
// If you specify `InstanceType` , you can't specify `InstanceRequirements` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-instancetype
//
InstanceType *string `field:"optional" json:"instanceType" yaml:"instanceType"`
// The ID of the kernel.
//
// We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see [User Provided Kernels](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html) in the *Amazon EC2 User Guide* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-kernelid
//
KernelId *string `field:"optional" json:"kernelId" yaml:"kernelId"`
// The name of the key pair. You can create a key pair using [CreateKeyPair](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateKeyPair.html) or [ImportKeyPair](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportKeyPair.html) .
//
// > If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-keyname
//
KeyName *string `field:"optional" json:"keyName" yaml:"keyName"`
// The license configurations.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-licensespecifications
//
LicenseSpecifications interface{} `field:"optional" json:"licenseSpecifications" yaml:"licenseSpecifications"`
// The maintenance options of your instance.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-maintenanceoptions
//
MaintenanceOptions interface{} `field:"optional" json:"maintenanceOptions" yaml:"maintenanceOptions"`
// The metadata options for the instance.
//
// For more information, see [Instance metadata and user data](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) in the *Amazon EC2 User Guide* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-metadataoptions
//
MetadataOptions interface{} `field:"optional" json:"metadataOptions" yaml:"metadataOptions"`
// The monitoring for the instance.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-monitoring
//
Monitoring interface{} `field:"optional" json:"monitoring" yaml:"monitoring"`
// The network interfaces for the instance.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-networkinterfaces
//
NetworkInterfaces interface{} `field:"optional" json:"networkInterfaces" yaml:"networkInterfaces"`
// The placement for the instance.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-placement
//
Placement interface{} `field:"optional" json:"placement" yaml:"placement"`
// The hostname type for EC2 instances launched into this subnet and how DNS A and AAAA record queries should be handled.
//
// For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *Amazon Elastic Compute Cloud User Guide* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-privatednsnameoptions
//
PrivateDnsNameOptions interface{} `field:"optional" json:"privateDnsNameOptions" yaml:"privateDnsNameOptions"`
// The ID of the RAM disk.
//
// > We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see [User provided kernels](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html) in the *Amazon EC2 User Guide* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-ramdiskid
//
RamDiskId *string `field:"optional" json:"ramDiskId" yaml:"ramDiskId"`
// The IDs of the security groups.
//
// You can specify the IDs of existing security groups and references to resources created by the stack template.
//
// If you specify a network interface, you must specify any security groups as part of the network interface instead.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-securitygroupids
//
SecurityGroupIds *[]*string `field:"optional" json:"securityGroupIds" yaml:"securityGroupIds"`
// The names of the security groups. For a nondefault VPC, you must use security group IDs instead.
//
// If you specify a network interface, you must specify any security groups as part of the network interface instead of using this parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-securitygroups
//
SecurityGroups *[]*string `field:"optional" json:"securityGroups" yaml:"securityGroups"`
// The tags to apply to resources that are created during instance launch.
//
// To tag the launch template itself, use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-tagspecifications) .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications
//
TagSpecifications interface{} `field:"optional" json:"tagSpecifications" yaml:"tagSpecifications"`
// The user data to make available to the instance.
//
// You must provide base64-encoded text. User data is limited to 16 KB. For more information, see [Run commands on your Amazon EC2 instance at launch](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/user-data.html) in the *Amazon EC2 User Guide* .
//
// If you are creating the launch template for use with AWS Batch , the user data must be provided in the [MIME multi-part archive format](https://docs.aws.amazon.com/https://cloudinit.readthedocs.io/en/latest/topics/format.html#mime-multi-part-archive) . For more information, see [Amazon EC2 user data in launch templates](https://docs.aws.amazon.com/batch/latest/userguide/launch-templates.html) in the *AWS Batch User Guide* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-userdata
//
UserData *string `field:"optional" json:"userData" yaml:"userData"`
}
The information to include in the launch template.
> You must specify at least one parameter for the launch template data.
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"
launchTemplateDataProperty := &LaunchTemplateDataProperty{
BlockDeviceMappings: []interface{}{
&BlockDeviceMappingProperty{
DeviceName: jsii.String("deviceName"),
Ebs: &EbsProperty{
DeleteOnTermination: jsii.Boolean(false),
Encrypted: jsii.Boolean(false),
Iops: jsii.Number(123),
KmsKeyId: jsii.String("kmsKeyId"),
SnapshotId: jsii.String("snapshotId"),
Throughput: jsii.Number(123),
VolumeSize: jsii.Number(123),
VolumeType: jsii.String("volumeType"),
},
NoDevice: jsii.String("noDevice"),
VirtualName: jsii.String("virtualName"),
},
},
CapacityReservationSpecification: &CapacityReservationSpecificationProperty{
CapacityReservationPreference: jsii.String("capacityReservationPreference"),
CapacityReservationTarget: &CapacityReservationTargetProperty{
CapacityReservationId: jsii.String("capacityReservationId"),
CapacityReservationResourceGroupArn: jsii.String("capacityReservationResourceGroupArn"),
},
},
CpuOptions: &CpuOptionsProperty{
AmdSevSnp: jsii.String("amdSevSnp"),
CoreCount: jsii.Number(123),
ThreadsPerCore: jsii.Number(123),
},
CreditSpecification: &CreditSpecificationProperty{
CpuCredits: jsii.String("cpuCredits"),
},
DisableApiStop: jsii.Boolean(false),
DisableApiTermination: jsii.Boolean(false),
EbsOptimized: jsii.Boolean(false),
ElasticGpuSpecifications: []interface{}{
&ElasticGpuSpecificationProperty{
Type: jsii.String("type"),
},
},
ElasticInferenceAccelerators: []interface{}{
&LaunchTemplateElasticInferenceAcceleratorProperty{
Count: jsii.Number(123),
Type: jsii.String("type"),
},
},
EnclaveOptions: &EnclaveOptionsProperty{
Enabled: jsii.Boolean(false),
},
HibernationOptions: &HibernationOptionsProperty{
Configured: jsii.Boolean(false),
},
IamInstanceProfile: &IamInstanceProfileProperty{
Arn: jsii.String("arn"),
Name: jsii.String("name"),
},
ImageId: jsii.String("imageId"),
InstanceInitiatedShutdownBehavior: jsii.String("instanceInitiatedShutdownBehavior"),
InstanceMarketOptions: &InstanceMarketOptionsProperty{
MarketType: jsii.String("marketType"),
SpotOptions: &SpotOptionsProperty{
BlockDurationMinutes: jsii.Number(123),
InstanceInterruptionBehavior: jsii.String("instanceInterruptionBehavior"),
MaxPrice: jsii.String("maxPrice"),
SpotInstanceType: jsii.String("spotInstanceType"),
ValidUntil: jsii.String("validUntil"),
},
},
InstanceRequirements: &InstanceRequirementsProperty{
AcceleratorCount: &AcceleratorCountProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
AcceleratorManufacturers: []*string{
jsii.String("acceleratorManufacturers"),
},
AcceleratorNames: []*string{
jsii.String("acceleratorNames"),
},
AcceleratorTotalMemoryMiB: &AcceleratorTotalMemoryMiBProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
AcceleratorTypes: []*string{
jsii.String("acceleratorTypes"),
},
AllowedInstanceTypes: []*string{
jsii.String("allowedInstanceTypes"),
},
BareMetal: jsii.String("bareMetal"),
BaselineEbsBandwidthMbps: &BaselineEbsBandwidthMbpsProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
BurstablePerformance: jsii.String("burstablePerformance"),
CpuManufacturers: []*string{
jsii.String("cpuManufacturers"),
},
ExcludedInstanceTypes: []*string{
jsii.String("excludedInstanceTypes"),
},
InstanceGenerations: []*string{
jsii.String("instanceGenerations"),
},
LocalStorage: jsii.String("localStorage"),
LocalStorageTypes: []*string{
jsii.String("localStorageTypes"),
},
MaxSpotPriceAsPercentageOfOptimalOnDemandPrice: jsii.Number(123),
MemoryGiBPerVCpu: &MemoryGiBPerVCpuProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
MemoryMiB: &MemoryMiBProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
NetworkBandwidthGbps: &NetworkBandwidthGbpsProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
NetworkInterfaceCount: &NetworkInterfaceCountProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
OnDemandMaxPricePercentageOverLowestPrice: jsii.Number(123),
RequireHibernateSupport: jsii.Boolean(false),
SpotMaxPricePercentageOverLowestPrice: jsii.Number(123),
TotalLocalStorageGb: &TotalLocalStorageGBProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
VCpuCount: &VCpuCountProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
},
InstanceType: jsii.String("instanceType"),
KernelId: jsii.String("kernelId"),
KeyName: jsii.String("keyName"),
LicenseSpecifications: []interface{}{
&LicenseSpecificationProperty{
LicenseConfigurationArn: jsii.String("licenseConfigurationArn"),
},
},
MaintenanceOptions: &MaintenanceOptionsProperty{
AutoRecovery: jsii.String("autoRecovery"),
},
MetadataOptions: &MetadataOptionsProperty{
HttpEndpoint: jsii.String("httpEndpoint"),
HttpProtocolIpv6: jsii.String("httpProtocolIpv6"),
HttpPutResponseHopLimit: jsii.Number(123),
HttpTokens: jsii.String("httpTokens"),
InstanceMetadataTags: jsii.String("instanceMetadataTags"),
},
Monitoring: &MonitoringProperty{
Enabled: jsii.Boolean(false),
},
NetworkInterfaces: []interface{}{
&NetworkInterfaceProperty{
AssociateCarrierIpAddress: jsii.Boolean(false),
AssociatePublicIpAddress: jsii.Boolean(false),
ConnectionTrackingSpecification: &ConnectionTrackingSpecificationProperty{
TcpEstablishedTimeout: jsii.Number(123),
UdpStreamTimeout: jsii.Number(123),
UdpTimeout: jsii.Number(123),
},
DeleteOnTermination: jsii.Boolean(false),
Description: jsii.String("description"),
DeviceIndex: jsii.Number(123),
EnaSrdSpecification: &EnaSrdSpecificationProperty{
EnaSrdEnabled: jsii.Boolean(false),
EnaSrdUdpSpecification: &EnaSrdUdpSpecificationProperty{
EnaSrdUdpEnabled: jsii.Boolean(false),
},
},
Groups: []*string{
jsii.String("groups"),
},
InterfaceType: jsii.String("interfaceType"),
Ipv4PrefixCount: jsii.Number(123),
Ipv4Prefixes: []interface{}{
&Ipv4PrefixSpecificationProperty{
Ipv4Prefix: jsii.String("ipv4Prefix"),
},
},
Ipv6AddressCount: jsii.Number(123),
Ipv6Addresses: []interface{}{
&Ipv6AddProperty{
Ipv6Address: jsii.String("ipv6Address"),
},
},
Ipv6PrefixCount: jsii.Number(123),
Ipv6Prefixes: []interface{}{
&Ipv6PrefixSpecificationProperty{
Ipv6Prefix: jsii.String("ipv6Prefix"),
},
},
NetworkCardIndex: jsii.Number(123),
NetworkInterfaceId: jsii.String("networkInterfaceId"),
PrimaryIpv6: jsii.Boolean(false),
PrivateIpAddress: jsii.String("privateIpAddress"),
PrivateIpAddresses: []interface{}{
&PrivateIpAddProperty{
Primary: jsii.Boolean(false),
PrivateIpAddress: jsii.String("privateIpAddress"),
},
},
SecondaryPrivateIpAddressCount: jsii.Number(123),
SubnetId: jsii.String("subnetId"),
},
},
Placement: &PlacementProperty{
Affinity: jsii.String("affinity"),
AvailabilityZone: jsii.String("availabilityZone"),
GroupId: jsii.String("groupId"),
GroupName: jsii.String("groupName"),
HostId: jsii.String("hostId"),
HostResourceGroupArn: jsii.String("hostResourceGroupArn"),
PartitionNumber: jsii.Number(123),
SpreadDomain: jsii.String("spreadDomain"),
Tenancy: jsii.String("tenancy"),
},
PrivateDnsNameOptions: &PrivateDnsNameOptionsProperty{
EnableResourceNameDnsAaaaRecord: jsii.Boolean(false),
EnableResourceNameDnsARecord: jsii.Boolean(false),
HostnameType: jsii.String("hostnameType"),
},
RamDiskId: jsii.String("ramDiskId"),
SecurityGroupIds: []*string{
jsii.String("securityGroupIds"),
},
SecurityGroups: []*string{
jsii.String("securityGroups"),
},
TagSpecifications: []interface{}{
&TagSpecificationProperty{
ResourceType: jsii.String("resourceType"),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
},
},
UserData: jsii.String("userData"),
}
type CfnLaunchTemplate_LaunchTemplateElasticInferenceAcceleratorProperty ¶
type CfnLaunchTemplate_LaunchTemplateElasticInferenceAcceleratorProperty struct {
// The number of elastic inference accelerators to attach to the instance.
//
// Default: 1.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplateelasticinferenceaccelerator.html#cfn-ec2-launchtemplate-launchtemplateelasticinferenceaccelerator-count
//
Count *float64 `field:"optional" json:"count" yaml:"count"`
// The type of elastic inference accelerator.
//
// The possible values are eia1.medium, eia1.large, and eia1.xlarge.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplateelasticinferenceaccelerator.html#cfn-ec2-launchtemplate-launchtemplateelasticinferenceaccelerator-type
//
Type *string `field:"optional" json:"type" yaml:"type"`
}
Specifies an elastic inference accelerator.
`LaunchTemplateElasticInferenceAccelerator` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.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"
launchTemplateElasticInferenceAcceleratorProperty := &LaunchTemplateElasticInferenceAcceleratorProperty{
Count: jsii.Number(123),
Type: jsii.String("type"),
}
type CfnLaunchTemplate_LaunchTemplateTagSpecificationProperty ¶
type CfnLaunchTemplate_LaunchTemplateTagSpecificationProperty struct {
// The type of resource.
//
// To tag a launch template, `ResourceType` must be `launch-template` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatetagspecification.html#cfn-ec2-launchtemplate-launchtemplatetagspecification-resourcetype
//
ResourceType *string `field:"optional" json:"resourceType" yaml:"resourceType"`
// The tags for the resource.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatetagspecification.html#cfn-ec2-launchtemplate-launchtemplatetagspecification-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Specifies the tags to apply to the launch template during creation.
To specify the tags for the resources that are created during instance launch, use [AWS::EC2::LaunchTemplate TagSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-tagspecification.html) .
`LaunchTemplateTagSpecification` is a property of [AWS::EC2::LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.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"
launchTemplateTagSpecificationProperty := &LaunchTemplateTagSpecificationProperty{
ResourceType: jsii.String("resourceType"),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
type CfnLaunchTemplate_LicenseSpecificationProperty ¶
type CfnLaunchTemplate_LicenseSpecificationProperty struct {
// The Amazon Resource Name (ARN) of the license configuration.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-licensespecification.html#cfn-ec2-launchtemplate-licensespecification-licenseconfigurationarn
//
LicenseConfigurationArn *string `field:"optional" json:"licenseConfigurationArn" yaml:"licenseConfigurationArn"`
}
Specifies a license configuration for an instance.
`LicenseSpecification` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.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"
licenseSpecificationProperty := &LicenseSpecificationProperty{
LicenseConfigurationArn: jsii.String("licenseConfigurationArn"),
}
type CfnLaunchTemplate_MaintenanceOptionsProperty ¶ added in v2.21.0
type CfnLaunchTemplate_MaintenanceOptionsProperty struct {
// Disables the automatic recovery behavior of your instance or sets it to default.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-maintenanceoptions.html#cfn-ec2-launchtemplate-maintenanceoptions-autorecovery
//
AutoRecovery *string `field:"optional" json:"autoRecovery" yaml:"autoRecovery"`
}
The maintenance options of your 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"
maintenanceOptionsProperty := &MaintenanceOptionsProperty{
AutoRecovery: jsii.String("autoRecovery"),
}
type CfnLaunchTemplate_MemoryGiBPerVCpuProperty ¶
type CfnLaunchTemplate_MemoryGiBPerVCpuProperty struct {
// The maximum amount of memory per vCPU, in GiB.
//
// To specify no maximum limit, omit this parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-memorygibpervcpu.html#cfn-ec2-launchtemplate-memorygibpervcpu-max
//
Max *float64 `field:"optional" json:"max" yaml:"max"`
// The minimum amount of memory per vCPU, in GiB.
//
// To specify no minimum limit, omit this parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-memorygibpervcpu.html#cfn-ec2-launchtemplate-memorygibpervcpu-min
//
Min *float64 `field:"optional" json:"min" yaml:"min"`
}
The minimum and maximum amount of memory per vCPU, in GiB.
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"
memoryGiBPerVCpuProperty := &MemoryGiBPerVCpuProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
}
type CfnLaunchTemplate_MemoryMiBProperty ¶
type CfnLaunchTemplate_MemoryMiBProperty struct {
// The maximum amount of memory, in MiB.
//
// To specify no maximum limit, omit this parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-memorymib.html#cfn-ec2-launchtemplate-memorymib-max
//
Max *float64 `field:"optional" json:"max" yaml:"max"`
// The minimum amount of memory, in MiB.
//
// To specify no minimum limit, specify `0` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-memorymib.html#cfn-ec2-launchtemplate-memorymib-min
//
Min *float64 `field:"optional" json:"min" yaml:"min"`
}
The minimum and maximum amount of memory, in MiB.
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"
memoryMiBProperty := &MemoryMiBProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
}
type CfnLaunchTemplate_MetadataOptionsProperty ¶
type CfnLaunchTemplate_MetadataOptionsProperty struct {
// Enables or disables the HTTP metadata endpoint on your instances.
//
// If the parameter is not specified, the default state is `enabled` .
//
// > If you specify a value of `disabled` , you will not be able to access your instance metadata.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-metadataoptions.html#cfn-ec2-launchtemplate-metadataoptions-httpendpoint
//
HttpEndpoint *string `field:"optional" json:"httpEndpoint" yaml:"httpEndpoint"`
// Enables or disables the IPv6 endpoint for the instance metadata service.
//
// Default: `disabled`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-metadataoptions.html#cfn-ec2-launchtemplate-metadataoptions-httpprotocolipv6
//
HttpProtocolIpv6 *string `field:"optional" json:"httpProtocolIpv6" yaml:"httpProtocolIpv6"`
// The desired HTTP PUT response hop limit for instance metadata requests.
//
// The larger the number, the further instance metadata requests can travel.
//
// Default: `1`
//
// Possible values: Integers from 1 to 64.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-metadataoptions.html#cfn-ec2-launchtemplate-metadataoptions-httpputresponsehoplimit
//
HttpPutResponseHopLimit *float64 `field:"optional" json:"httpPutResponseHopLimit" yaml:"httpPutResponseHopLimit"`
// Indicates whether IMDSv2 is required.
//
// - `optional` - IMDSv2 is optional. You can choose whether to send a session token in your instance metadata retrieval requests. If you retrieve IAM role credentials without a session token, you receive the IMDSv1 role credentials. If you retrieve IAM role credentials using a valid session token, you receive the IMDSv2 role credentials.
// - `required` - IMDSv2 is required. You must send a session token in your instance metadata retrieval requests. With this option, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not available.
//
// Default: If the value of `ImdsSupport` for the Amazon Machine Image (AMI) for your instance is `v2.0` , the default is `required` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-metadataoptions.html#cfn-ec2-launchtemplate-metadataoptions-httptokens
//
HttpTokens *string `field:"optional" json:"httpTokens" yaml:"httpTokens"`
// Set to `enabled` to allow access to instance tags from the instance metadata.
//
// Set to `disabled` to turn off access to instance tags from the instance metadata. For more information, see [Work with instance tags using the instance metadata](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#work-with-tags-in-IMDS) .
//
// Default: `disabled`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-metadataoptions.html#cfn-ec2-launchtemplate-metadataoptions-instancemetadatatags
//
InstanceMetadataTags *string `field:"optional" json:"instanceMetadataTags" yaml:"instanceMetadataTags"`
}
The metadata options for the instance.
For more information, see [Instance metadata and user data](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) in the *Amazon EC2 User Guide* .
`MetadataOptions` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.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"
metadataOptionsProperty := &MetadataOptionsProperty{
HttpEndpoint: jsii.String("httpEndpoint"),
HttpProtocolIpv6: jsii.String("httpProtocolIpv6"),
HttpPutResponseHopLimit: jsii.Number(123),
HttpTokens: jsii.String("httpTokens"),
InstanceMetadataTags: jsii.String("instanceMetadataTags"),
}
type CfnLaunchTemplate_MonitoringProperty ¶
type CfnLaunchTemplate_MonitoringProperty struct {
// Specify `true` to enable detailed monitoring.
//
// Otherwise, basic monitoring is enabled.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-monitoring.html#cfn-ec2-launchtemplate-monitoring-enabled
//
Enabled interface{} `field:"optional" json:"enabled" yaml:"enabled"`
}
Specifies whether detailed monitoring is enabled for an instance.
For more information about detailed monitoring, see [Enable or turn off detailed monitoring for your instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-cloudwatch-new.html) in the *Amazon EC2 User Guide* .
`Monitoring` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.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"
monitoringProperty := &MonitoringProperty{
Enabled: jsii.Boolean(false),
}
type CfnLaunchTemplate_NetworkBandwidthGbpsProperty ¶ added in v2.51.0
type CfnLaunchTemplate_NetworkBandwidthGbpsProperty struct {
// The maximum amount of network bandwidth, in Gbps.
//
// To specify no maximum limit, omit this parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkbandwidthgbps.html#cfn-ec2-launchtemplate-networkbandwidthgbps-max
//
Max *float64 `field:"optional" json:"max" yaml:"max"`
// The minimum amount of network bandwidth, in Gbps.
//
// If this parameter is not specified, there is no minimum limit.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkbandwidthgbps.html#cfn-ec2-launchtemplate-networkbandwidthgbps-min
//
Min *float64 `field:"optional" json:"min" yaml:"min"`
}
The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).
> Setting the minimum bandwidth does not guarantee that your instance will achieve the minimum bandwidth. Amazon EC2 will identify instance types that support the specified minimum bandwidth, but the actual bandwidth of your instance might go below the specified minimum at times. For more information, see [Available instance bandwidth](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-network-bandwidth.html#available-instance-bandwidth) in the *Amazon EC2 User 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"
networkBandwidthGbpsProperty := &NetworkBandwidthGbpsProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
}
type CfnLaunchTemplate_NetworkInterfaceCountProperty ¶
type CfnLaunchTemplate_NetworkInterfaceCountProperty struct {
// The maximum number of network interfaces.
//
// To specify no maximum limit, omit this parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterfacecount.html#cfn-ec2-launchtemplate-networkinterfacecount-max
//
Max *float64 `field:"optional" json:"max" yaml:"max"`
// The minimum number of network interfaces.
//
// To specify no minimum limit, omit this parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterfacecount.html#cfn-ec2-launchtemplate-networkinterfacecount-min
//
Min *float64 `field:"optional" json:"min" yaml:"min"`
}
The minimum and maximum number of network interfaces.
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"
networkInterfaceCountProperty := &NetworkInterfaceCountProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
}
type CfnLaunchTemplate_NetworkInterfaceProperty ¶
type CfnLaunchTemplate_NetworkInterfaceProperty struct {
// Associates a Carrier IP address with eth0 for a new network interface.
//
// Use this option when you launch an instance in a Wavelength Zone and want to associate a Carrier IP address with the network interface. For more information about Carrier IP addresses, see [Carrier IP addresses](https://docs.aws.amazon.com/wavelength/latest/developerguide/how-wavelengths-work.html#provider-owned-ip) in the *AWS Wavelength Developer Guide* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-associatecarrieripaddress
//
AssociateCarrierIpAddress interface{} `field:"optional" json:"associateCarrierIpAddress" yaml:"associateCarrierIpAddress"`
// Associates a public IPv4 address with eth0 for a new network interface.
//
// AWS charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the *Public IPv4 Address* tab on the [Amazon VPC pricing page](https://docs.aws.amazon.com/vpc/pricing/) .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-associatepublicipaddress
//
AssociatePublicIpAddress interface{} `field:"optional" json:"associatePublicIpAddress" yaml:"associatePublicIpAddress"`
// A connection tracking specification for the network interface.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-connectiontrackingspecification
//
ConnectionTrackingSpecification interface{} `field:"optional" json:"connectionTrackingSpecification" yaml:"connectionTrackingSpecification"`
// Indicates whether the network interface is deleted when the instance is terminated.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-deleteontermination
//
DeleteOnTermination interface{} `field:"optional" json:"deleteOnTermination" yaml:"deleteOnTermination"`
// A description for the network interface.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// The device index for the network interface attachment.
//
// Each network interface requires a device index. If you create a launch template that includes secondary network interfaces but not a primary network interface, then you must add a primary network interface as a launch parameter when you launch an instance from the template.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-deviceindex
//
DeviceIndex *float64 `field:"optional" json:"deviceIndex" yaml:"deviceIndex"`
// The ENA Express configuration for the network interface.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-enasrdspecification
//
EnaSrdSpecification interface{} `field:"optional" json:"enaSrdSpecification" yaml:"enaSrdSpecification"`
// The IDs of one or more security groups.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-groups
//
Groups *[]*string `field:"optional" json:"groups" yaml:"groups"`
// The type of network interface.
//
// To create an Elastic Fabric Adapter (EFA), specify `efa` . For more information, see [Elastic Fabric Adapter](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/efa.html) in the *Amazon EC2 User Guide* .
//
// If you are not creating an EFA, specify `interface` or omit this parameter.
//
// Valid values: `interface` | `efa`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-interfacetype
//
InterfaceType *string `field:"optional" json:"interfaceType" yaml:"interfaceType"`
// The number of IPv4 prefixes to be automatically assigned to the network interface.
//
// You cannot use this option if you use the `Ipv4Prefix` option.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-ipv4prefixcount
//
Ipv4PrefixCount *float64 `field:"optional" json:"ipv4PrefixCount" yaml:"ipv4PrefixCount"`
// One or more IPv4 prefixes to be assigned to the network interface.
//
// You cannot use this option if you use the `Ipv4PrefixCount` option.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-ipv4prefixes
//
Ipv4Prefixes interface{} `field:"optional" json:"ipv4Prefixes" yaml:"ipv4Prefixes"`
// The number of IPv6 addresses to assign to a network interface.
//
// Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-ipv6addresscount
//
Ipv6AddressCount *float64 `field:"optional" json:"ipv6AddressCount" yaml:"ipv6AddressCount"`
// One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet.
//
// You can't use this option if you're specifying a number of IPv6 addresses.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-ipv6addresses
//
Ipv6Addresses interface{} `field:"optional" json:"ipv6Addresses" yaml:"ipv6Addresses"`
// The number of IPv6 prefixes to be automatically assigned to the network interface.
//
// You cannot use this option if you use the `Ipv6Prefix` option.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-ipv6prefixcount
//
Ipv6PrefixCount *float64 `field:"optional" json:"ipv6PrefixCount" yaml:"ipv6PrefixCount"`
// One or more IPv6 prefixes to be assigned to the network interface.
//
// You cannot use this option if you use the `Ipv6PrefixCount` option.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-ipv6prefixes
//
Ipv6Prefixes interface{} `field:"optional" json:"ipv6Prefixes" yaml:"ipv6Prefixes"`
// The index of the network card.
//
// Some instance types support multiple network cards. The primary network interface must be assigned to network card index 0. The default is network card index 0.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-networkcardindex
//
NetworkCardIndex *float64 `field:"optional" json:"networkCardIndex" yaml:"networkCardIndex"`
// The ID of the network interface.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-networkinterfaceid
//
NetworkInterfaceId *string `field:"optional" json:"networkInterfaceId" yaml:"networkInterfaceId"`
// The primary IPv6 address of the network interface.
//
// When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information about primary IPv6 addresses, see [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-primaryipv6
//
PrimaryIpv6 interface{} `field:"optional" json:"primaryIpv6" yaml:"primaryIpv6"`
// The primary private IPv4 address of the network interface.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-privateipaddress
//
PrivateIpAddress *string `field:"optional" json:"privateIpAddress" yaml:"privateIpAddress"`
// One or more private IPv4 addresses.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-privateipaddresses
//
PrivateIpAddresses interface{} `field:"optional" json:"privateIpAddresses" yaml:"privateIpAddresses"`
// The number of secondary private IPv4 addresses to assign to a network interface.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-secondaryprivateipaddresscount
//
SecondaryPrivateIpAddressCount *float64 `field:"optional" json:"secondaryPrivateIpAddressCount" yaml:"secondaryPrivateIpAddressCount"`
// The ID of the subnet for the network interface.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-subnetid
//
SubnetId *string `field:"optional" json:"subnetId" yaml:"subnetId"`
}
Specifies the parameters for a network interface.
`NetworkInterface` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.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"
networkInterfaceProperty := &NetworkInterfaceProperty{
AssociateCarrierIpAddress: jsii.Boolean(false),
AssociatePublicIpAddress: jsii.Boolean(false),
ConnectionTrackingSpecification: &ConnectionTrackingSpecificationProperty{
TcpEstablishedTimeout: jsii.Number(123),
UdpStreamTimeout: jsii.Number(123),
UdpTimeout: jsii.Number(123),
},
DeleteOnTermination: jsii.Boolean(false),
Description: jsii.String("description"),
DeviceIndex: jsii.Number(123),
EnaSrdSpecification: &EnaSrdSpecificationProperty{
EnaSrdEnabled: jsii.Boolean(false),
EnaSrdUdpSpecification: &EnaSrdUdpSpecificationProperty{
EnaSrdUdpEnabled: jsii.Boolean(false),
},
},
Groups: []*string{
jsii.String("groups"),
},
InterfaceType: jsii.String("interfaceType"),
Ipv4PrefixCount: jsii.Number(123),
Ipv4Prefixes: []interface{}{
&Ipv4PrefixSpecificationProperty{
Ipv4Prefix: jsii.String("ipv4Prefix"),
},
},
Ipv6AddressCount: jsii.Number(123),
Ipv6Addresses: []interface{}{
&Ipv6AddProperty{
Ipv6Address: jsii.String("ipv6Address"),
},
},
Ipv6PrefixCount: jsii.Number(123),
Ipv6Prefixes: []interface{}{
&Ipv6PrefixSpecificationProperty{
Ipv6Prefix: jsii.String("ipv6Prefix"),
},
},
NetworkCardIndex: jsii.Number(123),
NetworkInterfaceId: jsii.String("networkInterfaceId"),
PrimaryIpv6: jsii.Boolean(false),
PrivateIpAddress: jsii.String("privateIpAddress"),
PrivateIpAddresses: []interface{}{
&PrivateIpAddProperty{
Primary: jsii.Boolean(false),
PrivateIpAddress: jsii.String("privateIpAddress"),
},
},
SecondaryPrivateIpAddressCount: jsii.Number(123),
SubnetId: jsii.String("subnetId"),
}
type CfnLaunchTemplate_PlacementProperty ¶
type CfnLaunchTemplate_PlacementProperty struct {
// The affinity setting for an instance on a Dedicated Host.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-placement.html#cfn-ec2-launchtemplate-placement-affinity
//
Affinity *string `field:"optional" json:"affinity" yaml:"affinity"`
// The Availability Zone for the instance.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-placement.html#cfn-ec2-launchtemplate-placement-availabilityzone
//
AvailabilityZone *string `field:"optional" json:"availabilityZone" yaml:"availabilityZone"`
// The Group Id of a placement group.
//
// You must specify the Placement Group *Group Id* to launch an instance in a shared placement group.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-placement.html#cfn-ec2-launchtemplate-placement-groupid
//
GroupId *string `field:"optional" json:"groupId" yaml:"groupId"`
// The name of the placement group for the instance.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-placement.html#cfn-ec2-launchtemplate-placement-groupname
//
GroupName *string `field:"optional" json:"groupName" yaml:"groupName"`
// The ID of the Dedicated Host for the instance.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-placement.html#cfn-ec2-launchtemplate-placement-hostid
//
HostId *string `field:"optional" json:"hostId" yaml:"hostId"`
// The ARN of the host resource group in which to launch the instances.
//
// If you specify a host resource group ARN, omit the *Tenancy* parameter or set it to `host` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-placement.html#cfn-ec2-launchtemplate-placement-hostresourcegrouparn
//
HostResourceGroupArn *string `field:"optional" json:"hostResourceGroupArn" yaml:"hostResourceGroupArn"`
// The number of the partition the instance should launch in.
//
// Valid only if the placement group strategy is set to `partition` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-placement.html#cfn-ec2-launchtemplate-placement-partitionnumber
//
PartitionNumber *float64 `field:"optional" json:"partitionNumber" yaml:"partitionNumber"`
// Reserved for future use.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-placement.html#cfn-ec2-launchtemplate-placement-spreaddomain
//
SpreadDomain *string `field:"optional" json:"spreadDomain" yaml:"spreadDomain"`
// The tenancy of the instance.
//
// An instance with a tenancy of dedicated runs on single-tenant hardware.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-placement.html#cfn-ec2-launchtemplate-placement-tenancy
//
Tenancy *string `field:"optional" json:"tenancy" yaml:"tenancy"`
}
Specifies the placement of an instance.
`Placement` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.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"
placementProperty := &PlacementProperty{
Affinity: jsii.String("affinity"),
AvailabilityZone: jsii.String("availabilityZone"),
GroupId: jsii.String("groupId"),
GroupName: jsii.String("groupName"),
HostId: jsii.String("hostId"),
HostResourceGroupArn: jsii.String("hostResourceGroupArn"),
PartitionNumber: jsii.Number(123),
SpreadDomain: jsii.String("spreadDomain"),
Tenancy: jsii.String("tenancy"),
}
type CfnLaunchTemplate_PrivateDnsNameOptionsProperty ¶ added in v2.11.0
type CfnLaunchTemplate_PrivateDnsNameOptionsProperty struct {
// Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-privatednsnameoptions.html#cfn-ec2-launchtemplate-privatednsnameoptions-enableresourcenamednsaaaarecord
//
EnableResourceNameDnsAaaaRecord interface{} `field:"optional" json:"enableResourceNameDnsAaaaRecord" yaml:"enableResourceNameDnsAaaaRecord"`
// Indicates whether to respond to DNS queries for instance hostnames with DNS A records.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-privatednsnameoptions.html#cfn-ec2-launchtemplate-privatednsnameoptions-enableresourcenamednsarecord
//
EnableResourceNameDnsARecord interface{} `field:"optional" json:"enableResourceNameDnsARecord" yaml:"enableResourceNameDnsARecord"`
// The type of hostname for EC2 instances.
//
// For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance IPv4 address or the instance ID. For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *Amazon Elastic Compute Cloud User Guide* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-privatednsnameoptions.html#cfn-ec2-launchtemplate-privatednsnameoptions-hostnametype
//
HostnameType *string `field:"optional" json:"hostnameType" yaml:"hostnameType"`
}
The hostname type for EC2 instances launched into this subnet and how DNS A and AAAA record queries should be handled.
For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *Amazon Elastic Compute Cloud User 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"
privateDnsNameOptionsProperty := &PrivateDnsNameOptionsProperty{
EnableResourceNameDnsAaaaRecord: jsii.Boolean(false),
EnableResourceNameDnsARecord: jsii.Boolean(false),
HostnameType: jsii.String("hostnameType"),
}
type CfnLaunchTemplate_PrivateIpAddProperty ¶
type CfnLaunchTemplate_PrivateIpAddProperty struct {
// Indicates whether the private IPv4 address is the primary private IPv4 address.
//
// Only one IPv4 address can be designated as primary.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-privateipadd.html#cfn-ec2-launchtemplate-privateipadd-primary
//
Primary interface{} `field:"optional" json:"primary" yaml:"primary"`
// The private IPv4 address.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-privateipadd.html#cfn-ec2-launchtemplate-privateipadd-privateipaddress
//
PrivateIpAddress *string `field:"optional" json:"privateIpAddress" yaml:"privateIpAddress"`
}
Specifies a secondary private IPv4 address for a network interface.
`PrivateIpAdd` is a property of [AWS::EC2::LaunchTemplate NetworkInterface](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.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"
privateIpAddProperty := &PrivateIpAddProperty{
Primary: jsii.Boolean(false),
PrivateIpAddress: jsii.String("privateIpAddress"),
}
type CfnLaunchTemplate_SpotOptionsProperty ¶
type CfnLaunchTemplate_SpotOptionsProperty struct {
// Deprecated.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-spotoptions.html#cfn-ec2-launchtemplate-spotoptions-blockdurationminutes
//
BlockDurationMinutes *float64 `field:"optional" json:"blockDurationMinutes" yaml:"blockDurationMinutes"`
// The behavior when a Spot Instance is interrupted.
//
// The default is `terminate` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-spotoptions.html#cfn-ec2-launchtemplate-spotoptions-instanceinterruptionbehavior
//
InstanceInterruptionBehavior *string `field:"optional" json:"instanceInterruptionBehavior" yaml:"instanceInterruptionBehavior"`
// The maximum hourly price you're willing to pay for the Spot Instances.
//
// We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
//
// > If you specify a maximum price, your Spot Instances will be interrupted more frequently than if you do not specify this parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-spotoptions.html#cfn-ec2-launchtemplate-spotoptions-maxprice
//
MaxPrice *string `field:"optional" json:"maxPrice" yaml:"maxPrice"`
// The Spot Instance request type.
//
// If you are using Spot Instances with an Auto Scaling group, use `one-time` requests, as the Amazon EC2 Auto Scaling service handles requesting new Spot Instances whenever the group is below its desired capacity.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-spotoptions.html#cfn-ec2-launchtemplate-spotoptions-spotinstancetype
//
SpotInstanceType *string `field:"optional" json:"spotInstanceType" yaml:"spotInstanceType"`
// The end date of the request, in UTC format ( *YYYY-MM-DD* T *HH:MM:SS* Z). Supported only for persistent requests.
//
// - For a persistent request, the request remains active until the `ValidUntil` date and time is reached. Otherwise, the request remains active until you cancel it.
// - For a one-time request, `ValidUntil` is not supported. The request remains active until all instances launch or you cancel the request.
//
// Default: 7 days from the current date.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-spotoptions.html#cfn-ec2-launchtemplate-spotoptions-validuntil
//
ValidUntil *string `field:"optional" json:"validUntil" yaml:"validUntil"`
}
Specifies options for Spot Instances.
`SpotOptions` is a property of [AWS::EC2::LaunchTemplate InstanceMarketOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-instancemarketoptions.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"
spotOptionsProperty := &SpotOptionsProperty{
BlockDurationMinutes: jsii.Number(123),
InstanceInterruptionBehavior: jsii.String("instanceInterruptionBehavior"),
MaxPrice: jsii.String("maxPrice"),
SpotInstanceType: jsii.String("spotInstanceType"),
ValidUntil: jsii.String("validUntil"),
}
type CfnLaunchTemplate_TagSpecificationProperty ¶
type CfnLaunchTemplate_TagSpecificationProperty struct {
// The type of resource to tag.
//
// You can specify tags for the following resource types only: `instance` | `volume` | `network-interface` | `spot-instances-request` . If the instance does not include the resource type that you specify, the instance launch fails. For example, not all instance types include a volume.
//
// To tag a resource after it has been created, see [CreateTags](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html) .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-tagspecification.html#cfn-ec2-launchtemplate-tagspecification-resourcetype
//
ResourceType *string `field:"optional" json:"resourceType" yaml:"resourceType"`
// The tags to apply to the resource.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-tagspecification.html#cfn-ec2-launchtemplate-tagspecification-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Specifies the tags to apply to resources that are created during instance launch.
`TagSpecification` is a property type of [`TagSpecifications`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications) . [`TagSpecifications`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications) is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.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"
tagSpecificationProperty := &TagSpecificationProperty{
ResourceType: jsii.String("resourceType"),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
type CfnLaunchTemplate_TotalLocalStorageGBProperty ¶
type CfnLaunchTemplate_TotalLocalStorageGBProperty struct {
// The maximum amount of total local storage, in GB.
//
// To specify no maximum limit, omit this parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-totallocalstoragegb.html#cfn-ec2-launchtemplate-totallocalstoragegb-max
//
Max *float64 `field:"optional" json:"max" yaml:"max"`
// The minimum amount of total local storage, in GB.
//
// To specify no minimum limit, omit this parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-totallocalstoragegb.html#cfn-ec2-launchtemplate-totallocalstoragegb-min
//
Min *float64 `field:"optional" json:"min" yaml:"min"`
}
The minimum and maximum amount of total local storage, in GB.
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"
totalLocalStorageGBProperty := &TotalLocalStorageGBProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
}
type CfnLaunchTemplate_VCpuCountProperty ¶
type CfnLaunchTemplate_VCpuCountProperty struct {
// The maximum number of vCPUs.
//
// To specify no maximum limit, omit this parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-vcpucount.html#cfn-ec2-launchtemplate-vcpucount-max
//
Max *float64 `field:"optional" json:"max" yaml:"max"`
// The minimum number of vCPUs.
//
// To specify no minimum limit, specify `0` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-vcpucount.html#cfn-ec2-launchtemplate-vcpucount-min
//
Min *float64 `field:"optional" json:"min" yaml:"min"`
}
The minimum and maximum number of vCPUs.
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"
vCpuCountProperty := &VCpuCountProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
}
type CfnLocalGatewayRoute ¶
type CfnLocalGatewayRoute interface {
awscdk.CfnResource
awscdk.IInspectable
// The state of the local gateway route table.
AttrState() *string
// The type of local gateway route.
AttrType() *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 CIDR block used for destination matches.
DestinationCidrBlock() *string
SetDestinationCidrBlock(val *string)
// The ID of the local gateway route table.
LocalGatewayRouteTableId() *string
SetLocalGatewayRouteTableId(val *string)
// The ID of the virtual interface group.
LocalGatewayVirtualInterfaceGroupId() *string
SetLocalGatewayVirtualInterfaceGroupId(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 ID of the network interface.
NetworkInterfaceId() *string
SetNetworkInterfaceId(val *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{})
}
Creates a static route for the specified local gateway route table. You must specify one of the following targets:.
- `LocalGatewayVirtualInterfaceGroupId` - `NetworkInterfaceId`.
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"
cfnLocalGatewayRoute := awscdk.Aws_ec2.NewCfnLocalGatewayRoute(this, jsii.String("MyCfnLocalGatewayRoute"), &CfnLocalGatewayRouteProps{
DestinationCidrBlock: jsii.String("destinationCidrBlock"),
LocalGatewayRouteTableId: jsii.String("localGatewayRouteTableId"),
// the properties below are optional
LocalGatewayVirtualInterfaceGroupId: jsii.String("localGatewayVirtualInterfaceGroupId"),
NetworkInterfaceId: jsii.String("networkInterfaceId"),
})
func NewCfnLocalGatewayRoute ¶
func NewCfnLocalGatewayRoute(scope constructs.Construct, id *string, props *CfnLocalGatewayRouteProps) CfnLocalGatewayRoute
type CfnLocalGatewayRouteProps ¶
type CfnLocalGatewayRouteProps struct {
// The CIDR block used for destination matches.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroute.html#cfn-ec2-localgatewayroute-destinationcidrblock
//
DestinationCidrBlock *string `field:"required" json:"destinationCidrBlock" yaml:"destinationCidrBlock"`
// The ID of the local gateway route table.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroute.html#cfn-ec2-localgatewayroute-localgatewayroutetableid
//
LocalGatewayRouteTableId *string `field:"required" json:"localGatewayRouteTableId" yaml:"localGatewayRouteTableId"`
// The ID of the virtual interface group.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroute.html#cfn-ec2-localgatewayroute-localgatewayvirtualinterfacegroupid
//
LocalGatewayVirtualInterfaceGroupId *string `field:"optional" json:"localGatewayVirtualInterfaceGroupId" yaml:"localGatewayVirtualInterfaceGroupId"`
// The ID of the network interface.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroute.html#cfn-ec2-localgatewayroute-networkinterfaceid
//
NetworkInterfaceId *string `field:"optional" json:"networkInterfaceId" yaml:"networkInterfaceId"`
}
Properties for defining a `CfnLocalGatewayRoute`.
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"
cfnLocalGatewayRouteProps := &CfnLocalGatewayRouteProps{
DestinationCidrBlock: jsii.String("destinationCidrBlock"),
LocalGatewayRouteTableId: jsii.String("localGatewayRouteTableId"),
// the properties below are optional
LocalGatewayVirtualInterfaceGroupId: jsii.String("localGatewayVirtualInterfaceGroupId"),
NetworkInterfaceId: jsii.String("networkInterfaceId"),
}
type CfnLocalGatewayRouteTable ¶ added in v2.70.0
type CfnLocalGatewayRouteTable interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggable
// The Amazon Resource Name (ARN) of the local gateway route table.
AttrLocalGatewayRouteTableArn() *string
// The ID of the local gateway route table.
AttrLocalGatewayRouteTableId() *string
// The Amazon Resource Name (ARN) of the Outpost.
AttrOutpostArn() *string
// The ID of the AWS account that owns the local gateway route table.
AttrOwnerId() *string
// The state of the local gateway route table.
AttrState() *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 ID of the local gateway.
LocalGatewayId() *string
SetLocalGatewayId(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 mode of the local gateway route table.
Mode() *string
SetMode(val *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
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
// The tags assigned to the local gateway route table.
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{})
}
Describes a local gateway route table.
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"
cfnLocalGatewayRouteTable := awscdk.Aws_ec2.NewCfnLocalGatewayRouteTable(this, jsii.String("MyCfnLocalGatewayRouteTable"), &CfnLocalGatewayRouteTableProps{
LocalGatewayId: jsii.String("localGatewayId"),
// the properties below are optional
Mode: jsii.String("mode"),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
func NewCfnLocalGatewayRouteTable ¶ added in v2.70.0
func NewCfnLocalGatewayRouteTable(scope constructs.Construct, id *string, props *CfnLocalGatewayRouteTableProps) CfnLocalGatewayRouteTable
type CfnLocalGatewayRouteTableProps ¶ added in v2.70.0
type CfnLocalGatewayRouteTableProps struct {
// The ID of the local gateway.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroutetable.html#cfn-ec2-localgatewayroutetable-localgatewayid
//
LocalGatewayId *string `field:"required" json:"localGatewayId" yaml:"localGatewayId"`
// The mode of the local gateway route table.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroutetable.html#cfn-ec2-localgatewayroutetable-mode
//
Mode *string `field:"optional" json:"mode" yaml:"mode"`
// The tags assigned to the local gateway route table.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroutetable.html#cfn-ec2-localgatewayroutetable-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnLocalGatewayRouteTable`.
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"
cfnLocalGatewayRouteTableProps := &CfnLocalGatewayRouteTableProps{
LocalGatewayId: jsii.String("localGatewayId"),
// the properties below are optional
Mode: jsii.String("mode"),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
type CfnLocalGatewayRouteTableVPCAssociation ¶
type CfnLocalGatewayRouteTableVPCAssociation interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggable
// The ID of the local gateway.
AttrLocalGatewayId() *string
// The ID of the association.
AttrLocalGatewayRouteTableVpcAssociationId() *string
// The state of the association.
AttrState() *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 ID of the local gateway route table.
LocalGatewayRouteTableId() *string
SetLocalGatewayRouteTableId(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
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
// The tags assigned to the association.
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 ID of the VPC.
VpcId() *string
SetVpcId(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{})
}
Associates the specified VPC with the specified local gateway route table.
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"
cfnLocalGatewayRouteTableVPCAssociation := awscdk.Aws_ec2.NewCfnLocalGatewayRouteTableVPCAssociation(this, jsii.String("MyCfnLocalGatewayRouteTableVPCAssociation"), &CfnLocalGatewayRouteTableVPCAssociationProps{
LocalGatewayRouteTableId: jsii.String("localGatewayRouteTableId"),
VpcId: jsii.String("vpcId"),
// the properties below are optional
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
func NewCfnLocalGatewayRouteTableVPCAssociation ¶
func NewCfnLocalGatewayRouteTableVPCAssociation(scope constructs.Construct, id *string, props *CfnLocalGatewayRouteTableVPCAssociationProps) CfnLocalGatewayRouteTableVPCAssociation
type CfnLocalGatewayRouteTableVPCAssociationProps ¶
type CfnLocalGatewayRouteTableVPCAssociationProps struct {
// The ID of the local gateway route table.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroutetablevpcassociation.html#cfn-ec2-localgatewayroutetablevpcassociation-localgatewayroutetableid
//
LocalGatewayRouteTableId *string `field:"required" json:"localGatewayRouteTableId" yaml:"localGatewayRouteTableId"`
// The ID of the VPC.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroutetablevpcassociation.html#cfn-ec2-localgatewayroutetablevpcassociation-vpcid
//
VpcId *string `field:"required" json:"vpcId" yaml:"vpcId"`
// The tags assigned to the association.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroutetablevpcassociation.html#cfn-ec2-localgatewayroutetablevpcassociation-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnLocalGatewayRouteTableVPCAssociation`.
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"
cfnLocalGatewayRouteTableVPCAssociationProps := &CfnLocalGatewayRouteTableVPCAssociationProps{
LocalGatewayRouteTableId: jsii.String("localGatewayRouteTableId"),
VpcId: jsii.String("vpcId"),
// the properties below are optional
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
type CfnLocalGatewayRouteTableVirtualInterfaceGroupAssociation ¶ added in v2.70.0
type CfnLocalGatewayRouteTableVirtualInterfaceGroupAssociation interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggable
// The ID of the local gateway.
AttrLocalGatewayId() *string
// The Amazon Resource Name (ARN) of the local gateway route table for the virtual interface group.
AttrLocalGatewayRouteTableArn() *string
// The ID of the association.
AttrLocalGatewayRouteTableVirtualInterfaceGroupAssociationId() *string
// The ID of the AWS account that owns the local gateway virtual interface group association.
AttrOwnerId() *string
// The state of the association.
AttrState() *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 ID of the local gateway route table.
LocalGatewayRouteTableId() *string
SetLocalGatewayRouteTableId(val *string)
// The ID of the virtual interface group.
LocalGatewayVirtualInterfaceGroupId() *string
SetLocalGatewayVirtualInterfaceGroupId(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
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
// The tags assigned to the association.
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{})
}
Describes an association between a local gateway route table and a virtual interface group.
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"
cfnLocalGatewayRouteTableVirtualInterfaceGroupAssociation := awscdk.Aws_ec2.NewCfnLocalGatewayRouteTableVirtualInterfaceGroupAssociation(this, jsii.String("MyCfnLocalGatewayRouteTableVirtualInterfaceGroupAssociation"), &CfnLocalGatewayRouteTableVirtualInterfaceGroupAssociationProps{
LocalGatewayRouteTableId: jsii.String("localGatewayRouteTableId"),
LocalGatewayVirtualInterfaceGroupId: jsii.String("localGatewayVirtualInterfaceGroupId"),
// the properties below are optional
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
func NewCfnLocalGatewayRouteTableVirtualInterfaceGroupAssociation ¶ added in v2.70.0
func NewCfnLocalGatewayRouteTableVirtualInterfaceGroupAssociation(scope constructs.Construct, id *string, props *CfnLocalGatewayRouteTableVirtualInterfaceGroupAssociationProps) CfnLocalGatewayRouteTableVirtualInterfaceGroupAssociation
type CfnLocalGatewayRouteTableVirtualInterfaceGroupAssociationProps ¶ added in v2.70.0
type CfnLocalGatewayRouteTableVirtualInterfaceGroupAssociationProps struct {
// The ID of the local gateway route table.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroutetablevirtualinterfacegroupassociation.html#cfn-ec2-localgatewayroutetablevirtualinterfacegroupassociation-localgatewayroutetableid
//
LocalGatewayRouteTableId *string `field:"required" json:"localGatewayRouteTableId" yaml:"localGatewayRouteTableId"`
// The ID of the virtual interface group.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroutetablevirtualinterfacegroupassociation.html#cfn-ec2-localgatewayroutetablevirtualinterfacegroupassociation-localgatewayvirtualinterfacegroupid
//
LocalGatewayVirtualInterfaceGroupId *string `field:"required" json:"localGatewayVirtualInterfaceGroupId" yaml:"localGatewayVirtualInterfaceGroupId"`
// The tags assigned to the association.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroutetablevirtualinterfacegroupassociation.html#cfn-ec2-localgatewayroutetablevirtualinterfacegroupassociation-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnLocalGatewayRouteTableVirtualInterfaceGroupAssociation`.
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"
cfnLocalGatewayRouteTableVirtualInterfaceGroupAssociationProps := &CfnLocalGatewayRouteTableVirtualInterfaceGroupAssociationProps{
LocalGatewayRouteTableId: jsii.String("localGatewayRouteTableId"),
LocalGatewayVirtualInterfaceGroupId: jsii.String("localGatewayVirtualInterfaceGroupId"),
// the properties below are optional
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
type CfnNatGateway ¶
type CfnNatGateway interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggable
// [Public NAT gateway only] The allocation ID of the Elastic IP address that's associated with the NAT gateway.
AllocationId() *string
SetAllocationId(val *string)
// The ID of the NAT gateway.
AttrNatGatewayId() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// Indicates whether the NAT gateway supports public or private connectivity.
ConnectivityType() *string
SetConnectivityType(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 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 maximum amount of time to wait (in seconds) before forcibly releasing the IP addresses if connections are still in progress.
MaxDrainDurationSeconds() *float64
SetMaxDrainDurationSeconds(val *float64)
// The tree node.
Node() constructs.Node
// The private IPv4 address to assign to the NAT gateway.
PrivateIpAddress() *string
SetPrivateIpAddress(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
// Secondary EIP allocation IDs.
SecondaryAllocationIds() *[]*string
SetSecondaryAllocationIds(val *[]*string)
// [Private NAT gateway only] The number of secondary private IPv4 addresses you want to assign to the NAT gateway.
SecondaryPrivateIpAddressCount() *float64
SetSecondaryPrivateIpAddressCount(val *float64)
// Secondary private IPv4 addresses.
SecondaryPrivateIpAddresses() *[]*string
SetSecondaryPrivateIpAddresses(val *[]*string)
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// The ID of the subnet in which the NAT gateway is located.
SubnetId() *string
SetSubnetId(val *string)
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
// The tags for the NAT gateway.
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{})
}
Specifies a network address translation (NAT) gateway in the specified subnet.
You can create either a public NAT gateway or a private NAT gateway. The default is a public NAT gateway. If you create a public NAT gateway, you must specify an elastic IP address.
With a NAT gateway, instances in a private subnet can connect to the internet, other AWS services, or an on-premises network using the IP address of the NAT gateway. For more information, see [NAT gateways](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html) in the *Amazon VPC User Guide* .
If you add a default route ( `AWS::EC2::Route` resource) that points to a NAT gateway, specify the NAT gateway ID for the route's `NatGatewayId` property.
> When you associate an Elastic IP address or secondary Elastic IP address with a public NAT gateway, the network border group of the Elastic IP address must match the network border group of the Availability Zone (AZ) that the public NAT gateway is in. Otherwise, the NAT gateway fails to launch. You can see the network border group for the AZ by viewing the details of the subnet. Similarly, you can view the network border group for the Elastic IP address by viewing its details. For more information, see [Allocate an Elastic IP address](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#allocate-eip) in the *Amazon VPC User 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"
cfnNatGateway := awscdk.Aws_ec2.NewCfnNatGateway(this, jsii.String("MyCfnNatGateway"), &CfnNatGatewayProps{
SubnetId: jsii.String("subnetId"),
// the properties below are optional
AllocationId: jsii.String("allocationId"),
ConnectivityType: jsii.String("connectivityType"),
MaxDrainDurationSeconds: jsii.Number(123),
PrivateIpAddress: jsii.String("privateIpAddress"),
SecondaryAllocationIds: []*string{
jsii.String("secondaryAllocationIds"),
},
SecondaryPrivateIpAddressCount: jsii.Number(123),
SecondaryPrivateIpAddresses: []*string{
jsii.String("secondaryPrivateIpAddresses"),
},
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html
func NewCfnNatGateway ¶
func NewCfnNatGateway(scope constructs.Construct, id *string, props *CfnNatGatewayProps) CfnNatGateway
type CfnNatGatewayProps ¶
type CfnNatGatewayProps struct {
// The ID of the subnet in which the NAT gateway is located.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-subnetid
//
SubnetId *string `field:"required" json:"subnetId" yaml:"subnetId"`
// [Public NAT gateway only] The allocation ID of the Elastic IP address that's associated with the NAT gateway.
//
// This property is required for a public NAT gateway and cannot be specified with a private NAT gateway.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-allocationid
//
AllocationId *string `field:"optional" json:"allocationId" yaml:"allocationId"`
// Indicates whether the NAT gateway supports public or private connectivity.
//
// The default is public connectivity.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-connectivitytype
//
ConnectivityType *string `field:"optional" json:"connectivityType" yaml:"connectivityType"`
// The maximum amount of time to wait (in seconds) before forcibly releasing the IP addresses if connections are still in progress.
//
// Default value is 350 seconds.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-maxdraindurationseconds
//
MaxDrainDurationSeconds *float64 `field:"optional" json:"maxDrainDurationSeconds" yaml:"maxDrainDurationSeconds"`
// The private IPv4 address to assign to the NAT gateway.
//
// If you don't provide an address, a private IPv4 address will be automatically assigned.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-privateipaddress
//
PrivateIpAddress *string `field:"optional" json:"privateIpAddress" yaml:"privateIpAddress"`
// Secondary EIP allocation IDs.
//
// For more information, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the *Amazon VPC User Guide* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-secondaryallocationids
//
SecondaryAllocationIds *[]*string `field:"optional" json:"secondaryAllocationIds" yaml:"secondaryAllocationIds"`
// [Private NAT gateway only] The number of secondary private IPv4 addresses you want to assign to the NAT gateway.
//
// For more information about secondary addresses, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the *Amazon Virtual Private Cloud User Guide* .
//
// `SecondaryPrivateIpAddressCount` and `SecondaryPrivateIpAddresses` cannot be set at the same time.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-secondaryprivateipaddresscount
//
SecondaryPrivateIpAddressCount *float64 `field:"optional" json:"secondaryPrivateIpAddressCount" yaml:"secondaryPrivateIpAddressCount"`
// Secondary private IPv4 addresses.
//
// For more information about secondary addresses, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the *Amazon Virtual Private Cloud User Guide* .
//
// `SecondaryPrivateIpAddressCount` and `SecondaryPrivateIpAddresses` cannot be set at the same time.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-secondaryprivateipaddresses
//
SecondaryPrivateIpAddresses *[]*string `field:"optional" json:"secondaryPrivateIpAddresses" yaml:"secondaryPrivateIpAddresses"`
// The tags for the NAT gateway.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnNatGateway`.
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"
cfnNatGatewayProps := &CfnNatGatewayProps{
SubnetId: jsii.String("subnetId"),
// the properties below are optional
AllocationId: jsii.String("allocationId"),
ConnectivityType: jsii.String("connectivityType"),
MaxDrainDurationSeconds: jsii.Number(123),
PrivateIpAddress: jsii.String("privateIpAddress"),
SecondaryAllocationIds: []*string{
jsii.String("secondaryAllocationIds"),
},
SecondaryPrivateIpAddressCount: jsii.Number(123),
SecondaryPrivateIpAddresses: []*string{
jsii.String("secondaryPrivateIpAddresses"),
},
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html
type CfnNetworkAcl ¶
type CfnNetworkAcl interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggable
// The ID of the network ACL.
AttrId() *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
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
// The tags for the network ACL.
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 ID of the VPC for the network ACL.
VpcId() *string
SetVpcId(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{})
}
Specifies a network ACL for your VPC.
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"
cfnNetworkAcl := awscdk.Aws_ec2.NewCfnNetworkAcl(this, jsii.String("MyCfnNetworkAcl"), &CfnNetworkAclProps{
VpcId: jsii.String("vpcId"),
// the properties below are optional
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkacl.html
func NewCfnNetworkAcl ¶
func NewCfnNetworkAcl(scope constructs.Construct, id *string, props *CfnNetworkAclProps) CfnNetworkAcl
type CfnNetworkAclEntry ¶
type CfnNetworkAclEntry interface {
awscdk.CfnResource
awscdk.IInspectable
// The ID of the network ACL entry.
AttrId() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// The IPv4 CIDR range to allow or deny, in CIDR notation (for example, 172.16.0.0/24). You must specify an IPv4 CIDR block or an IPv6 CIDR block.
CidrBlock() *string
SetCidrBlock(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
// Whether this rule applies to egress traffic from the subnet ( `true` ) or ingress traffic to the subnet ( `false` ).
Egress() interface{}
SetEgress(val interface{})
// The Internet Control Message Protocol (ICMP) code and type.
Icmp() interface{}
SetIcmp(val interface{})
// The IPv6 network range to allow or deny, in CIDR notation.
Ipv6CidrBlock() *string
SetIpv6CidrBlock(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 ID of the ACL for the entry.
NetworkAclId() *string
SetNetworkAclId(val *string)
// The tree node.
Node() constructs.Node
// The range of port numbers for the UDP/TCP protocol.
PortRange() interface{}
SetPortRange(val interface{})
// The IP protocol that the rule applies to.
Protocol() *float64
SetProtocol(val *float64)
// 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
// Whether to allow or deny traffic that matches the rule;.
RuleAction() *string
SetRuleAction(val *string)
// Rule number to assign to the entry, such as 100.
RuleNumber() *float64
SetRuleNumber(val *float64)
// 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{})
}
Specifies an entry, known as a rule, in a network ACL with a rule number you specify.
Each network ACL has a set of numbered ingress rules and a separate set of numbered egress rules.
For information about the protocol value, see [Protocol Numbers](https://docs.aws.amazon.com/https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml) on the Internet Assigned Numbers Authority (IANA) website.
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"
cfnNetworkAclEntry := awscdk.Aws_ec2.NewCfnNetworkAclEntry(this, jsii.String("MyCfnNetworkAclEntry"), &CfnNetworkAclEntryProps{
NetworkAclId: jsii.String("networkAclId"),
Protocol: jsii.Number(123),
RuleAction: jsii.String("ruleAction"),
RuleNumber: jsii.Number(123),
// the properties below are optional
CidrBlock: jsii.String("cidrBlock"),
Egress: jsii.Boolean(false),
Icmp: &IcmpProperty{
Code: jsii.Number(123),
Type: jsii.Number(123),
},
Ipv6CidrBlock: jsii.String("ipv6CidrBlock"),
PortRange: &PortRangeProperty{
From: jsii.Number(123),
To: jsii.Number(123),
},
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkaclentry.html
func NewCfnNetworkAclEntry ¶
func NewCfnNetworkAclEntry(scope constructs.Construct, id *string, props *CfnNetworkAclEntryProps) CfnNetworkAclEntry
type CfnNetworkAclEntryProps ¶
type CfnNetworkAclEntryProps struct {
// The ID of the ACL for the entry.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkaclentry.html#cfn-ec2-networkaclentry-networkaclid
//
NetworkAclId *string `field:"required" json:"networkAclId" yaml:"networkAclId"`
// The IP protocol that the rule applies to.
//
// You must specify -1 or a protocol number. You can specify -1 for all protocols.
//
// > If you specify -1, all ports are opened and the `PortRange` property is ignored.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkaclentry.html#cfn-ec2-networkaclentry-protocol
//
Protocol *float64 `field:"required" json:"protocol" yaml:"protocol"`
// Whether to allow or deny traffic that matches the rule;
//
// valid values are "allow" or "deny".
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkaclentry.html#cfn-ec2-networkaclentry-ruleaction
//
RuleAction *string `field:"required" json:"ruleAction" yaml:"ruleAction"`
// Rule number to assign to the entry, such as 100.
//
// ACL entries are processed in ascending order by rule number. Entries can't use the same rule number unless one is an egress rule and the other is an ingress rule.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkaclentry.html#cfn-ec2-networkaclentry-rulenumber
//
RuleNumber *float64 `field:"required" json:"ruleNumber" yaml:"ruleNumber"`
// The IPv4 CIDR range to allow or deny, in CIDR notation (for example, 172.16.0.0/24). You must specify an IPv4 CIDR block or an IPv6 CIDR block.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkaclentry.html#cfn-ec2-networkaclentry-cidrblock
//
CidrBlock *string `field:"optional" json:"cidrBlock" yaml:"cidrBlock"`
// Whether this rule applies to egress traffic from the subnet ( `true` ) or ingress traffic to the subnet ( `false` ).
//
// By default, AWS CloudFormation specifies `false` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkaclentry.html#cfn-ec2-networkaclentry-egress
//
Egress interface{} `field:"optional" json:"egress" yaml:"egress"`
// The Internet Control Message Protocol (ICMP) code and type.
//
// Required if specifying 1 (ICMP) for the protocol parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkaclentry.html#cfn-ec2-networkaclentry-icmp
//
Icmp interface{} `field:"optional" json:"icmp" yaml:"icmp"`
// The IPv6 network range to allow or deny, in CIDR notation.
//
// You must specify an IPv4 CIDR block or an IPv6 CIDR block.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkaclentry.html#cfn-ec2-networkaclentry-ipv6cidrblock
//
Ipv6CidrBlock *string `field:"optional" json:"ipv6CidrBlock" yaml:"ipv6CidrBlock"`
// The range of port numbers for the UDP/TCP protocol.
//
// Required if specifying 6 (TCP) or 17 (UDP) for the protocol parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkaclentry.html#cfn-ec2-networkaclentry-portrange
//
PortRange interface{} `field:"optional" json:"portRange" yaml:"portRange"`
}
Properties for defining a `CfnNetworkAclEntry`.
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"
cfnNetworkAclEntryProps := &CfnNetworkAclEntryProps{
NetworkAclId: jsii.String("networkAclId"),
Protocol: jsii.Number(123),
RuleAction: jsii.String("ruleAction"),
RuleNumber: jsii.Number(123),
// the properties below are optional
CidrBlock: jsii.String("cidrBlock"),
Egress: jsii.Boolean(false),
Icmp: &IcmpProperty{
Code: jsii.Number(123),
Type: jsii.Number(123),
},
Ipv6CidrBlock: jsii.String("ipv6CidrBlock"),
PortRange: &PortRangeProperty{
From: jsii.Number(123),
To: jsii.Number(123),
},
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkaclentry.html
type CfnNetworkAclEntry_IcmpProperty ¶
type CfnNetworkAclEntry_IcmpProperty struct {
// The Internet Control Message Protocol (ICMP) code.
//
// You can use -1 to specify all ICMP codes for the given ICMP type. Required if you specify 1 (ICMP) for the protocol parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkaclentry-icmp.html#cfn-ec2-networkaclentry-icmp-code
//
Code *float64 `field:"optional" json:"code" yaml:"code"`
// The Internet Control Message Protocol (ICMP) type.
//
// You can use -1 to specify all ICMP types. Conditional requirement: Required if you specify 1 (ICMP) for the `CreateNetworkAclEntry` protocol parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkaclentry-icmp.html#cfn-ec2-networkaclentry-icmp-type
//
Type *float64 `field:"optional" json:"type" yaml:"type"`
}
Describes the ICMP type and code.
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"
icmpProperty := &IcmpProperty{
Code: jsii.Number(123),
Type: jsii.Number(123),
}
type CfnNetworkAclEntry_PortRangeProperty ¶
type CfnNetworkAclEntry_PortRangeProperty struct {
// The first port in the range.
//
// Required if you specify 6 (TCP) or 17 (UDP) for the protocol parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkaclentry-portrange.html#cfn-ec2-networkaclentry-portrange-from
//
From *float64 `field:"optional" json:"from" yaml:"from"`
// The last port in the range.
//
// Required if you specify 6 (TCP) or 17 (UDP) for the protocol parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkaclentry-portrange.html#cfn-ec2-networkaclentry-portrange-to
//
To *float64 `field:"optional" json:"to" yaml:"to"`
}
Describes a range of ports.
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"
portRangeProperty := &PortRangeProperty{
From: jsii.Number(123),
To: jsii.Number(123),
}
type CfnNetworkAclProps ¶
type CfnNetworkAclProps struct {
// The ID of the VPC for the network ACL.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkacl.html#cfn-ec2-networkacl-vpcid
//
VpcId *string `field:"required" json:"vpcId" yaml:"vpcId"`
// The tags for the network ACL.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkacl.html#cfn-ec2-networkacl-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnNetworkAcl`.
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"
cfnNetworkAclProps := &CfnNetworkAclProps{
VpcId: jsii.String("vpcId"),
// the properties below are optional
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkacl.html
type CfnNetworkInsightsAccessScope ¶ added in v2.9.0
type CfnNetworkInsightsAccessScope interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggable
// The creation date.
AttrCreatedDate() *string
// The ARN of the Network Access Scope.
AttrNetworkInsightsAccessScopeArn() *string
// The ID of the Network Access Scope.
AttrNetworkInsightsAccessScopeId() *string
// The last updated date.
AttrUpdatedDate() *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 paths to exclude.
ExcludePaths() interface{}
SetExcludePaths(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 paths to match.
MatchPaths() interface{}
SetMatchPaths(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
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
// The tags.
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{})
}
Describes a Network Access Scope.
A Network Access Scope defines outbound (egress) and inbound (ingress) traffic patterns, including sources, destinations, paths, and traffic types.
Network Access Analyzer identifies unintended network access to your resources on AWS . When you start an analysis on a Network Access Scope, Network Access Analyzer produces findings. For more information, see the [Network Access Analyzer User Guide](https://docs.aws.amazon.com/vpc/latest/network-access-analyzer/) .
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"
cfnNetworkInsightsAccessScope := awscdk.Aws_ec2.NewCfnNetworkInsightsAccessScope(this, jsii.String("MyCfnNetworkInsightsAccessScope"), &CfnNetworkInsightsAccessScopeProps{
ExcludePaths: []interface{}{
&AccessScopePathRequestProperty{
Destination: &PathStatementRequestProperty{
PacketHeaderStatement: &PacketHeaderStatementRequestProperty{
DestinationAddresses: []*string{
jsii.String("destinationAddresses"),
},
DestinationPorts: []*string{
jsii.String("destinationPorts"),
},
DestinationPrefixLists: []*string{
jsii.String("destinationPrefixLists"),
},
Protocols: []*string{
jsii.String("protocols"),
},
SourceAddresses: []*string{
jsii.String("sourceAddresses"),
},
SourcePorts: []*string{
jsii.String("sourcePorts"),
},
SourcePrefixLists: []*string{
jsii.String("sourcePrefixLists"),
},
},
ResourceStatement: &ResourceStatementRequestProperty{
Resources: []*string{
jsii.String("resources"),
},
ResourceTypes: []*string{
jsii.String("resourceTypes"),
},
},
},
Source: &PathStatementRequestProperty{
PacketHeaderStatement: &PacketHeaderStatementRequestProperty{
DestinationAddresses: []*string{
jsii.String("destinationAddresses"),
},
DestinationPorts: []*string{
jsii.String("destinationPorts"),
},
DestinationPrefixLists: []*string{
jsii.String("destinationPrefixLists"),
},
Protocols: []*string{
jsii.String("protocols"),
},
SourceAddresses: []*string{
jsii.String("sourceAddresses"),
},
SourcePorts: []*string{
jsii.String("sourcePorts"),
},
SourcePrefixLists: []*string{
jsii.String("sourcePrefixLists"),
},
},
ResourceStatement: &ResourceStatementRequestProperty{
Resources: []*string{
jsii.String("resources"),
},
ResourceTypes: []*string{
jsii.String("resourceTypes"),
},
},
},
ThroughResources: []interface{}{
&ThroughResourcesStatementRequestProperty{
ResourceStatement: &ResourceStatementRequestProperty{
Resources: []*string{
jsii.String("resources"),
},
ResourceTypes: []*string{
jsii.String("resourceTypes"),
},
},
},
},
},
},
MatchPaths: []interface{}{
&AccessScopePathRequestProperty{
Destination: &PathStatementRequestProperty{
PacketHeaderStatement: &PacketHeaderStatementRequestProperty{
DestinationAddresses: []*string{
jsii.String("destinationAddresses"),
},
DestinationPorts: []*string{
jsii.String("destinationPorts"),
},
DestinationPrefixLists: []*string{
jsii.String("destinationPrefixLists"),
},
Protocols: []*string{
jsii.String("protocols"),
},
SourceAddresses: []*string{
jsii.String("sourceAddresses"),
},
SourcePorts: []*string{
jsii.String("sourcePorts"),
},
SourcePrefixLists: []*string{
jsii.String("sourcePrefixLists"),
},
},
ResourceStatement: &ResourceStatementRequestProperty{
Resources: []*string{
jsii.String("resources"),
},
ResourceTypes: []*string{
jsii.String("resourceTypes"),
},
},
},
Source: &PathStatementRequestProperty{
PacketHeaderStatement: &PacketHeaderStatementRequestProperty{
DestinationAddresses: []*string{
jsii.String("destinationAddresses"),
},
DestinationPorts: []*string{
jsii.String("destinationPorts"),
},
DestinationPrefixLists: []*string{
jsii.String("destinationPrefixLists"),
},
Protocols: []*string{
jsii.String("protocols"),
},
SourceAddresses: []*string{
jsii.String("sourceAddresses"),
},
SourcePorts: []*string{
jsii.String("sourcePorts"),
},
SourcePrefixLists: []*string{
jsii.String("sourcePrefixLists"),
},
},
ResourceStatement: &ResourceStatementRequestProperty{
Resources: []*string{
jsii.String("resources"),
},
ResourceTypes: []*string{
jsii.String("resourceTypes"),
},
},
},
ThroughResources: []interface{}{
&ThroughResourcesStatementRequestProperty{
ResourceStatement: &ResourceStatementRequestProperty{
Resources: []*string{
jsii.String("resources"),
},
ResourceTypes: []*string{
jsii.String("resourceTypes"),
},
},
},
},
},
},
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
func NewCfnNetworkInsightsAccessScope ¶ added in v2.9.0
func NewCfnNetworkInsightsAccessScope(scope constructs.Construct, id *string, props *CfnNetworkInsightsAccessScopeProps) CfnNetworkInsightsAccessScope
type CfnNetworkInsightsAccessScopeAnalysis ¶ added in v2.9.0
type CfnNetworkInsightsAccessScopeAnalysis interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggable
// The number of network interfaces analyzed.
AttrAnalyzedEniCount() *float64
// The end date of the analysis.
AttrEndDate() *string
// Indicates whether there are findings (true | false | unknown).
AttrFindingsFound() *string
// The ARN of the Network Access Scope analysis.
AttrNetworkInsightsAccessScopeAnalysisArn() *string
// The ID of the Network Access Scope analysis.
AttrNetworkInsightsAccessScopeAnalysisId() *string
// The start date of the analysis.
AttrStartDate() *string
// The status of the analysis (running | succeeded | failed).
AttrStatus() *string
// The status message.
AttrStatusMessage() *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 ID of the Network Access Scope.
NetworkInsightsAccessScopeId() *string
SetNetworkInsightsAccessScopeId(val *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
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
// The tags.
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{})
}
Describes a Network Access Scope analysis.
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"
cfnNetworkInsightsAccessScopeAnalysis := awscdk.Aws_ec2.NewCfnNetworkInsightsAccessScopeAnalysis(this, jsii.String("MyCfnNetworkInsightsAccessScopeAnalysis"), &CfnNetworkInsightsAccessScopeAnalysisProps{
NetworkInsightsAccessScopeId: jsii.String("networkInsightsAccessScopeId"),
// the properties below are optional
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
func NewCfnNetworkInsightsAccessScopeAnalysis ¶ added in v2.9.0
func NewCfnNetworkInsightsAccessScopeAnalysis(scope constructs.Construct, id *string, props *CfnNetworkInsightsAccessScopeAnalysisProps) CfnNetworkInsightsAccessScopeAnalysis
type CfnNetworkInsightsAccessScopeAnalysisProps ¶ added in v2.9.0
type CfnNetworkInsightsAccessScopeAnalysisProps struct {
// The ID of the Network Access Scope.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsaccessscopeanalysis.html#cfn-ec2-networkinsightsaccessscopeanalysis-networkinsightsaccessscopeid
//
NetworkInsightsAccessScopeId *string `field:"required" json:"networkInsightsAccessScopeId" yaml:"networkInsightsAccessScopeId"`
// The tags.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsaccessscopeanalysis.html#cfn-ec2-networkinsightsaccessscopeanalysis-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnNetworkInsightsAccessScopeAnalysis`.
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"
cfnNetworkInsightsAccessScopeAnalysisProps := &CfnNetworkInsightsAccessScopeAnalysisProps{
NetworkInsightsAccessScopeId: jsii.String("networkInsightsAccessScopeId"),
// the properties below are optional
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
type CfnNetworkInsightsAccessScopeProps ¶ added in v2.9.0
type CfnNetworkInsightsAccessScopeProps struct {
// The paths to exclude.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsaccessscope.html#cfn-ec2-networkinsightsaccessscope-excludepaths
//
ExcludePaths interface{} `field:"optional" json:"excludePaths" yaml:"excludePaths"`
// The paths to match.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsaccessscope.html#cfn-ec2-networkinsightsaccessscope-matchpaths
//
MatchPaths interface{} `field:"optional" json:"matchPaths" yaml:"matchPaths"`
// The tags.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsaccessscope.html#cfn-ec2-networkinsightsaccessscope-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnNetworkInsightsAccessScope`.
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"
cfnNetworkInsightsAccessScopeProps := &CfnNetworkInsightsAccessScopeProps{
ExcludePaths: []interface{}{
&AccessScopePathRequestProperty{
Destination: &PathStatementRequestProperty{
PacketHeaderStatement: &PacketHeaderStatementRequestProperty{
DestinationAddresses: []*string{
jsii.String("destinationAddresses"),
},
DestinationPorts: []*string{
jsii.String("destinationPorts"),
},
DestinationPrefixLists: []*string{
jsii.String("destinationPrefixLists"),
},
Protocols: []*string{
jsii.String("protocols"),
},
SourceAddresses: []*string{
jsii.String("sourceAddresses"),
},
SourcePorts: []*string{
jsii.String("sourcePorts"),
},
SourcePrefixLists: []*string{
jsii.String("sourcePrefixLists"),
},
},
ResourceStatement: &ResourceStatementRequestProperty{
Resources: []*string{
jsii.String("resources"),
},
ResourceTypes: []*string{
jsii.String("resourceTypes"),
},
},
},
Source: &PathStatementRequestProperty{
PacketHeaderStatement: &PacketHeaderStatementRequestProperty{
DestinationAddresses: []*string{
jsii.String("destinationAddresses"),
},
DestinationPorts: []*string{
jsii.String("destinationPorts"),
},
DestinationPrefixLists: []*string{
jsii.String("destinationPrefixLists"),
},
Protocols: []*string{
jsii.String("protocols"),
},
SourceAddresses: []*string{
jsii.String("sourceAddresses"),
},
SourcePorts: []*string{
jsii.String("sourcePorts"),
},
SourcePrefixLists: []*string{
jsii.String("sourcePrefixLists"),
},
},
ResourceStatement: &ResourceStatementRequestProperty{
Resources: []*string{
jsii.String("resources"),
},
ResourceTypes: []*string{
jsii.String("resourceTypes"),
},
},
},
ThroughResources: []interface{}{
&ThroughResourcesStatementRequestProperty{
ResourceStatement: &ResourceStatementRequestProperty{
Resources: []*string{
jsii.String("resources"),
},
ResourceTypes: []*string{
jsii.String("resourceTypes"),
},
},
},
},
},
},
MatchPaths: []interface{}{
&AccessScopePathRequestProperty{
Destination: &PathStatementRequestProperty{
PacketHeaderStatement: &PacketHeaderStatementRequestProperty{
DestinationAddresses: []*string{
jsii.String("destinationAddresses"),
},
DestinationPorts: []*string{
jsii.String("destinationPorts"),
},
DestinationPrefixLists: []*string{
jsii.String("destinationPrefixLists"),
},
Protocols: []*string{
jsii.String("protocols"),
},
SourceAddresses: []*string{
jsii.String("sourceAddresses"),
},
SourcePorts: []*string{
jsii.String("sourcePorts"),
},
SourcePrefixLists: []*string{
jsii.String("sourcePrefixLists"),
},
},
ResourceStatement: &ResourceStatementRequestProperty{
Resources: []*string{
jsii.String("resources"),
},
ResourceTypes: []*string{
jsii.String("resourceTypes"),
},
},
},
Source: &PathStatementRequestProperty{
PacketHeaderStatement: &PacketHeaderStatementRequestProperty{
DestinationAddresses: []*string{
jsii.String("destinationAddresses"),
},
DestinationPorts: []*string{
jsii.String("destinationPorts"),
},
DestinationPrefixLists: []*string{
jsii.String("destinationPrefixLists"),
},
Protocols: []*string{
jsii.String("protocols"),
},
SourceAddresses: []*string{
jsii.String("sourceAddresses"),
},
SourcePorts: []*string{
jsii.String("sourcePorts"),
},
SourcePrefixLists: []*string{
jsii.String("sourcePrefixLists"),
},
},
ResourceStatement: &ResourceStatementRequestProperty{
Resources: []*string{
jsii.String("resources"),
},
ResourceTypes: []*string{
jsii.String("resourceTypes"),
},
},
},
ThroughResources: []interface{}{
&ThroughResourcesStatementRequestProperty{
ResourceStatement: &ResourceStatementRequestProperty{
Resources: []*string{
jsii.String("resources"),
},
ResourceTypes: []*string{
jsii.String("resourceTypes"),
},
},
},
},
},
},
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
type CfnNetworkInsightsAccessScope_AccessScopePathRequestProperty ¶ added in v2.9.0
type CfnNetworkInsightsAccessScope_AccessScopePathRequestProperty struct {
// The destination.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsaccessscope-accessscopepathrequest.html#cfn-ec2-networkinsightsaccessscope-accessscopepathrequest-destination
//
Destination interface{} `field:"optional" json:"destination" yaml:"destination"`
// The source.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsaccessscope-accessscopepathrequest.html#cfn-ec2-networkinsightsaccessscope-accessscopepathrequest-source
//
Source interface{} `field:"optional" json:"source" yaml:"source"`
// The through resources.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsaccessscope-accessscopepathrequest.html#cfn-ec2-networkinsightsaccessscope-accessscopepathrequest-throughresources
//
ThroughResources interface{} `field:"optional" json:"throughResources" yaml:"throughResources"`
}
Describes a path.
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"
accessScopePathRequestProperty := &AccessScopePathRequestProperty{
Destination: &PathStatementRequestProperty{
PacketHeaderStatement: &PacketHeaderStatementRequestProperty{
DestinationAddresses: []*string{
jsii.String("destinationAddresses"),
},
DestinationPorts: []*string{
jsii.String("destinationPorts"),
},
DestinationPrefixLists: []*string{
jsii.String("destinationPrefixLists"),
},
Protocols: []*string{
jsii.String("protocols"),
},
SourceAddresses: []*string{
jsii.String("sourceAddresses"),
},
SourcePorts: []*string{
jsii.String("sourcePorts"),
},
SourcePrefixLists: []*string{
jsii.String("sourcePrefixLists"),
},
},
ResourceStatement: &ResourceStatementRequestProperty{
Resources: []*string{
jsii.String("resources"),
},
ResourceTypes: []*string{
jsii.String("resourceTypes"),
},
},
},
Source: &PathStatementRequestProperty{
PacketHeaderStatement: &PacketHeaderStatementRequestProperty{
DestinationAddresses: []*string{
jsii.String("destinationAddresses"),
},
DestinationPorts: []*string{
jsii.String("destinationPorts"),
},
DestinationPrefixLists: []*string{
jsii.String("destinationPrefixLists"),
},
Protocols: []*string{
jsii.String("protocols"),
},
SourceAddresses: []*string{
jsii.String("sourceAddresses"),
},
SourcePorts: []*string{
jsii.String("sourcePorts"),
},
SourcePrefixLists: []*string{
jsii.String("sourcePrefixLists"),
},
},
ResourceStatement: &ResourceStatementRequestProperty{
Resources: []*string{
jsii.String("resources"),
},
ResourceTypes: []*string{
jsii.String("resourceTypes"),
},
},
},
ThroughResources: []interface{}{
&ThroughResourcesStatementRequestProperty{
ResourceStatement: &ResourceStatementRequestProperty{
Resources: []*string{
jsii.String("resources"),
},
ResourceTypes: []*string{
jsii.String("resourceTypes"),
},
},
},
},
}
type CfnNetworkInsightsAccessScope_PacketHeaderStatementRequestProperty ¶ added in v2.9.0
type CfnNetworkInsightsAccessScope_PacketHeaderStatementRequestProperty struct {
// The destination addresses.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsaccessscope-packetheaderstatementrequest.html#cfn-ec2-networkinsightsaccessscope-packetheaderstatementrequest-destinationaddresses
//
DestinationAddresses *[]*string `field:"optional" json:"destinationAddresses" yaml:"destinationAddresses"`
// The destination ports.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsaccessscope-packetheaderstatementrequest.html#cfn-ec2-networkinsightsaccessscope-packetheaderstatementrequest-destinationports
//
DestinationPorts *[]*string `field:"optional" json:"destinationPorts" yaml:"destinationPorts"`
// The destination prefix lists.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsaccessscope-packetheaderstatementrequest.html#cfn-ec2-networkinsightsaccessscope-packetheaderstatementrequest-destinationprefixlists
//
DestinationPrefixLists *[]*string `field:"optional" json:"destinationPrefixLists" yaml:"destinationPrefixLists"`
// The protocols.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsaccessscope-packetheaderstatementrequest.html#cfn-ec2-networkinsightsaccessscope-packetheaderstatementrequest-protocols
//
Protocols *[]*string `field:"optional" json:"protocols" yaml:"protocols"`
// The source addresses.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsaccessscope-packetheaderstatementrequest.html#cfn-ec2-networkinsightsaccessscope-packetheaderstatementrequest-sourceaddresses
//
SourceAddresses *[]*string `field:"optional" json:"sourceAddresses" yaml:"sourceAddresses"`
// The source ports.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsaccessscope-packetheaderstatementrequest.html#cfn-ec2-networkinsightsaccessscope-packetheaderstatementrequest-sourceports
//
SourcePorts *[]*string `field:"optional" json:"sourcePorts" yaml:"sourcePorts"`
// The source prefix lists.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsaccessscope-packetheaderstatementrequest.html#cfn-ec2-networkinsightsaccessscope-packetheaderstatementrequest-sourceprefixlists
//
SourcePrefixLists *[]*string `field:"optional" json:"sourcePrefixLists" yaml:"sourcePrefixLists"`
}
Describes a packet header statement.
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"
packetHeaderStatementRequestProperty := &PacketHeaderStatementRequestProperty{
DestinationAddresses: []*string{
jsii.String("destinationAddresses"),
},
DestinationPorts: []*string{
jsii.String("destinationPorts"),
},
DestinationPrefixLists: []*string{
jsii.String("destinationPrefixLists"),
},
Protocols: []*string{
jsii.String("protocols"),
},
SourceAddresses: []*string{
jsii.String("sourceAddresses"),
},
SourcePorts: []*string{
jsii.String("sourcePorts"),
},
SourcePrefixLists: []*string{
jsii.String("sourcePrefixLists"),
},
}
type CfnNetworkInsightsAccessScope_PathStatementRequestProperty ¶ added in v2.9.0
type CfnNetworkInsightsAccessScope_PathStatementRequestProperty struct {
// The packet header statement.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsaccessscope-pathstatementrequest.html#cfn-ec2-networkinsightsaccessscope-pathstatementrequest-packetheaderstatement
//
PacketHeaderStatement interface{} `field:"optional" json:"packetHeaderStatement" yaml:"packetHeaderStatement"`
// The resource statement.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsaccessscope-pathstatementrequest.html#cfn-ec2-networkinsightsaccessscope-pathstatementrequest-resourcestatement
//
ResourceStatement interface{} `field:"optional" json:"resourceStatement" yaml:"resourceStatement"`
}
Describes a path statement.
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"
pathStatementRequestProperty := &PathStatementRequestProperty{
PacketHeaderStatement: &PacketHeaderStatementRequestProperty{
DestinationAddresses: []*string{
jsii.String("destinationAddresses"),
},
DestinationPorts: []*string{
jsii.String("destinationPorts"),
},
DestinationPrefixLists: []*string{
jsii.String("destinationPrefixLists"),
},
Protocols: []*string{
jsii.String("protocols"),
},
SourceAddresses: []*string{
jsii.String("sourceAddresses"),
},
SourcePorts: []*string{
jsii.String("sourcePorts"),
},
SourcePrefixLists: []*string{
jsii.String("sourcePrefixLists"),
},
},
ResourceStatement: &ResourceStatementRequestProperty{
Resources: []*string{
jsii.String("resources"),
},
ResourceTypes: []*string{
jsii.String("resourceTypes"),
},
},
}
type CfnNetworkInsightsAccessScope_ResourceStatementRequestProperty ¶ added in v2.9.0
type CfnNetworkInsightsAccessScope_ResourceStatementRequestProperty struct {
// The resources.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsaccessscope-resourcestatementrequest.html#cfn-ec2-networkinsightsaccessscope-resourcestatementrequest-resources
//
Resources *[]*string `field:"optional" json:"resources" yaml:"resources"`
// The resource types.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsaccessscope-resourcestatementrequest.html#cfn-ec2-networkinsightsaccessscope-resourcestatementrequest-resourcetypes
//
ResourceTypes *[]*string `field:"optional" json:"resourceTypes" yaml:"resourceTypes"`
}
Describes a resource statement.
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"
resourceStatementRequestProperty := &ResourceStatementRequestProperty{
Resources: []*string{
jsii.String("resources"),
},
ResourceTypes: []*string{
jsii.String("resourceTypes"),
},
}
type CfnNetworkInsightsAccessScope_ThroughResourcesStatementRequestProperty ¶ added in v2.9.0
type CfnNetworkInsightsAccessScope_ThroughResourcesStatementRequestProperty struct {
// The resource statement.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsaccessscope-throughresourcesstatementrequest.html#cfn-ec2-networkinsightsaccessscope-throughresourcesstatementrequest-resourcestatement
//
ResourceStatement interface{} `field:"optional" json:"resourceStatement" yaml:"resourceStatement"`
}
Describes a through resource statement.
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"
throughResourcesStatementRequestProperty := &ThroughResourcesStatementRequestProperty{
ResourceStatement: &ResourceStatementRequestProperty{
Resources: []*string{
jsii.String("resources"),
},
ResourceTypes: []*string{
jsii.String("resourceTypes"),
},
},
}
type CfnNetworkInsightsAnalysis ¶
type CfnNetworkInsightsAnalysis interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggable
// The member accounts that contain resources that the path can traverse.
AdditionalAccounts() *[]*string
SetAdditionalAccounts(val *[]*string)
// Potential intermediate components.
AttrAlternatePathHints() awscdk.IResolvable
// The explanations.
//
// For more information, see [Reachability Analyzer explanation codes](https://docs.aws.amazon.com/vpc/latest/reachability/explanation-codes.html) .
AttrExplanations() awscdk.IResolvable
// The components in the path from source to destination.
AttrForwardPathComponents() awscdk.IResolvable
// The Amazon Resource Name (ARN) of the network insights analysis.
AttrNetworkInsightsAnalysisArn() *string
// The ID of the network insights analysis.
AttrNetworkInsightsAnalysisId() *string
// Indicates whether the destination is reachable from the source.
AttrNetworkPathFound() awscdk.IResolvable
// The components in the path from destination to source.
AttrReturnPathComponents() awscdk.IResolvable
// The time the analysis started.
AttrStartDate() *string
// The status of the network insights analysis.
AttrStatus() *string
// The status message, if the status is `failed` .
AttrStatusMessage() *string
// The IDs of potential intermediate accounts.
AttrSuggestedAccounts() *[]*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 Amazon Resource Names (ARN) of the resources that the path must traverse.
FilterInArns() *[]*string
SetFilterInArns(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 ID of the path.
NetworkInsightsPathId() *string
SetNetworkInsightsPathId(val *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
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
// The tags to apply.
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{})
}
Specifies a network insights analysis.
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"
cfnNetworkInsightsAnalysis := awscdk.Aws_ec2.NewCfnNetworkInsightsAnalysis(this, jsii.String("MyCfnNetworkInsightsAnalysis"), &CfnNetworkInsightsAnalysisProps{
NetworkInsightsPathId: jsii.String("networkInsightsPathId"),
// the properties below are optional
AdditionalAccounts: []*string{
jsii.String("additionalAccounts"),
},
FilterInArns: []*string{
jsii.String("filterInArns"),
},
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
func NewCfnNetworkInsightsAnalysis ¶
func NewCfnNetworkInsightsAnalysis(scope constructs.Construct, id *string, props *CfnNetworkInsightsAnalysisProps) CfnNetworkInsightsAnalysis
type CfnNetworkInsightsAnalysisProps ¶
type CfnNetworkInsightsAnalysisProps struct {
// The ID of the path.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsanalysis.html#cfn-ec2-networkinsightsanalysis-networkinsightspathid
//
NetworkInsightsPathId *string `field:"required" json:"networkInsightsPathId" yaml:"networkInsightsPathId"`
// The member accounts that contain resources that the path can traverse.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsanalysis.html#cfn-ec2-networkinsightsanalysis-additionalaccounts
//
AdditionalAccounts *[]*string `field:"optional" json:"additionalAccounts" yaml:"additionalAccounts"`
// The Amazon Resource Names (ARN) of the resources that the path must traverse.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsanalysis.html#cfn-ec2-networkinsightsanalysis-filterinarns
//
FilterInArns *[]*string `field:"optional" json:"filterInArns" yaml:"filterInArns"`
// The tags to apply.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsanalysis.html#cfn-ec2-networkinsightsanalysis-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnNetworkInsightsAnalysis`.
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"
cfnNetworkInsightsAnalysisProps := &CfnNetworkInsightsAnalysisProps{
NetworkInsightsPathId: jsii.String("networkInsightsPathId"),
// the properties below are optional
AdditionalAccounts: []*string{
jsii.String("additionalAccounts"),
},
FilterInArns: []*string{
jsii.String("filterInArns"),
},
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
type CfnNetworkInsightsAnalysis_AdditionalDetailProperty ¶ added in v2.39.0
type CfnNetworkInsightsAnalysis_AdditionalDetailProperty struct {
// The additional detail code.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-additionaldetail.html#cfn-ec2-networkinsightsanalysis-additionaldetail-additionaldetailtype
//
AdditionalDetailType *string `field:"optional" json:"additionalDetailType" yaml:"additionalDetailType"`
// The path component.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-additionaldetail.html#cfn-ec2-networkinsightsanalysis-additionaldetail-component
//
Component interface{} `field:"optional" json:"component" yaml:"component"`
// The load balancers.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-additionaldetail.html#cfn-ec2-networkinsightsanalysis-additionaldetail-loadbalancers
//
LoadBalancers interface{} `field:"optional" json:"loadBalancers" yaml:"loadBalancers"`
// The name of the VPC endpoint service.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-additionaldetail.html#cfn-ec2-networkinsightsanalysis-additionaldetail-servicename
//
ServiceName *string `field:"optional" json:"serviceName" yaml:"serviceName"`
}
Describes an additional detail for a path analysis.
For more information, see [Reachability Analyzer additional detail codes](https://docs.aws.amazon.com/vpc/latest/reachability/additional-detail-codes.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"
additionalDetailProperty := &AdditionalDetailProperty{
AdditionalDetailType: jsii.String("additionalDetailType"),
Component: &AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
LoadBalancers: []interface{}{
&AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
},
ServiceName: jsii.String("serviceName"),
}
type CfnNetworkInsightsAnalysis_AlternatePathHintProperty ¶
type CfnNetworkInsightsAnalysis_AlternatePathHintProperty struct {
// The Amazon Resource Name (ARN) of the component.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-alternatepathhint.html#cfn-ec2-networkinsightsanalysis-alternatepathhint-componentarn
//
ComponentArn *string `field:"optional" json:"componentArn" yaml:"componentArn"`
// The ID of the component.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-alternatepathhint.html#cfn-ec2-networkinsightsanalysis-alternatepathhint-componentid
//
ComponentId *string `field:"optional" json:"componentId" yaml:"componentId"`
}
Describes an potential intermediate component of a feasible path.
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"
alternatePathHintProperty := &AlternatePathHintProperty{
ComponentArn: jsii.String("componentArn"),
ComponentId: jsii.String("componentId"),
}
type CfnNetworkInsightsAnalysis_AnalysisAclRuleProperty ¶
type CfnNetworkInsightsAnalysis_AnalysisAclRuleProperty struct {
// The IPv4 address range, in CIDR notation.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisaclrule.html#cfn-ec2-networkinsightsanalysis-analysisaclrule-cidr
//
Cidr *string `field:"optional" json:"cidr" yaml:"cidr"`
// Indicates whether the rule is an outbound rule.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisaclrule.html#cfn-ec2-networkinsightsanalysis-analysisaclrule-egress
//
Egress interface{} `field:"optional" json:"egress" yaml:"egress"`
// The range of ports.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisaclrule.html#cfn-ec2-networkinsightsanalysis-analysisaclrule-portrange
//
PortRange interface{} `field:"optional" json:"portRange" yaml:"portRange"`
// The protocol.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisaclrule.html#cfn-ec2-networkinsightsanalysis-analysisaclrule-protocol
//
Protocol *string `field:"optional" json:"protocol" yaml:"protocol"`
// Indicates whether to allow or deny traffic that matches the rule.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisaclrule.html#cfn-ec2-networkinsightsanalysis-analysisaclrule-ruleaction
//
RuleAction *string `field:"optional" json:"ruleAction" yaml:"ruleAction"`
// The rule number.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisaclrule.html#cfn-ec2-networkinsightsanalysis-analysisaclrule-rulenumber
//
RuleNumber *float64 `field:"optional" json:"ruleNumber" yaml:"ruleNumber"`
}
Describes a network access control (ACL) rule.
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"
analysisAclRuleProperty := &AnalysisAclRuleProperty{
Cidr: jsii.String("cidr"),
Egress: jsii.Boolean(false),
PortRange: &PortRangeProperty{
From: jsii.Number(123),
To: jsii.Number(123),
},
Protocol: jsii.String("protocol"),
RuleAction: jsii.String("ruleAction"),
RuleNumber: jsii.Number(123),
}
type CfnNetworkInsightsAnalysis_AnalysisComponentProperty ¶
type CfnNetworkInsightsAnalysis_AnalysisComponentProperty struct {
// The Amazon Resource Name (ARN) of the component.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysiscomponent.html#cfn-ec2-networkinsightsanalysis-analysiscomponent-arn
//
Arn *string `field:"optional" json:"arn" yaml:"arn"`
// The ID of the component.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysiscomponent.html#cfn-ec2-networkinsightsanalysis-analysiscomponent-id
//
Id *string `field:"optional" json:"id" yaml:"id"`
}
Describes a path component.
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"
analysisComponentProperty := &AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
}
type CfnNetworkInsightsAnalysis_AnalysisLoadBalancerListenerProperty ¶
type CfnNetworkInsightsAnalysis_AnalysisLoadBalancerListenerProperty struct {
// [Classic Load Balancers] The back-end port for the listener.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisloadbalancerlistener.html#cfn-ec2-networkinsightsanalysis-analysisloadbalancerlistener-instanceport
//
InstancePort *float64 `field:"optional" json:"instancePort" yaml:"instancePort"`
// The port on which the load balancer is listening.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisloadbalancerlistener.html#cfn-ec2-networkinsightsanalysis-analysisloadbalancerlistener-loadbalancerport
//
LoadBalancerPort *float64 `field:"optional" json:"loadBalancerPort" yaml:"loadBalancerPort"`
}
Describes a load balancer listener.
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"
analysisLoadBalancerListenerProperty := &AnalysisLoadBalancerListenerProperty{
InstancePort: jsii.Number(123),
LoadBalancerPort: jsii.Number(123),
}
type CfnNetworkInsightsAnalysis_AnalysisLoadBalancerTargetProperty ¶
type CfnNetworkInsightsAnalysis_AnalysisLoadBalancerTargetProperty struct {
// The IP address.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisloadbalancertarget.html#cfn-ec2-networkinsightsanalysis-analysisloadbalancertarget-address
//
Address *string `field:"optional" json:"address" yaml:"address"`
// The Availability Zone.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisloadbalancertarget.html#cfn-ec2-networkinsightsanalysis-analysisloadbalancertarget-availabilityzone
//
AvailabilityZone *string `field:"optional" json:"availabilityZone" yaml:"availabilityZone"`
// Information about the instance.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisloadbalancertarget.html#cfn-ec2-networkinsightsanalysis-analysisloadbalancertarget-instance
//
Instance interface{} `field:"optional" json:"instance" yaml:"instance"`
// The port on which the target is listening.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisloadbalancertarget.html#cfn-ec2-networkinsightsanalysis-analysisloadbalancertarget-port
//
Port *float64 `field:"optional" json:"port" yaml:"port"`
}
Describes a load balancer target.
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"
analysisLoadBalancerTargetProperty := &AnalysisLoadBalancerTargetProperty{
Address: jsii.String("address"),
AvailabilityZone: jsii.String("availabilityZone"),
Instance: &AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
Port: jsii.Number(123),
}
type CfnNetworkInsightsAnalysis_AnalysisPacketHeaderProperty ¶
type CfnNetworkInsightsAnalysis_AnalysisPacketHeaderProperty struct {
// The destination addresses.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysispacketheader.html#cfn-ec2-networkinsightsanalysis-analysispacketheader-destinationaddresses
//
DestinationAddresses *[]*string `field:"optional" json:"destinationAddresses" yaml:"destinationAddresses"`
// The destination port ranges.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysispacketheader.html#cfn-ec2-networkinsightsanalysis-analysispacketheader-destinationportranges
//
DestinationPortRanges interface{} `field:"optional" json:"destinationPortRanges" yaml:"destinationPortRanges"`
// The protocol.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysispacketheader.html#cfn-ec2-networkinsightsanalysis-analysispacketheader-protocol
//
Protocol *string `field:"optional" json:"protocol" yaml:"protocol"`
// The source addresses.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysispacketheader.html#cfn-ec2-networkinsightsanalysis-analysispacketheader-sourceaddresses
//
SourceAddresses *[]*string `field:"optional" json:"sourceAddresses" yaml:"sourceAddresses"`
// The source port ranges.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysispacketheader.html#cfn-ec2-networkinsightsanalysis-analysispacketheader-sourceportranges
//
SourcePortRanges interface{} `field:"optional" json:"sourcePortRanges" yaml:"sourcePortRanges"`
}
Describes a header.
Reflects any changes made by a component as traffic passes through. The fields of an inbound header are null except for the first component of a path.
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"
analysisPacketHeaderProperty := &AnalysisPacketHeaderProperty{
DestinationAddresses: []*string{
jsii.String("destinationAddresses"),
},
DestinationPortRanges: []interface{}{
&PortRangeProperty{
From: jsii.Number(123),
To: jsii.Number(123),
},
},
Protocol: jsii.String("protocol"),
SourceAddresses: []*string{
jsii.String("sourceAddresses"),
},
SourcePortRanges: []interface{}{
&PortRangeProperty{
From: jsii.Number(123),
To: jsii.Number(123),
},
},
}
type CfnNetworkInsightsAnalysis_AnalysisRouteTableRouteProperty ¶
type CfnNetworkInsightsAnalysis_AnalysisRouteTableRouteProperty struct {
// The destination IPv4 address, in CIDR notation.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisroutetableroute.html#cfn-ec2-networkinsightsanalysis-analysisroutetableroute-destinationcidr
//
DestinationCidr *string `field:"optional" json:"destinationCidr" yaml:"destinationCidr"`
// The prefix of the AWS service.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisroutetableroute.html#cfn-ec2-networkinsightsanalysis-analysisroutetableroute-destinationprefixlistid
//
DestinationPrefixListId *string `field:"optional" json:"destinationPrefixListId" yaml:"destinationPrefixListId"`
// The ID of an egress-only internet gateway.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisroutetableroute.html#cfn-ec2-networkinsightsanalysis-analysisroutetableroute-egressonlyinternetgatewayid
//
EgressOnlyInternetGatewayId *string `field:"optional" json:"egressOnlyInternetGatewayId" yaml:"egressOnlyInternetGatewayId"`
// The ID of the gateway, such as an internet gateway or virtual private gateway.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisroutetableroute.html#cfn-ec2-networkinsightsanalysis-analysisroutetableroute-gatewayid
//
GatewayId *string `field:"optional" json:"gatewayId" yaml:"gatewayId"`
// The ID of the instance, such as a NAT instance.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisroutetableroute.html#cfn-ec2-networkinsightsanalysis-analysisroutetableroute-instanceid
//
InstanceId *string `field:"optional" json:"instanceId" yaml:"instanceId"`
// The ID of a NAT gateway.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisroutetableroute.html#cfn-ec2-networkinsightsanalysis-analysisroutetableroute-natgatewayid
//
NatGatewayId *string `field:"optional" json:"natGatewayId" yaml:"natGatewayId"`
// The ID of a network interface.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisroutetableroute.html#cfn-ec2-networkinsightsanalysis-analysisroutetableroute-networkinterfaceid
//
NetworkInterfaceId *string `field:"optional" json:"networkInterfaceId" yaml:"networkInterfaceId"`
// Describes how the route was created. The following are the possible values:.
//
// - CreateRouteTable - The route was automatically created when the route table was created.
// - CreateRoute - The route was manually added to the route table.
// - EnableVgwRoutePropagation - The route was propagated by route propagation.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisroutetableroute.html#cfn-ec2-networkinsightsanalysis-analysisroutetableroute-origin
//
Origin *string `field:"optional" json:"origin" yaml:"origin"`
// The state. The following are the possible values:.
//
// - active
// - blackhole.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisroutetableroute.html#cfn-ec2-networkinsightsanalysis-analysisroutetableroute-state
//
State *string `field:"optional" json:"state" yaml:"state"`
// The ID of a transit gateway.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisroutetableroute.html#cfn-ec2-networkinsightsanalysis-analysisroutetableroute-transitgatewayid
//
TransitGatewayId *string `field:"optional" json:"transitGatewayId" yaml:"transitGatewayId"`
// The ID of a VPC peering connection.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisroutetableroute.html#cfn-ec2-networkinsightsanalysis-analysisroutetableroute-vpcpeeringconnectionid
//
VpcPeeringConnectionId *string `field:"optional" json:"vpcPeeringConnectionId" yaml:"vpcPeeringConnectionId"`
}
Describes a route table route.
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"
analysisRouteTableRouteProperty := &AnalysisRouteTableRouteProperty{
DestinationCidr: jsii.String("destinationCidr"),
DestinationPrefixListId: jsii.String("destinationPrefixListId"),
EgressOnlyInternetGatewayId: jsii.String("egressOnlyInternetGatewayId"),
GatewayId: jsii.String("gatewayId"),
InstanceId: jsii.String("instanceId"),
NatGatewayId: jsii.String("natGatewayId"),
NetworkInterfaceId: jsii.String("networkInterfaceId"),
Origin: jsii.String("origin"),
State: jsii.String("state"),
TransitGatewayId: jsii.String("transitGatewayId"),
VpcPeeringConnectionId: jsii.String("vpcPeeringConnectionId"),
}
type CfnNetworkInsightsAnalysis_AnalysisSecurityGroupRuleProperty ¶
type CfnNetworkInsightsAnalysis_AnalysisSecurityGroupRuleProperty struct {
// The IPv4 address range, in CIDR notation.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysissecuritygrouprule.html#cfn-ec2-networkinsightsanalysis-analysissecuritygrouprule-cidr
//
Cidr *string `field:"optional" json:"cidr" yaml:"cidr"`
// The direction. The following are the possible values:.
//
// - egress
// - ingress.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysissecuritygrouprule.html#cfn-ec2-networkinsightsanalysis-analysissecuritygrouprule-direction
//
Direction *string `field:"optional" json:"direction" yaml:"direction"`
// The port range.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysissecuritygrouprule.html#cfn-ec2-networkinsightsanalysis-analysissecuritygrouprule-portrange
//
PortRange interface{} `field:"optional" json:"portRange" yaml:"portRange"`
// The prefix list ID.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysissecuritygrouprule.html#cfn-ec2-networkinsightsanalysis-analysissecuritygrouprule-prefixlistid
//
PrefixListId *string `field:"optional" json:"prefixListId" yaml:"prefixListId"`
// The protocol name.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysissecuritygrouprule.html#cfn-ec2-networkinsightsanalysis-analysissecuritygrouprule-protocol
//
Protocol *string `field:"optional" json:"protocol" yaml:"protocol"`
// The security group ID.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysissecuritygrouprule.html#cfn-ec2-networkinsightsanalysis-analysissecuritygrouprule-securitygroupid
//
SecurityGroupId *string `field:"optional" json:"securityGroupId" yaml:"securityGroupId"`
}
Describes a security group rule.
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"
analysisSecurityGroupRuleProperty := &AnalysisSecurityGroupRuleProperty{
Cidr: jsii.String("cidr"),
Direction: jsii.String("direction"),
PortRange: &PortRangeProperty{
From: jsii.Number(123),
To: jsii.Number(123),
},
PrefixListId: jsii.String("prefixListId"),
Protocol: jsii.String("protocol"),
SecurityGroupId: jsii.String("securityGroupId"),
}
type CfnNetworkInsightsAnalysis_ExplanationProperty ¶
type CfnNetworkInsightsAnalysis_ExplanationProperty struct {
// The network ACL.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-acl
//
Acl interface{} `field:"optional" json:"acl" yaml:"acl"`
// The network ACL rule.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-aclrule
//
AclRule interface{} `field:"optional" json:"aclRule" yaml:"aclRule"`
// The IPv4 address, in CIDR notation.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-address
//
Address *string `field:"optional" json:"address" yaml:"address"`
// The IPv4 addresses, in CIDR notation.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-addresses
//
Addresses *[]*string `field:"optional" json:"addresses" yaml:"addresses"`
// The resource to which the component is attached.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-attachedto
//
AttachedTo interface{} `field:"optional" json:"attachedTo" yaml:"attachedTo"`
// The Availability Zones.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-availabilityzones
//
AvailabilityZones *[]*string `field:"optional" json:"availabilityZones" yaml:"availabilityZones"`
// The CIDR ranges.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-cidrs
//
Cidrs *[]*string `field:"optional" json:"cidrs" yaml:"cidrs"`
// The listener for a Classic Load Balancer.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-classicloadbalancerlistener
//
ClassicLoadBalancerListener interface{} `field:"optional" json:"classicLoadBalancerListener" yaml:"classicLoadBalancerListener"`
// The component.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-component
//
Component interface{} `field:"optional" json:"component" yaml:"component"`
// The AWS account for the component.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-componentaccount
//
ComponentAccount *string `field:"optional" json:"componentAccount" yaml:"componentAccount"`
// The Region for the component.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-componentregion
//
ComponentRegion *string `field:"optional" json:"componentRegion" yaml:"componentRegion"`
// The customer gateway.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-customergateway
//
CustomerGateway interface{} `field:"optional" json:"customerGateway" yaml:"customerGateway"`
// The destination.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-destination
//
Destination interface{} `field:"optional" json:"destination" yaml:"destination"`
// The destination VPC.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-destinationvpc
//
DestinationVpc interface{} `field:"optional" json:"destinationVpc" yaml:"destinationVpc"`
// The direction. The following are the possible values:.
//
// - egress
// - ingress.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-direction
//
Direction *string `field:"optional" json:"direction" yaml:"direction"`
// The load balancer listener.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-elasticloadbalancerlistener
//
ElasticLoadBalancerListener interface{} `field:"optional" json:"elasticLoadBalancerListener" yaml:"elasticLoadBalancerListener"`
// The explanation code.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-explanationcode
//
ExplanationCode *string `field:"optional" json:"explanationCode" yaml:"explanationCode"`
// The route table.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-ingressroutetable
//
IngressRouteTable interface{} `field:"optional" json:"ingressRouteTable" yaml:"ingressRouteTable"`
// The internet gateway.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-internetgateway
//
InternetGateway interface{} `field:"optional" json:"internetGateway" yaml:"internetGateway"`
// The Amazon Resource Name (ARN) of the load balancer.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-loadbalancerarn
//
LoadBalancerArn *string `field:"optional" json:"loadBalancerArn" yaml:"loadBalancerArn"`
// The listener port of the load balancer.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-loadbalancerlistenerport
//
LoadBalancerListenerPort *float64 `field:"optional" json:"loadBalancerListenerPort" yaml:"loadBalancerListenerPort"`
// The target.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-loadbalancertarget
//
LoadBalancerTarget interface{} `field:"optional" json:"loadBalancerTarget" yaml:"loadBalancerTarget"`
// The target group.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-loadbalancertargetgroup
//
LoadBalancerTargetGroup interface{} `field:"optional" json:"loadBalancerTargetGroup" yaml:"loadBalancerTargetGroup"`
// The target groups.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-loadbalancertargetgroups
//
LoadBalancerTargetGroups interface{} `field:"optional" json:"loadBalancerTargetGroups" yaml:"loadBalancerTargetGroups"`
// The target port.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-loadbalancertargetport
//
LoadBalancerTargetPort *float64 `field:"optional" json:"loadBalancerTargetPort" yaml:"loadBalancerTargetPort"`
// The missing component.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-missingcomponent
//
MissingComponent *string `field:"optional" json:"missingComponent" yaml:"missingComponent"`
// The NAT gateway.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-natgateway
//
NatGateway interface{} `field:"optional" json:"natGateway" yaml:"natGateway"`
// The network interface.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-networkinterface
//
NetworkInterface interface{} `field:"optional" json:"networkInterface" yaml:"networkInterface"`
// The packet field.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-packetfield
//
PacketField *string `field:"optional" json:"packetField" yaml:"packetField"`
// The port.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-port
//
Port *float64 `field:"optional" json:"port" yaml:"port"`
// The port ranges.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-portranges
//
PortRanges interface{} `field:"optional" json:"portRanges" yaml:"portRanges"`
// The prefix list.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-prefixlist
//
PrefixList interface{} `field:"optional" json:"prefixList" yaml:"prefixList"`
// The protocols.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-protocols
//
Protocols *[]*string `field:"optional" json:"protocols" yaml:"protocols"`
// The route table.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-routetable
//
RouteTable interface{} `field:"optional" json:"routeTable" yaml:"routeTable"`
// The route table route.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-routetableroute
//
RouteTableRoute interface{} `field:"optional" json:"routeTableRoute" yaml:"routeTableRoute"`
// The security group.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-securitygroup
//
SecurityGroup interface{} `field:"optional" json:"securityGroup" yaml:"securityGroup"`
// The security group rule.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-securitygrouprule
//
SecurityGroupRule interface{} `field:"optional" json:"securityGroupRule" yaml:"securityGroupRule"`
// The security groups.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-securitygroups
//
SecurityGroups interface{} `field:"optional" json:"securityGroups" yaml:"securityGroups"`
// The source VPC.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-sourcevpc
//
SourceVpc interface{} `field:"optional" json:"sourceVpc" yaml:"sourceVpc"`
// The state.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-state
//
State *string `field:"optional" json:"state" yaml:"state"`
// The subnet.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-subnet
//
Subnet interface{} `field:"optional" json:"subnet" yaml:"subnet"`
// The route table for the subnet.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-subnetroutetable
//
SubnetRouteTable interface{} `field:"optional" json:"subnetRouteTable" yaml:"subnetRouteTable"`
// The transit gateway.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-transitgateway
//
TransitGateway interface{} `field:"optional" json:"transitGateway" yaml:"transitGateway"`
// The transit gateway attachment.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-transitgatewayattachment
//
TransitGatewayAttachment interface{} `field:"optional" json:"transitGatewayAttachment" yaml:"transitGatewayAttachment"`
// The transit gateway route table.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-transitgatewayroutetable
//
TransitGatewayRouteTable interface{} `field:"optional" json:"transitGatewayRouteTable" yaml:"transitGatewayRouteTable"`
// The transit gateway route table route.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-transitgatewayroutetableroute
//
TransitGatewayRouteTableRoute interface{} `field:"optional" json:"transitGatewayRouteTableRoute" yaml:"transitGatewayRouteTableRoute"`
// The component VPC.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-vpc
//
Vpc interface{} `field:"optional" json:"vpc" yaml:"vpc"`
// The VPC endpoint.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-vpcendpoint
//
VpcEndpoint interface{} `field:"optional" json:"vpcEndpoint" yaml:"vpcEndpoint"`
// The VPC peering connection.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-vpcpeeringconnection
//
VpcPeeringConnection interface{} `field:"optional" json:"vpcPeeringConnection" yaml:"vpcPeeringConnection"`
// The VPN connection.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-vpnconnection
//
VpnConnection interface{} `field:"optional" json:"vpnConnection" yaml:"vpnConnection"`
// The VPN gateway.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-explanation.html#cfn-ec2-networkinsightsanalysis-explanation-vpngateway
//
VpnGateway interface{} `field:"optional" json:"vpnGateway" yaml:"vpnGateway"`
}
Describes an explanation code for an unreachable path.
For more information, see [Reachability Analyzer explanation codes](https://docs.aws.amazon.com/vpc/latest/reachability/explanation-codes.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"
explanationProperty := &ExplanationProperty{
Acl: &AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
AclRule: &AnalysisAclRuleProperty{
Cidr: jsii.String("cidr"),
Egress: jsii.Boolean(false),
PortRange: &PortRangeProperty{
From: jsii.Number(123),
To: jsii.Number(123),
},
Protocol: jsii.String("protocol"),
RuleAction: jsii.String("ruleAction"),
RuleNumber: jsii.Number(123),
},
Address: jsii.String("address"),
Addresses: []*string{
jsii.String("addresses"),
},
AttachedTo: &AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
AvailabilityZones: []*string{
jsii.String("availabilityZones"),
},
Cidrs: []*string{
jsii.String("cidrs"),
},
ClassicLoadBalancerListener: &AnalysisLoadBalancerListenerProperty{
InstancePort: jsii.Number(123),
LoadBalancerPort: jsii.Number(123),
},
Component: &AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
ComponentAccount: jsii.String("componentAccount"),
ComponentRegion: jsii.String("componentRegion"),
CustomerGateway: &AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
Destination: &AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
DestinationVpc: &AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
Direction: jsii.String("direction"),
ElasticLoadBalancerListener: &AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
ExplanationCode: jsii.String("explanationCode"),
IngressRouteTable: &AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
InternetGateway: &AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
LoadBalancerArn: jsii.String("loadBalancerArn"),
LoadBalancerListenerPort: jsii.Number(123),
LoadBalancerTarget: &AnalysisLoadBalancerTargetProperty{
Address: jsii.String("address"),
AvailabilityZone: jsii.String("availabilityZone"),
Instance: &AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
Port: jsii.Number(123),
},
LoadBalancerTargetGroup: &AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
LoadBalancerTargetGroups: []interface{}{
&AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
},
LoadBalancerTargetPort: jsii.Number(123),
MissingComponent: jsii.String("missingComponent"),
NatGateway: &AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
NetworkInterface: &AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
PacketField: jsii.String("packetField"),
Port: jsii.Number(123),
PortRanges: []interface{}{
&PortRangeProperty{
From: jsii.Number(123),
To: jsii.Number(123),
},
},
PrefixList: &AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
Protocols: []*string{
jsii.String("protocols"),
},
RouteTable: &AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
RouteTableRoute: &AnalysisRouteTableRouteProperty{
DestinationCidr: jsii.String("destinationCidr"),
DestinationPrefixListId: jsii.String("destinationPrefixListId"),
EgressOnlyInternetGatewayId: jsii.String("egressOnlyInternetGatewayId"),
GatewayId: jsii.String("gatewayId"),
InstanceId: jsii.String("instanceId"),
NatGatewayId: jsii.String("natGatewayId"),
NetworkInterfaceId: jsii.String("networkInterfaceId"),
Origin: jsii.String("origin"),
State: jsii.String("state"),
TransitGatewayId: jsii.String("transitGatewayId"),
VpcPeeringConnectionId: jsii.String("vpcPeeringConnectionId"),
},
SecurityGroup: &AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
SecurityGroupRule: &AnalysisSecurityGroupRuleProperty{
Cidr: jsii.String("cidr"),
Direction: jsii.String("direction"),
PortRange: &PortRangeProperty{
From: jsii.Number(123),
To: jsii.Number(123),
},
PrefixListId: jsii.String("prefixListId"),
Protocol: jsii.String("protocol"),
SecurityGroupId: jsii.String("securityGroupId"),
},
SecurityGroups: []interface{}{
&AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
},
SourceVpc: &AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
State: jsii.String("state"),
Subnet: &AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
SubnetRouteTable: &AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
TransitGateway: &AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
TransitGatewayAttachment: &AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
TransitGatewayRouteTable: &AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
TransitGatewayRouteTableRoute: &TransitGatewayRouteTableRouteProperty{
AttachmentId: jsii.String("attachmentId"),
DestinationCidr: jsii.String("destinationCidr"),
PrefixListId: jsii.String("prefixListId"),
ResourceId: jsii.String("resourceId"),
ResourceType: jsii.String("resourceType"),
RouteOrigin: jsii.String("routeOrigin"),
State: jsii.String("state"),
},
Vpc: &AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
VpcEndpoint: &AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
VpcPeeringConnection: &AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
VpnConnection: &AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
VpnGateway: &AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
}
type CfnNetworkInsightsAnalysis_PathComponentProperty ¶
type CfnNetworkInsightsAnalysis_PathComponentProperty struct {
// The network ACL rule.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-pathcomponent.html#cfn-ec2-networkinsightsanalysis-pathcomponent-aclrule
//
AclRule interface{} `field:"optional" json:"aclRule" yaml:"aclRule"`
// The additional details.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-pathcomponent.html#cfn-ec2-networkinsightsanalysis-pathcomponent-additionaldetails
//
AdditionalDetails interface{} `field:"optional" json:"additionalDetails" yaml:"additionalDetails"`
// The component.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-pathcomponent.html#cfn-ec2-networkinsightsanalysis-pathcomponent-component
//
Component interface{} `field:"optional" json:"component" yaml:"component"`
// The destination VPC.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-pathcomponent.html#cfn-ec2-networkinsightsanalysis-pathcomponent-destinationvpc
//
DestinationVpc interface{} `field:"optional" json:"destinationVpc" yaml:"destinationVpc"`
// The load balancer listener.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-pathcomponent.html#cfn-ec2-networkinsightsanalysis-pathcomponent-elasticloadbalancerlistener
//
ElasticLoadBalancerListener interface{} `field:"optional" json:"elasticLoadBalancerListener" yaml:"elasticLoadBalancerListener"`
// The explanation codes.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-pathcomponent.html#cfn-ec2-networkinsightsanalysis-pathcomponent-explanations
//
Explanations interface{} `field:"optional" json:"explanations" yaml:"explanations"`
// The inbound header.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-pathcomponent.html#cfn-ec2-networkinsightsanalysis-pathcomponent-inboundheader
//
InboundHeader interface{} `field:"optional" json:"inboundHeader" yaml:"inboundHeader"`
// The outbound header.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-pathcomponent.html#cfn-ec2-networkinsightsanalysis-pathcomponent-outboundheader
//
OutboundHeader interface{} `field:"optional" json:"outboundHeader" yaml:"outboundHeader"`
// The route table route.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-pathcomponent.html#cfn-ec2-networkinsightsanalysis-pathcomponent-routetableroute
//
RouteTableRoute interface{} `field:"optional" json:"routeTableRoute" yaml:"routeTableRoute"`
// The security group rule.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-pathcomponent.html#cfn-ec2-networkinsightsanalysis-pathcomponent-securitygrouprule
//
SecurityGroupRule interface{} `field:"optional" json:"securityGroupRule" yaml:"securityGroupRule"`
// The sequence number.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-pathcomponent.html#cfn-ec2-networkinsightsanalysis-pathcomponent-sequencenumber
//
SequenceNumber *float64 `field:"optional" json:"sequenceNumber" yaml:"sequenceNumber"`
// The name of the VPC endpoint service.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-pathcomponent.html#cfn-ec2-networkinsightsanalysis-pathcomponent-servicename
//
ServiceName *string `field:"optional" json:"serviceName" yaml:"serviceName"`
// The source VPC.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-pathcomponent.html#cfn-ec2-networkinsightsanalysis-pathcomponent-sourcevpc
//
SourceVpc interface{} `field:"optional" json:"sourceVpc" yaml:"sourceVpc"`
// The subnet.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-pathcomponent.html#cfn-ec2-networkinsightsanalysis-pathcomponent-subnet
//
Subnet interface{} `field:"optional" json:"subnet" yaml:"subnet"`
// The transit gateway.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-pathcomponent.html#cfn-ec2-networkinsightsanalysis-pathcomponent-transitgateway
//
TransitGateway interface{} `field:"optional" json:"transitGateway" yaml:"transitGateway"`
// The route in a transit gateway route table.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-pathcomponent.html#cfn-ec2-networkinsightsanalysis-pathcomponent-transitgatewayroutetableroute
//
TransitGatewayRouteTableRoute interface{} `field:"optional" json:"transitGatewayRouteTableRoute" yaml:"transitGatewayRouteTableRoute"`
// The component VPC.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-pathcomponent.html#cfn-ec2-networkinsightsanalysis-pathcomponent-vpc
//
Vpc interface{} `field:"optional" json:"vpc" yaml:"vpc"`
}
Describes a path component.
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"
pathComponentProperty := &PathComponentProperty{
AclRule: &AnalysisAclRuleProperty{
Cidr: jsii.String("cidr"),
Egress: jsii.Boolean(false),
PortRange: &PortRangeProperty{
From: jsii.Number(123),
To: jsii.Number(123),
},
Protocol: jsii.String("protocol"),
RuleAction: jsii.String("ruleAction"),
RuleNumber: jsii.Number(123),
},
AdditionalDetails: []interface{}{
&AdditionalDetailProperty{
AdditionalDetailType: jsii.String("additionalDetailType"),
Component: &AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
LoadBalancers: []interface{}{
&AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
},
ServiceName: jsii.String("serviceName"),
},
},
Component: &AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
DestinationVpc: &AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
ElasticLoadBalancerListener: &AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
Explanations: []interface{}{
&ExplanationProperty{
Acl: &AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
AclRule: &AnalysisAclRuleProperty{
Cidr: jsii.String("cidr"),
Egress: jsii.Boolean(false),
PortRange: &PortRangeProperty{
From: jsii.Number(123),
To: jsii.Number(123),
},
Protocol: jsii.String("protocol"),
RuleAction: jsii.String("ruleAction"),
RuleNumber: jsii.Number(123),
},
Address: jsii.String("address"),
Addresses: []*string{
jsii.String("addresses"),
},
AttachedTo: &AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
AvailabilityZones: []*string{
jsii.String("availabilityZones"),
},
Cidrs: []*string{
jsii.String("cidrs"),
},
ClassicLoadBalancerListener: &AnalysisLoadBalancerListenerProperty{
InstancePort: jsii.Number(123),
LoadBalancerPort: jsii.Number(123),
},
Component: &AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
ComponentAccount: jsii.String("componentAccount"),
ComponentRegion: jsii.String("componentRegion"),
CustomerGateway: &AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
Destination: &AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
DestinationVpc: &AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
Direction: jsii.String("direction"),
ElasticLoadBalancerListener: &AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
ExplanationCode: jsii.String("explanationCode"),
IngressRouteTable: &AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
InternetGateway: &AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
LoadBalancerArn: jsii.String("loadBalancerArn"),
LoadBalancerListenerPort: jsii.Number(123),
LoadBalancerTarget: &AnalysisLoadBalancerTargetProperty{
Address: jsii.String("address"),
AvailabilityZone: jsii.String("availabilityZone"),
Instance: &AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
Port: jsii.Number(123),
},
LoadBalancerTargetGroup: &AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
LoadBalancerTargetGroups: []interface{}{
&AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
},
LoadBalancerTargetPort: jsii.Number(123),
MissingComponent: jsii.String("missingComponent"),
NatGateway: &AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
NetworkInterface: &AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
PacketField: jsii.String("packetField"),
Port: jsii.Number(123),
PortRanges: []interface{}{
&PortRangeProperty{
From: jsii.Number(123),
To: jsii.Number(123),
},
},
PrefixList: &AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
Protocols: []*string{
jsii.String("protocols"),
},
RouteTable: &AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
RouteTableRoute: &AnalysisRouteTableRouteProperty{
DestinationCidr: jsii.String("destinationCidr"),
DestinationPrefixListId: jsii.String("destinationPrefixListId"),
EgressOnlyInternetGatewayId: jsii.String("egressOnlyInternetGatewayId"),
GatewayId: jsii.String("gatewayId"),
InstanceId: jsii.String("instanceId"),
NatGatewayId: jsii.String("natGatewayId"),
NetworkInterfaceId: jsii.String("networkInterfaceId"),
Origin: jsii.String("origin"),
State: jsii.String("state"),
TransitGatewayId: jsii.String("transitGatewayId"),
VpcPeeringConnectionId: jsii.String("vpcPeeringConnectionId"),
},
SecurityGroup: &AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
SecurityGroupRule: &AnalysisSecurityGroupRuleProperty{
Cidr: jsii.String("cidr"),
Direction: jsii.String("direction"),
PortRange: &PortRangeProperty{
From: jsii.Number(123),
To: jsii.Number(123),
},
PrefixListId: jsii.String("prefixListId"),
Protocol: jsii.String("protocol"),
SecurityGroupId: jsii.String("securityGroupId"),
},
SecurityGroups: []interface{}{
&AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
},
SourceVpc: &AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
State: jsii.String("state"),
Subnet: &AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
SubnetRouteTable: &AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
TransitGateway: &AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
TransitGatewayAttachment: &AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
TransitGatewayRouteTable: &AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
TransitGatewayRouteTableRoute: &TransitGatewayRouteTableRouteProperty{
AttachmentId: jsii.String("attachmentId"),
DestinationCidr: jsii.String("destinationCidr"),
PrefixListId: jsii.String("prefixListId"),
ResourceId: jsii.String("resourceId"),
ResourceType: jsii.String("resourceType"),
RouteOrigin: jsii.String("routeOrigin"),
State: jsii.String("state"),
},
Vpc: &AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
VpcEndpoint: &AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
VpcPeeringConnection: &AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
VpnConnection: &AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
VpnGateway: &AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
},
},
InboundHeader: &AnalysisPacketHeaderProperty{
DestinationAddresses: []*string{
jsii.String("destinationAddresses"),
},
DestinationPortRanges: []interface{}{
&PortRangeProperty{
From: jsii.Number(123),
To: jsii.Number(123),
},
},
Protocol: jsii.String("protocol"),
SourceAddresses: []*string{
jsii.String("sourceAddresses"),
},
SourcePortRanges: []interface{}{
&PortRangeProperty{
From: jsii.Number(123),
To: jsii.Number(123),
},
},
},
OutboundHeader: &AnalysisPacketHeaderProperty{
DestinationAddresses: []*string{
jsii.String("destinationAddresses"),
},
DestinationPortRanges: []interface{}{
&PortRangeProperty{
From: jsii.Number(123),
To: jsii.Number(123),
},
},
Protocol: jsii.String("protocol"),
SourceAddresses: []*string{
jsii.String("sourceAddresses"),
},
SourcePortRanges: []interface{}{
&PortRangeProperty{
From: jsii.Number(123),
To: jsii.Number(123),
},
},
},
RouteTableRoute: &AnalysisRouteTableRouteProperty{
DestinationCidr: jsii.String("destinationCidr"),
DestinationPrefixListId: jsii.String("destinationPrefixListId"),
EgressOnlyInternetGatewayId: jsii.String("egressOnlyInternetGatewayId"),
GatewayId: jsii.String("gatewayId"),
InstanceId: jsii.String("instanceId"),
NatGatewayId: jsii.String("natGatewayId"),
NetworkInterfaceId: jsii.String("networkInterfaceId"),
Origin: jsii.String("origin"),
State: jsii.String("state"),
TransitGatewayId: jsii.String("transitGatewayId"),
VpcPeeringConnectionId: jsii.String("vpcPeeringConnectionId"),
},
SecurityGroupRule: &AnalysisSecurityGroupRuleProperty{
Cidr: jsii.String("cidr"),
Direction: jsii.String("direction"),
PortRange: &PortRangeProperty{
From: jsii.Number(123),
To: jsii.Number(123),
},
PrefixListId: jsii.String("prefixListId"),
Protocol: jsii.String("protocol"),
SecurityGroupId: jsii.String("securityGroupId"),
},
SequenceNumber: jsii.Number(123),
ServiceName: jsii.String("serviceName"),
SourceVpc: &AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
Subnet: &AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
TransitGateway: &AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
TransitGatewayRouteTableRoute: &TransitGatewayRouteTableRouteProperty{
AttachmentId: jsii.String("attachmentId"),
DestinationCidr: jsii.String("destinationCidr"),
PrefixListId: jsii.String("prefixListId"),
ResourceId: jsii.String("resourceId"),
ResourceType: jsii.String("resourceType"),
RouteOrigin: jsii.String("routeOrigin"),
State: jsii.String("state"),
},
Vpc: &AnalysisComponentProperty{
Arn: jsii.String("arn"),
Id: jsii.String("id"),
},
}
type CfnNetworkInsightsAnalysis_PortRangeProperty ¶
type CfnNetworkInsightsAnalysis_PortRangeProperty struct {
// The first port in the range.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-portrange.html#cfn-ec2-networkinsightsanalysis-portrange-from
//
From *float64 `field:"optional" json:"from" yaml:"from"`
// The last port in the range.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-portrange.html#cfn-ec2-networkinsightsanalysis-portrange-to
//
To *float64 `field:"optional" json:"to" yaml:"to"`
}
Describes a range of ports.
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"
portRangeProperty := &PortRangeProperty{
From: jsii.Number(123),
To: jsii.Number(123),
}
type CfnNetworkInsightsAnalysis_TransitGatewayRouteTableRouteProperty ¶ added in v2.25.0
type CfnNetworkInsightsAnalysis_TransitGatewayRouteTableRouteProperty struct {
// The ID of the route attachment.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-transitgatewayroutetableroute.html#cfn-ec2-networkinsightsanalysis-transitgatewayroutetableroute-attachmentid
//
AttachmentId *string `field:"optional" json:"attachmentId" yaml:"attachmentId"`
// The CIDR block used for destination matches.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-transitgatewayroutetableroute.html#cfn-ec2-networkinsightsanalysis-transitgatewayroutetableroute-destinationcidr
//
DestinationCidr *string `field:"optional" json:"destinationCidr" yaml:"destinationCidr"`
// The ID of the prefix list.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-transitgatewayroutetableroute.html#cfn-ec2-networkinsightsanalysis-transitgatewayroutetableroute-prefixlistid
//
PrefixListId *string `field:"optional" json:"prefixListId" yaml:"prefixListId"`
// The ID of the resource for the route attachment.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-transitgatewayroutetableroute.html#cfn-ec2-networkinsightsanalysis-transitgatewayroutetableroute-resourceid
//
ResourceId *string `field:"optional" json:"resourceId" yaml:"resourceId"`
// The resource type for the route attachment.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-transitgatewayroutetableroute.html#cfn-ec2-networkinsightsanalysis-transitgatewayroutetableroute-resourcetype
//
ResourceType *string `field:"optional" json:"resourceType" yaml:"resourceType"`
// The route origin. The following are the possible values:.
//
// - static
// - propagated.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-transitgatewayroutetableroute.html#cfn-ec2-networkinsightsanalysis-transitgatewayroutetableroute-routeorigin
//
RouteOrigin *string `field:"optional" json:"routeOrigin" yaml:"routeOrigin"`
// The state of the route.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-transitgatewayroutetableroute.html#cfn-ec2-networkinsightsanalysis-transitgatewayroutetableroute-state
//
State *string `field:"optional" json:"state" yaml:"state"`
}
Describes a route in a transit gateway route table.
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"
transitGatewayRouteTableRouteProperty := &TransitGatewayRouteTableRouteProperty{
AttachmentId: jsii.String("attachmentId"),
DestinationCidr: jsii.String("destinationCidr"),
PrefixListId: jsii.String("prefixListId"),
ResourceId: jsii.String("resourceId"),
ResourceType: jsii.String("resourceType"),
RouteOrigin: jsii.String("routeOrigin"),
State: jsii.String("state"),
}
type CfnNetworkInsightsPath ¶
type CfnNetworkInsightsPath interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggable
// The time stamp when the path was created.
AttrCreatedDate() *string
// The Amazon Resource Name (ARN) of the destination.
AttrDestinationArn() *string
// The Amazon Resource Name (ARN) of the path.
AttrNetworkInsightsPathArn() *string
// The ID of the path.
AttrNetworkInsightsPathId() *string
// The Amazon Resource Name (ARN) of the source.
AttrSourceArn() *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 ID or ARN of the destination.
Destination() *string
SetDestination(val *string)
// The IP address of the destination.
DestinationIp() *string
SetDestinationIp(val *string)
// The destination port.
DestinationPort() *float64
SetDestinationPort(val *float64)
// Scopes the analysis to network paths that match specific filters at the destination.
FilterAtDestination() interface{}
SetFilterAtDestination(val interface{})
// Scopes the analysis to network paths that match specific filters at the source.
FilterAtSource() interface{}
SetFilterAtSource(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 protocol.
Protocol() *string
SetProtocol(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 ID or ARN of the source.
Source() *string
SetSource(val *string)
// The IP address of the source.
SourceIp() *string
SetSourceIp(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
// The tags to add to the path.
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{})
}
Specifies a path to analyze for reachability.
VPC Reachability Analyzer enables you to analyze and debug network reachability between two resources in your virtual private cloud (VPC). For more information, see the [Reachability Analyzer User Guide](https://docs.aws.amazon.com/vpc/latest/reachability/what-is-reachability-analyzer.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"
cfnNetworkInsightsPath := awscdk.Aws_ec2.NewCfnNetworkInsightsPath(this, jsii.String("MyCfnNetworkInsightsPath"), &CfnNetworkInsightsPathProps{
Protocol: jsii.String("protocol"),
Source: jsii.String("source"),
// the properties below are optional
Destination: jsii.String("destination"),
DestinationIp: jsii.String("destinationIp"),
DestinationPort: jsii.Number(123),
FilterAtDestination: &PathFilterProperty{
DestinationAddress: jsii.String("destinationAddress"),
DestinationPortRange: &FilterPortRangeProperty{
FromPort: jsii.Number(123),
ToPort: jsii.Number(123),
},
SourceAddress: jsii.String("sourceAddress"),
SourcePortRange: &FilterPortRangeProperty{
FromPort: jsii.Number(123),
ToPort: jsii.Number(123),
},
},
FilterAtSource: &PathFilterProperty{
DestinationAddress: jsii.String("destinationAddress"),
DestinationPortRange: &FilterPortRangeProperty{
FromPort: jsii.Number(123),
ToPort: jsii.Number(123),
},
SourceAddress: jsii.String("sourceAddress"),
SourcePortRange: &FilterPortRangeProperty{
FromPort: jsii.Number(123),
ToPort: jsii.Number(123),
},
},
SourceIp: jsii.String("sourceIp"),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
func NewCfnNetworkInsightsPath ¶
func NewCfnNetworkInsightsPath(scope constructs.Construct, id *string, props *CfnNetworkInsightsPathProps) CfnNetworkInsightsPath
type CfnNetworkInsightsPathProps ¶
type CfnNetworkInsightsPathProps struct {
// The protocol.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightspath.html#cfn-ec2-networkinsightspath-protocol
//
Protocol *string `field:"required" json:"protocol" yaml:"protocol"`
// The ID or ARN of the source.
//
// If the resource is in another account, you must specify an ARN.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightspath.html#cfn-ec2-networkinsightspath-source
//
Source *string `field:"required" json:"source" yaml:"source"`
// The ID or ARN of the destination.
//
// If the resource is in another account, you must specify an ARN.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightspath.html#cfn-ec2-networkinsightspath-destination
//
Destination *string `field:"optional" json:"destination" yaml:"destination"`
// The IP address of the destination.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightspath.html#cfn-ec2-networkinsightspath-destinationip
//
DestinationIp *string `field:"optional" json:"destinationIp" yaml:"destinationIp"`
// The destination port.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightspath.html#cfn-ec2-networkinsightspath-destinationport
//
DestinationPort *float64 `field:"optional" json:"destinationPort" yaml:"destinationPort"`
// Scopes the analysis to network paths that match specific filters at the destination.
//
// If you specify this parameter, you can't specify the parameter for the destination IP address.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightspath.html#cfn-ec2-networkinsightspath-filteratdestination
//
FilterAtDestination interface{} `field:"optional" json:"filterAtDestination" yaml:"filterAtDestination"`
// Scopes the analysis to network paths that match specific filters at the source.
//
// If you specify this parameter, you can't specify the parameters for the source IP address or the destination port.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightspath.html#cfn-ec2-networkinsightspath-filteratsource
//
FilterAtSource interface{} `field:"optional" json:"filterAtSource" yaml:"filterAtSource"`
// The IP address of the source.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightspath.html#cfn-ec2-networkinsightspath-sourceip
//
SourceIp *string `field:"optional" json:"sourceIp" yaml:"sourceIp"`
// The tags to add to the path.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightspath.html#cfn-ec2-networkinsightspath-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnNetworkInsightsPath`.
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"
cfnNetworkInsightsPathProps := &CfnNetworkInsightsPathProps{
Protocol: jsii.String("protocol"),
Source: jsii.String("source"),
// the properties below are optional
Destination: jsii.String("destination"),
DestinationIp: jsii.String("destinationIp"),
DestinationPort: jsii.Number(123),
FilterAtDestination: &PathFilterProperty{
DestinationAddress: jsii.String("destinationAddress"),
DestinationPortRange: &FilterPortRangeProperty{
FromPort: jsii.Number(123),
ToPort: jsii.Number(123),
},
SourceAddress: jsii.String("sourceAddress"),
SourcePortRange: &FilterPortRangeProperty{
FromPort: jsii.Number(123),
ToPort: jsii.Number(123),
},
},
FilterAtSource: &PathFilterProperty{
DestinationAddress: jsii.String("destinationAddress"),
DestinationPortRange: &FilterPortRangeProperty{
FromPort: jsii.Number(123),
ToPort: jsii.Number(123),
},
SourceAddress: jsii.String("sourceAddress"),
SourcePortRange: &FilterPortRangeProperty{
FromPort: jsii.Number(123),
ToPort: jsii.Number(123),
},
},
SourceIp: jsii.String("sourceIp"),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
type CfnNetworkInsightsPath_FilterPortRangeProperty ¶ added in v2.79.0
type CfnNetworkInsightsPath_FilterPortRangeProperty struct {
// The first port in the range.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightspath-filterportrange.html#cfn-ec2-networkinsightspath-filterportrange-fromport
//
FromPort *float64 `field:"optional" json:"fromPort" yaml:"fromPort"`
// The last port in the range.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightspath-filterportrange.html#cfn-ec2-networkinsightspath-filterportrange-toport
//
ToPort *float64 `field:"optional" json:"toPort" yaml:"toPort"`
}
Describes a port range.
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"
filterPortRangeProperty := &FilterPortRangeProperty{
FromPort: jsii.Number(123),
ToPort: jsii.Number(123),
}
type CfnNetworkInsightsPath_PathFilterProperty ¶ added in v2.79.0
type CfnNetworkInsightsPath_PathFilterProperty struct {
// The destination IPv4 address.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightspath-pathfilter.html#cfn-ec2-networkinsightspath-pathfilter-destinationaddress
//
DestinationAddress *string `field:"optional" json:"destinationAddress" yaml:"destinationAddress"`
// The destination port range.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightspath-pathfilter.html#cfn-ec2-networkinsightspath-pathfilter-destinationportrange
//
DestinationPortRange interface{} `field:"optional" json:"destinationPortRange" yaml:"destinationPortRange"`
// The source IPv4 address.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightspath-pathfilter.html#cfn-ec2-networkinsightspath-pathfilter-sourceaddress
//
SourceAddress *string `field:"optional" json:"sourceAddress" yaml:"sourceAddress"`
// The source port range.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightspath-pathfilter.html#cfn-ec2-networkinsightspath-pathfilter-sourceportrange
//
SourcePortRange interface{} `field:"optional" json:"sourcePortRange" yaml:"sourcePortRange"`
}
Describes a set of filters for a path analysis.
Use path filters to scope the analysis when there can be multiple resulting paths.
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"
pathFilterProperty := &PathFilterProperty{
DestinationAddress: jsii.String("destinationAddress"),
DestinationPortRange: &FilterPortRangeProperty{
FromPort: jsii.Number(123),
ToPort: jsii.Number(123),
},
SourceAddress: jsii.String("sourceAddress"),
SourcePortRange: &FilterPortRangeProperty{
FromPort: jsii.Number(123),
ToPort: jsii.Number(123),
},
}
type CfnNetworkInterface ¶
type CfnNetworkInterface interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggable
// The ID of the network interface.
AttrId() *string
// The primary IPv6 address of the network interface.
AttrPrimaryIpv6Address() *string
// The primary private IP address of the network interface.
//
// For example, `10.0.0.192` .
AttrPrimaryPrivateIpAddress() *string
// The secondary private IP addresses of the network interface.
//
// For example, `["10.0.0.161", "10.0.0.162", "10.0.0.163"]` .
AttrSecondaryPrivateIpAddresses() *[]*string
// The ID of the VPC.
AttrVpcId() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// A connection tracking specification for the network interface.
ConnectionTrackingSpecification() interface{}
SetConnectionTrackingSpecification(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 description for the network interface.
Description() *string
SetDescription(val *string)
// If you’re modifying a network interface in a dual-stack or IPv6-only subnet, you have the option to assign a primary IPv6 IP address.
EnablePrimaryIpv6() interface{}
SetEnablePrimaryIpv6(val interface{})
// The IDs of the security groups associated with this network interface.
GroupSet() *[]*string
SetGroupSet(val *[]*string)
// The type of network interface.
InterfaceType() *string
SetInterfaceType(val *string)
// The number of IPv4 prefixes to be automatically assigned to the network interface.
Ipv4PrefixCount() *float64
SetIpv4PrefixCount(val *float64)
// The IPv4 delegated prefixes that are assigned to the network interface.
Ipv4Prefixes() interface{}
SetIpv4Prefixes(val interface{})
// The number of IPv6 addresses to assign to the network interface.
Ipv6AddressCount() *float64
SetIpv6AddressCount(val *float64)
// The IPv6 addresses from the IPv6 CIDR block range of your subnet to assign to the network interface.
Ipv6Addresses() interface{}
SetIpv6Addresses(val interface{})
// The number of IPv6 prefixes to be automatically assigned to the network interface.
Ipv6PrefixCount() *float64
SetIpv6PrefixCount(val *float64)
// The IPv6 delegated prefixes that are assigned to the network interface.
Ipv6Prefixes() interface{}
SetIpv6Prefixes(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 private IPv4 address to assign to the network interface as the primary private IP address.
PrivateIpAddress() *string
SetPrivateIpAddress(val *string)
// The private IPv4 addresses to assign to the network interface.
PrivateIpAddresses() interface{}
SetPrivateIpAddresses(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 number of secondary private IPv4 addresses to assign to a network interface.
SecondaryPrivateIpAddressCount() *float64
SetSecondaryPrivateIpAddressCount(val *float64)
// Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives.
SourceDestCheck() interface{}
SetSourceDestCheck(val interface{})
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// The ID of the subnet to associate with the network interface.
SubnetId() *string
SetSubnetId(val *string)
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
// The tags to apply to the network interface.
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{})
}
Describes a network interface in an Amazon EC2 instance for AWS CloudFormation .
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"
cfnNetworkInterface := awscdk.Aws_ec2.NewCfnNetworkInterface(this, jsii.String("MyCfnNetworkInterface"), &CfnNetworkInterfaceProps{
SubnetId: jsii.String("subnetId"),
// the properties below are optional
ConnectionTrackingSpecification: &ConnectionTrackingSpecificationProperty{
TcpEstablishedTimeout: jsii.Number(123),
UdpStreamTimeout: jsii.Number(123),
UdpTimeout: jsii.Number(123),
},
Description: jsii.String("description"),
EnablePrimaryIpv6: jsii.Boolean(false),
GroupSet: []*string{
jsii.String("groupSet"),
},
InterfaceType: jsii.String("interfaceType"),
Ipv4PrefixCount: jsii.Number(123),
Ipv4Prefixes: []interface{}{
&Ipv4PrefixSpecificationProperty{
Ipv4Prefix: jsii.String("ipv4Prefix"),
},
},
Ipv6AddressCount: jsii.Number(123),
Ipv6Addresses: []interface{}{
&InstanceIpv6AddressProperty{
Ipv6Address: jsii.String("ipv6Address"),
},
},
Ipv6PrefixCount: jsii.Number(123),
Ipv6Prefixes: []interface{}{
&Ipv6PrefixSpecificationProperty{
Ipv6Prefix: jsii.String("ipv6Prefix"),
},
},
PrivateIpAddress: jsii.String("privateIpAddress"),
PrivateIpAddresses: []interface{}{
&PrivateIpAddressSpecificationProperty{
Primary: jsii.Boolean(false),
PrivateIpAddress: jsii.String("privateIpAddress"),
},
},
SecondaryPrivateIpAddressCount: jsii.Number(123),
SourceDestCheck: 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-ec2-networkinterface.html
func NewCfnNetworkInterface ¶
func NewCfnNetworkInterface(scope constructs.Construct, id *string, props *CfnNetworkInterfaceProps) CfnNetworkInterface
type CfnNetworkInterfaceAttachment ¶
type CfnNetworkInterfaceAttachment interface {
awscdk.CfnResource
awscdk.IInspectable
// The ID of the network interface attachment.
AttrAttachmentId() *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
// Whether to delete the network interface when the instance terminates.
DeleteOnTermination() interface{}
SetDeleteOnTermination(val interface{})
// The network interface's position in the attachment order.
DeviceIndex() *string
SetDeviceIndex(val *string)
// Configures ENA Express for the network interface that this action attaches to the instance.
EnaSrdSpecification() interface{}
SetEnaSrdSpecification(val interface{})
// The ID of the instance to which you will attach the ENI.
InstanceId() *string
SetInstanceId(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 ID of the ENI that you want to attach.
NetworkInterfaceId() *string
SetNetworkInterfaceId(val *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{})
}
Attaches an elastic network interface (ENI) to an Amazon EC2 instance.
You can use this resource type to attach additional network interfaces to an instance without interruption.
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"
cfnNetworkInterfaceAttachment := awscdk.Aws_ec2.NewCfnNetworkInterfaceAttachment(this, jsii.String("MyCfnNetworkInterfaceAttachment"), &CfnNetworkInterfaceAttachmentProps{
DeviceIndex: jsii.String("deviceIndex"),
InstanceId: jsii.String("instanceId"),
NetworkInterfaceId: jsii.String("networkInterfaceId"),
// the properties below are optional
DeleteOnTermination: jsii.Boolean(false),
EnaSrdSpecification: &EnaSrdSpecificationProperty{
EnaSrdEnabled: jsii.Boolean(false),
EnaSrdUdpSpecification: &EnaSrdUdpSpecificationProperty{
EnaSrdUdpEnabled: jsii.Boolean(false),
},
},
})
func NewCfnNetworkInterfaceAttachment ¶
func NewCfnNetworkInterfaceAttachment(scope constructs.Construct, id *string, props *CfnNetworkInterfaceAttachmentProps) CfnNetworkInterfaceAttachment
type CfnNetworkInterfaceAttachmentProps ¶
type CfnNetworkInterfaceAttachmentProps struct {
// The network interface's position in the attachment order.
//
// For example, the first attached network interface has a `DeviceIndex` of 0.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterfaceattachment.html#cfn-ec2-networkinterfaceattachment-deviceindex
//
DeviceIndex *string `field:"required" json:"deviceIndex" yaml:"deviceIndex"`
// The ID of the instance to which you will attach the ENI.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterfaceattachment.html#cfn-ec2-networkinterfaceattachment-instanceid
//
InstanceId *string `field:"required" json:"instanceId" yaml:"instanceId"`
// The ID of the ENI that you want to attach.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterfaceattachment.html#cfn-ec2-networkinterfaceattachment-networkinterfaceid
//
NetworkInterfaceId *string `field:"required" json:"networkInterfaceId" yaml:"networkInterfaceId"`
// Whether to delete the network interface when the instance terminates.
//
// By default, this value is set to `true` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterfaceattachment.html#cfn-ec2-networkinterfaceattachment-deleteontermination
//
// Default: - true.
//
DeleteOnTermination interface{} `field:"optional" json:"deleteOnTermination" yaml:"deleteOnTermination"`
// Configures ENA Express for the network interface that this action attaches to the instance.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterfaceattachment.html#cfn-ec2-networkinterfaceattachment-enasrdspecification
//
EnaSrdSpecification interface{} `field:"optional" json:"enaSrdSpecification" yaml:"enaSrdSpecification"`
}
Properties for defining a `CfnNetworkInterfaceAttachment`.
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"
cfnNetworkInterfaceAttachmentProps := &CfnNetworkInterfaceAttachmentProps{
DeviceIndex: jsii.String("deviceIndex"),
InstanceId: jsii.String("instanceId"),
NetworkInterfaceId: jsii.String("networkInterfaceId"),
// the properties below are optional
DeleteOnTermination: jsii.Boolean(false),
EnaSrdSpecification: &EnaSrdSpecificationProperty{
EnaSrdEnabled: jsii.Boolean(false),
EnaSrdUdpSpecification: &EnaSrdUdpSpecificationProperty{
EnaSrdUdpEnabled: jsii.Boolean(false),
},
},
}
type CfnNetworkInterfaceAttachment_EnaSrdSpecificationProperty ¶ added in v2.132.0
type CfnNetworkInterfaceAttachment_EnaSrdSpecificationProperty struct {
// Indicates whether ENA Express is enabled for the network interface.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinterfaceattachment-enasrdspecification.html#cfn-ec2-networkinterfaceattachment-enasrdspecification-enasrdenabled
//
EnaSrdEnabled interface{} `field:"optional" json:"enaSrdEnabled" yaml:"enaSrdEnabled"`
// Configures ENA Express for UDP network traffic.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinterfaceattachment-enasrdspecification.html#cfn-ec2-networkinterfaceattachment-enasrdspecification-enasrdudpspecification
//
EnaSrdUdpSpecification interface{} `field:"optional" json:"enaSrdUdpSpecification" yaml:"enaSrdUdpSpecification"`
}
ENA Express uses AWS Scalable Reliable Datagram (SRD) technology to increase the maximum bandwidth used per stream and minimize tail latency of network traffic between EC2 instances.
With ENA Express, you can communicate between two EC2 instances in the same subnet within the same account, or in different accounts. Both sending and receiving instances must have ENA Express enabled.
To improve the reliability of network packet delivery, ENA Express reorders network packets on the receiving end by default. However, some UDP-based applications are designed to handle network packets that are out of order to reduce the overhead for packet delivery at the network layer. When ENA Express is enabled, you can specify whether UDP network traffic uses it.
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"
enaSrdSpecificationProperty := &EnaSrdSpecificationProperty{
EnaSrdEnabled: jsii.Boolean(false),
EnaSrdUdpSpecification: &EnaSrdUdpSpecificationProperty{
EnaSrdUdpEnabled: jsii.Boolean(false),
},
}
type CfnNetworkInterfaceAttachment_EnaSrdUdpSpecificationProperty ¶ added in v2.132.0
type CfnNetworkInterfaceAttachment_EnaSrdUdpSpecificationProperty struct {
// Indicates whether UDP traffic to and from the instance uses ENA Express.
//
// To specify this setting, you must first enable ENA Express.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinterfaceattachment-enasrdudpspecification.html#cfn-ec2-networkinterfaceattachment-enasrdudpspecification-enasrdudpenabled
//
EnaSrdUdpEnabled interface{} `field:"optional" json:"enaSrdUdpEnabled" yaml:"enaSrdUdpEnabled"`
}
ENA Express is compatible with both TCP and UDP transport protocols.
When it's enabled, TCP traffic automatically uses it. However, some UDP-based applications are designed to handle network packets that are out of order, without a need for retransmission, such as live video broadcasting or other near-real-time applications. For UDP traffic, you can specify whether to use ENA Express, based on your application environment needs.
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"
enaSrdUdpSpecificationProperty := &EnaSrdUdpSpecificationProperty{
EnaSrdUdpEnabled: jsii.Boolean(false),
}
type CfnNetworkInterfacePermission ¶
type CfnNetworkInterfacePermission interface {
awscdk.CfnResource
awscdk.IInspectable
AttrId() *string
// The AWS account ID.
AwsAccountId() *string
SetAwsAccountId(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 ID of the network interface.
NetworkInterfaceId() *string
SetNetworkInterfaceId(val *string)
// The tree node.
Node() constructs.Node
// The type of permission to grant: `INSTANCE-ATTACH` or `EIP-ASSOCIATE` .
Permission() *string
SetPermission(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
// 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{})
}
Specifies a permission for an Amazon EC2 network interface.
For example, you can grant an AWS authorized partner account permission to attach the specified network interface to an instance in their account.
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"
cfnNetworkInterfacePermission := awscdk.Aws_ec2.NewCfnNetworkInterfacePermission(this, jsii.String("MyCfnNetworkInterfacePermission"), &CfnNetworkInterfacePermissionProps{
AwsAccountId: jsii.String("awsAccountId"),
NetworkInterfaceId: jsii.String("networkInterfaceId"),
Permission: jsii.String("permission"),
})
func NewCfnNetworkInterfacePermission ¶
func NewCfnNetworkInterfacePermission(scope constructs.Construct, id *string, props *CfnNetworkInterfacePermissionProps) CfnNetworkInterfacePermission
type CfnNetworkInterfacePermissionProps ¶
type CfnNetworkInterfacePermissionProps struct {
// The AWS account ID.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterfacepermission.html#cfn-ec2-networkinterfacepermission-awsaccountid
//
AwsAccountId *string `field:"required" json:"awsAccountId" yaml:"awsAccountId"`
// The ID of the network interface.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterfacepermission.html#cfn-ec2-networkinterfacepermission-networkinterfaceid
//
NetworkInterfaceId *string `field:"required" json:"networkInterfaceId" yaml:"networkInterfaceId"`
// The type of permission to grant: `INSTANCE-ATTACH` or `EIP-ASSOCIATE` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterfacepermission.html#cfn-ec2-networkinterfacepermission-permission
//
Permission *string `field:"required" json:"permission" yaml:"permission"`
}
Properties for defining a `CfnNetworkInterfacePermission`.
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"
cfnNetworkInterfacePermissionProps := &CfnNetworkInterfacePermissionProps{
AwsAccountId: jsii.String("awsAccountId"),
NetworkInterfaceId: jsii.String("networkInterfaceId"),
Permission: jsii.String("permission"),
}
type CfnNetworkInterfaceProps ¶
type CfnNetworkInterfaceProps struct {
// The ID of the subnet to associate with the network interface.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-subnetid
//
SubnetId *string `field:"required" json:"subnetId" yaml:"subnetId"`
// A connection tracking specification for the network interface.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-connectiontrackingspecification
//
ConnectionTrackingSpecification interface{} `field:"optional" json:"connectionTrackingSpecification" yaml:"connectionTrackingSpecification"`
// A description for the network interface.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// If you’re modifying a network interface in a dual-stack or IPv6-only subnet, you have the option to assign a primary IPv6 IP address.
//
// A primary IPv6 address is an IPv6 GUA address associated with an ENI that you have enabled to use a primary IPv6 address. Use this option if the instance that this ENI will be attached to relies on its IPv6 address not changing. AWS will automatically assign an IPv6 address associated with the ENI attached to your instance to be the primary IPv6 address. Once you enable an IPv6 GUA address to be a primary IPv6, you cannot disable it. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. If you have multiple IPv6 addresses associated with an ENI attached to your instance and you enable a primary IPv6 address, the first IPv6 GUA address associated with the ENI becomes the primary IPv6 address.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-enableprimaryipv6
//
EnablePrimaryIpv6 interface{} `field:"optional" json:"enablePrimaryIpv6" yaml:"enablePrimaryIpv6"`
// The IDs of the security groups associated with this network interface.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-groupset
//
GroupSet *[]*string `field:"optional" json:"groupSet" yaml:"groupSet"`
// The type of network interface.
//
// The default is `interface` . The supported values are `efa` and `trunk` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-interfacetype
//
InterfaceType *string `field:"optional" json:"interfaceType" yaml:"interfaceType"`
// The number of IPv4 prefixes to be automatically assigned to the network interface.
//
// When creating a network interface, you can't specify a count of IPv4 prefixes if you've specified one of the following: specific IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-ipv4prefixcount
//
Ipv4PrefixCount *float64 `field:"optional" json:"ipv4PrefixCount" yaml:"ipv4PrefixCount"`
// The IPv4 delegated prefixes that are assigned to the network interface.
//
// When creating a network interface, you can't specify IPv4 prefixes if you've specified one of the following: a count of IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-ipv4prefixes
//
Ipv4Prefixes interface{} `field:"optional" json:"ipv4Prefixes" yaml:"ipv4Prefixes"`
// The number of IPv6 addresses to assign to the network interface.
//
// Amazon EC2 automatically selects the IPv6 addresses from the subnet range. To specify specific IPv6 addresses, use the `Ipv6Addresses` property and don't specify this property.
//
// When creating a network interface, you can't specify a count of IPv6 addresses if you've specified one of the following: specific IPv6 addresses, specific IPv6 prefixes, or a count of IPv6 prefixes.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-ipv6addresscount
//
Ipv6AddressCount *float64 `field:"optional" json:"ipv6AddressCount" yaml:"ipv6AddressCount"`
// The IPv6 addresses from the IPv6 CIDR block range of your subnet to assign to the network interface.
//
// If you're specifying a number of IPv6 addresses, use the `Ipv6AddressCount` property and don't specify this property.
//
// When creating a network interface, you can't specify IPv6 addresses if you've specified one of the following: a count of IPv6 addresses, specific IPv6 prefixes, or a count of IPv6 prefixes.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-ipv6addresses
//
Ipv6Addresses interface{} `field:"optional" json:"ipv6Addresses" yaml:"ipv6Addresses"`
// The number of IPv6 prefixes to be automatically assigned to the network interface.
//
// When creating a network interface, you can't specify a count of IPv6 prefixes if you've specified one of the following: specific IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-ipv6prefixcount
//
Ipv6PrefixCount *float64 `field:"optional" json:"ipv6PrefixCount" yaml:"ipv6PrefixCount"`
// The IPv6 delegated prefixes that are assigned to the network interface.
//
// When creating a network interface, you can't specify IPv6 prefixes if you've specified one of the following: a count of IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-ipv6prefixes
//
Ipv6Prefixes interface{} `field:"optional" json:"ipv6Prefixes" yaml:"ipv6Prefixes"`
// The private IPv4 address to assign to the network interface as the primary private IP address.
//
// If you want to specify multiple private IP addresses, use the `PrivateIpAddresses` property.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-privateipaddress
//
PrivateIpAddress *string `field:"optional" json:"privateIpAddress" yaml:"privateIpAddress"`
// The private IPv4 addresses to assign to the network interface.
//
// You can specify a primary private IP address by setting the value of the `Primary` property to `true` in the `PrivateIpAddressSpecification` property. If you want EC2 to automatically assign private IP addresses, use the `SecondaryPrivateIpAddressCount` property and do not specify this property.
//
// When creating a network interface, you can't specify private IPv4 addresses if you've specified one of the following: a count of private IPv4 addresses, specific IPv4 prefixes, or a count of IPv4 prefixes.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-privateipaddresses
//
PrivateIpAddresses interface{} `field:"optional" json:"privateIpAddresses" yaml:"privateIpAddresses"`
// The number of secondary private IPv4 addresses to assign to a network interface.
//
// When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet's IPv4 CIDR range. You can't specify this option and specify more than one private IP address using `privateIpAddresses` .
//
// When creating a Network Interface, you can't specify a count of private IPv4 addresses if you've specified one of the following: specific private IPv4 addresses, specific IPv4 prefixes, or a count of IPv4 prefixes.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-secondaryprivateipaddresscount
//
SecondaryPrivateIpAddressCount *float64 `field:"optional" json:"secondaryPrivateIpAddressCount" yaml:"secondaryPrivateIpAddressCount"`
// Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives.
//
// If the value is `true` , source/destination checks are enabled; otherwise, they are disabled. The default value is `true` . You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-sourcedestcheck
//
SourceDestCheck interface{} `field:"optional" json:"sourceDestCheck" yaml:"sourceDestCheck"`
// The tags to apply to the network interface.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnNetworkInterface`.
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"
cfnNetworkInterfaceProps := &CfnNetworkInterfaceProps{
SubnetId: jsii.String("subnetId"),
// the properties below are optional
ConnectionTrackingSpecification: &ConnectionTrackingSpecificationProperty{
TcpEstablishedTimeout: jsii.Number(123),
UdpStreamTimeout: jsii.Number(123),
UdpTimeout: jsii.Number(123),
},
Description: jsii.String("description"),
EnablePrimaryIpv6: jsii.Boolean(false),
GroupSet: []*string{
jsii.String("groupSet"),
},
InterfaceType: jsii.String("interfaceType"),
Ipv4PrefixCount: jsii.Number(123),
Ipv4Prefixes: []interface{}{
&Ipv4PrefixSpecificationProperty{
Ipv4Prefix: jsii.String("ipv4Prefix"),
},
},
Ipv6AddressCount: jsii.Number(123),
Ipv6Addresses: []interface{}{
&InstanceIpv6AddressProperty{
Ipv6Address: jsii.String("ipv6Address"),
},
},
Ipv6PrefixCount: jsii.Number(123),
Ipv6Prefixes: []interface{}{
&Ipv6PrefixSpecificationProperty{
Ipv6Prefix: jsii.String("ipv6Prefix"),
},
},
PrivateIpAddress: jsii.String("privateIpAddress"),
PrivateIpAddresses: []interface{}{
&PrivateIpAddressSpecificationProperty{
Primary: jsii.Boolean(false),
PrivateIpAddress: jsii.String("privateIpAddress"),
},
},
SecondaryPrivateIpAddressCount: jsii.Number(123),
SourceDestCheck: 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-ec2-networkinterface.html
type CfnNetworkInterface_ConnectionTrackingSpecificationProperty ¶ added in v2.122.0
type CfnNetworkInterface_ConnectionTrackingSpecificationProperty struct {
// Timeout (in seconds) for idle TCP connections in an established state.
//
// Min: 60 seconds. Max: 432000 seconds (5 days). Default: 432000 seconds. Recommended: Less than 432000 seconds.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinterface-connectiontrackingspecification.html#cfn-ec2-networkinterface-connectiontrackingspecification-tcpestablishedtimeout
//
TcpEstablishedTimeout *float64 `field:"optional" json:"tcpEstablishedTimeout" yaml:"tcpEstablishedTimeout"`
// Timeout (in seconds) for idle UDP flows classified as streams which have seen more than one request-response transaction.
//
// Min: 60 seconds. Max: 180 seconds (3 minutes). Default: 180 seconds.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinterface-connectiontrackingspecification.html#cfn-ec2-networkinterface-connectiontrackingspecification-udpstreamtimeout
//
UdpStreamTimeout *float64 `field:"optional" json:"udpStreamTimeout" yaml:"udpStreamTimeout"`
// Timeout (in seconds) for idle UDP flows that have seen traffic only in a single direction or a single request-response transaction.
//
// Min: 30 seconds. Max: 60 seconds. Default: 30 seconds.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinterface-connectiontrackingspecification.html#cfn-ec2-networkinterface-connectiontrackingspecification-udptimeout
//
UdpTimeout *float64 `field:"optional" json:"udpTimeout" yaml:"udpTimeout"`
}
Configurable options for connection tracking on a network interface.
For more information, see [Connection tracking timeouts](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-connection-tracking.html#connection-tracking-timeouts) in the *Amazon Elastic Compute Cloud User 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"
connectionTrackingSpecificationProperty := &ConnectionTrackingSpecificationProperty{
TcpEstablishedTimeout: jsii.Number(123),
UdpStreamTimeout: jsii.Number(123),
UdpTimeout: jsii.Number(123),
}
type CfnNetworkInterface_InstanceIpv6AddressProperty ¶
type CfnNetworkInterface_InstanceIpv6AddressProperty struct {
// An IPv6 address to associate with the network interface.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinterface-instanceipv6address.html#cfn-ec2-networkinterface-instanceipv6address-ipv6address
//
Ipv6Address *string `field:"required" json:"ipv6Address" yaml:"ipv6Address"`
}
Describes the IPv6 addresses to associate with the network interface.
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"
instanceIpv6AddressProperty := &InstanceIpv6AddressProperty{
Ipv6Address: jsii.String("ipv6Address"),
}
type CfnNetworkInterface_Ipv4PrefixSpecificationProperty ¶ added in v2.93.0
type CfnNetworkInterface_Ipv4PrefixSpecificationProperty struct {
// The IPv4 prefix.
//
// For information, see [Assigning prefixes to network interfaces](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-prefix-eni.html) in the *Amazon EC2 User Guide* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinterface-ipv4prefixspecification.html#cfn-ec2-networkinterface-ipv4prefixspecification-ipv4prefix
//
Ipv4Prefix *string `field:"required" json:"ipv4Prefix" yaml:"ipv4Prefix"`
}
Describes an IPv4 prefix.
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"
ipv4PrefixSpecificationProperty := &Ipv4PrefixSpecificationProperty{
Ipv4Prefix: jsii.String("ipv4Prefix"),
}
type CfnNetworkInterface_Ipv6PrefixSpecificationProperty ¶ added in v2.93.0
type CfnNetworkInterface_Ipv6PrefixSpecificationProperty struct {
// The IPv6 prefix.
//
// For information, see [Assigning prefixes to Amazon EC2 network interfaces](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-prefix-eni.html) in the *Amazon Elastic Compute Cloud User Guide* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinterface-ipv6prefixspecification.html#cfn-ec2-networkinterface-ipv6prefixspecification-ipv6prefix
//
Ipv6Prefix *string `field:"required" json:"ipv6Prefix" yaml:"ipv6Prefix"`
}
Describes the IPv6 prefix.
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"
ipv6PrefixSpecificationProperty := &Ipv6PrefixSpecificationProperty{
Ipv6Prefix: jsii.String("ipv6Prefix"),
}
type CfnNetworkInterface_PrivateIpAddressSpecificationProperty ¶
type CfnNetworkInterface_PrivateIpAddressSpecificationProperty struct {
// Sets the private IP address as the primary private address.
//
// You can set only one primary private IP address. If you don't specify a primary private IP address, Amazon EC2 automatically assigns a primary private IP address.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinterface-privateipaddressspecification.html#cfn-ec2-networkinterface-privateipaddressspecification-primary
//
Primary interface{} `field:"required" json:"primary" yaml:"primary"`
// The private IP address of the network interface.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinterface-privateipaddressspecification.html#cfn-ec2-networkinterface-privateipaddressspecification-privateipaddress
//
PrivateIpAddress *string `field:"required" json:"privateIpAddress" yaml:"privateIpAddress"`
}
Describes a secondary private IPv4 address for a network interface.
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"
privateIpAddressSpecificationProperty := &PrivateIpAddressSpecificationProperty{
Primary: jsii.Boolean(false),
PrivateIpAddress: jsii.String("privateIpAddress"),
}
type CfnNetworkPerformanceMetricSubscription ¶ added in v2.55.0
type CfnNetworkPerformanceMetricSubscription interface {
awscdk.CfnResource
awscdk.IInspectable
// 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 Region or Availability Zone that's the target for the subscription.
Destination() *string
SetDestination(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 metric used for the subscription.
Metric() *string
SetMetric(val *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 Region or Availability Zone that's the source for the subscription.
Source() *string
SetSource(val *string)
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// The statistic used for the subscription.
Statistic() *string
SetStatistic(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{})
}
Describes Infrastructure Performance subscriptions.
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"
cfnNetworkPerformanceMetricSubscription := awscdk.Aws_ec2.NewCfnNetworkPerformanceMetricSubscription(this, jsii.String("MyCfnNetworkPerformanceMetricSubscription"), &CfnNetworkPerformanceMetricSubscriptionProps{
Destination: jsii.String("destination"),
Metric: jsii.String("metric"),
Source: jsii.String("source"),
Statistic: jsii.String("statistic"),
})
func NewCfnNetworkPerformanceMetricSubscription ¶ added in v2.55.0
func NewCfnNetworkPerformanceMetricSubscription(scope constructs.Construct, id *string, props *CfnNetworkPerformanceMetricSubscriptionProps) CfnNetworkPerformanceMetricSubscription
type CfnNetworkPerformanceMetricSubscriptionProps ¶ added in v2.55.0
type CfnNetworkPerformanceMetricSubscriptionProps struct {
// The Region or Availability Zone that's the target for the subscription.
//
// For example, `eu-west-1` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkperformancemetricsubscription.html#cfn-ec2-networkperformancemetricsubscription-destination
//
Destination *string `field:"required" json:"destination" yaml:"destination"`
// The metric used for the subscription.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkperformancemetricsubscription.html#cfn-ec2-networkperformancemetricsubscription-metric
//
Metric *string `field:"required" json:"metric" yaml:"metric"`
// The Region or Availability Zone that's the source for the subscription.
//
// For example, `us-east-1` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkperformancemetricsubscription.html#cfn-ec2-networkperformancemetricsubscription-source
//
Source *string `field:"required" json:"source" yaml:"source"`
// The statistic used for the subscription.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkperformancemetricsubscription.html#cfn-ec2-networkperformancemetricsubscription-statistic
//
Statistic *string `field:"required" json:"statistic" yaml:"statistic"`
}
Properties for defining a `CfnNetworkPerformanceMetricSubscription`.
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"
cfnNetworkPerformanceMetricSubscriptionProps := &CfnNetworkPerformanceMetricSubscriptionProps{
Destination: jsii.String("destination"),
Metric: jsii.String("metric"),
Source: jsii.String("source"),
Statistic: jsii.String("statistic"),
}
type CfnPlacementGroup ¶
type CfnPlacementGroup interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggable
// The name of the placement group.
AttrGroupName() *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
// The number of partitions.
PartitionCount() *float64
SetPartitionCount(val *float64)
// 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
// Determines how placement groups spread instances.
SpreadLevel() *string
SetSpreadLevel(val *string)
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// The placement strategy.
Strategy() *string
SetStrategy(val *string)
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
// The tags to apply to the new placement group.
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{})
}
Specifies a placement group in which to launch instances.
The strategy of the placement group determines how the instances are organized within the group.
A `cluster` placement group is a logical grouping of instances within a single Availability Zone that benefit from low network latency, high network throughput. A `spread` placement group places instances on distinct hardware. A `partition` placement group places groups of instances in different partitions, where instances in one partition do not share the same hardware with instances in another partition.
For more information, see [Placement Groups](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html) in the *Amazon EC2 User 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"
cfnPlacementGroup := awscdk.Aws_ec2.NewCfnPlacementGroup(this, jsii.String("MyCfnPlacementGroup"), &CfnPlacementGroupProps{
PartitionCount: jsii.Number(123),
SpreadLevel: jsii.String("spreadLevel"),
Strategy: jsii.String("strategy"),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-placementgroup.html
func NewCfnPlacementGroup ¶
func NewCfnPlacementGroup(scope constructs.Construct, id *string, props *CfnPlacementGroupProps) CfnPlacementGroup
type CfnPlacementGroupProps ¶
type CfnPlacementGroupProps struct {
// The number of partitions.
//
// Valid only when *Strategy* is set to `partition` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-placementgroup.html#cfn-ec2-placementgroup-partitioncount
//
PartitionCount *float64 `field:"optional" json:"partitionCount" yaml:"partitionCount"`
// Determines how placement groups spread instances.
//
// - Host – You can use `host` only with Outpost placement groups.
// - Rack – No usage restrictions.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-placementgroup.html#cfn-ec2-placementgroup-spreadlevel
//
SpreadLevel *string `field:"optional" json:"spreadLevel" yaml:"spreadLevel"`
// The placement strategy.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-placementgroup.html#cfn-ec2-placementgroup-strategy
//
Strategy *string `field:"optional" json:"strategy" yaml:"strategy"`
// The tags to apply to the new placement group.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-placementgroup.html#cfn-ec2-placementgroup-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnPlacementGroup`.
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"
cfnPlacementGroupProps := &CfnPlacementGroupProps{
PartitionCount: jsii.Number(123),
SpreadLevel: jsii.String("spreadLevel"),
Strategy: jsii.String("strategy"),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-placementgroup.html
type CfnPrefixList ¶
type CfnPrefixList interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggable
// The IP address type.
AddressFamily() *string
SetAddressFamily(val *string)
// The ARN of the prefix list.
//
// For example, `arn:aws:ec2:us-east-1:123456789012:prefix-list/pl-0123123123123abcd` .
AttrArn() *string
// The ID of the owner of the prefix list.
//
// For example, `123456789012` .
AttrOwnerId() *string
// The ID of the prefix list.
//
// For example, `pl-0123123123123abcd` .
AttrPrefixListId() *string
// The version of the prefix list.
//
// For example, `1` .
AttrVersion() *float64
// 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 entries for the prefix list.
Entries() interface{}
SetEntries(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 maximum number of entries for the prefix list.
MaxEntries() *float64
SetMaxEntries(val *float64)
// The tree node.
Node() constructs.Node
// A name for the prefix list.
PrefixListName() *string
SetPrefixListName(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
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
// The tags for the prefix list.
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{})
}
Specifies a managed prefix list.
You can add one or more entries to the prefix list. Each entry consists of a CIDR block and an optional description.
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"
cfnPrefixList := awscdk.Aws_ec2.NewCfnPrefixList(this, jsii.String("MyCfnPrefixList"), &CfnPrefixListProps{
AddressFamily: jsii.String("addressFamily"),
PrefixListName: jsii.String("prefixListName"),
// the properties below are optional
Entries: []interface{}{
&EntryProperty{
Cidr: jsii.String("cidr"),
// the properties below are optional
Description: jsii.String("description"),
},
},
MaxEntries: jsii.Number(123),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-prefixlist.html
func NewCfnPrefixList ¶
func NewCfnPrefixList(scope constructs.Construct, id *string, props *CfnPrefixListProps) CfnPrefixList
type CfnPrefixListProps ¶
type CfnPrefixListProps struct {
// The IP address type.
//
// Valid Values: `IPv4` | `IPv6`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-prefixlist.html#cfn-ec2-prefixlist-addressfamily
//
AddressFamily *string `field:"required" json:"addressFamily" yaml:"addressFamily"`
// A name for the prefix list.
//
// Constraints: Up to 255 characters in length. The name cannot start with `com.amazonaws` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-prefixlist.html#cfn-ec2-prefixlist-prefixlistname
//
PrefixListName *string `field:"required" json:"prefixListName" yaml:"prefixListName"`
// The entries for the prefix list.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-prefixlist.html#cfn-ec2-prefixlist-entries
//
Entries interface{} `field:"optional" json:"entries" yaml:"entries"`
// The maximum number of entries for the prefix list.
//
// This property is required when you create a prefix list.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-prefixlist.html#cfn-ec2-prefixlist-maxentries
//
MaxEntries *float64 `field:"optional" json:"maxEntries" yaml:"maxEntries"`
// The tags for the prefix list.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-prefixlist.html#cfn-ec2-prefixlist-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnPrefixList`.
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"
cfnPrefixListProps := &CfnPrefixListProps{
AddressFamily: jsii.String("addressFamily"),
PrefixListName: jsii.String("prefixListName"),
// the properties below are optional
Entries: []interface{}{
&EntryProperty{
Cidr: jsii.String("cidr"),
// the properties below are optional
Description: jsii.String("description"),
},
},
MaxEntries: jsii.Number(123),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-prefixlist.html
type CfnPrefixList_EntryProperty ¶
type CfnPrefixList_EntryProperty struct {
// The CIDR block.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-prefixlist-entry.html#cfn-ec2-prefixlist-entry-cidr
//
Cidr *string `field:"required" json:"cidr" yaml:"cidr"`
// A description for the entry.
//
// Constraints: Up to 255 characters in length.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-prefixlist-entry.html#cfn-ec2-prefixlist-entry-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
}
An entry for a prefix list.
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"
entryProperty := &EntryProperty{
Cidr: jsii.String("cidr"),
// the properties below are optional
Description: jsii.String("description"),
}
type CfnRoute ¶
type CfnRoute interface {
awscdk.CfnResource
awscdk.IInspectable
// The IPv4 CIDR block.
AttrCidrBlock() *string
// The ID of the carrier gateway.
CarrierGatewayId() *string
SetCarrierGatewayId(val *string)
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// The Amazon Resource Name (ARN) of the core network.
CoreNetworkArn() *string
SetCoreNetworkArn(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 IPv4 CIDR address block used for the destination match.
DestinationCidrBlock() *string
SetDestinationCidrBlock(val *string)
// The IPv6 CIDR block used for the destination match.
DestinationIpv6CidrBlock() *string
SetDestinationIpv6CidrBlock(val *string)
// The ID of a prefix list used for the destination match.
DestinationPrefixListId() *string
SetDestinationPrefixListId(val *string)
// [IPv6 traffic only] The ID of an egress-only internet gateway.
EgressOnlyInternetGatewayId() *string
SetEgressOnlyInternetGatewayId(val *string)
// The ID of an internet gateway or virtual private gateway attached to your VPC.
GatewayId() *string
SetGatewayId(val *string)
// The ID of a NAT instance in your VPC.
InstanceId() *string
SetInstanceId(val *string)
// The ID of the local gateway.
LocalGatewayId() *string
SetLocalGatewayId(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
// [IPv4 traffic only] The ID of a NAT gateway.
NatGatewayId() *string
SetNatGatewayId(val *string)
// The ID of a network interface.
NetworkInterfaceId() *string
SetNetworkInterfaceId(val *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 ID of the route table for the route.
RouteTableId() *string
SetRouteTableId(val *string)
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// The ID of a transit gateway.
TransitGatewayId() *string
SetTransitGatewayId(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{}
// The ID of a VPC endpoint.
VpcEndpointId() *string
SetVpcEndpointId(val *string)
// The ID of a VPC peering connection.
VpcPeeringConnectionId() *string
SetVpcPeeringConnectionId(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{})
}
Specifies a route in a route table. For more information, see [Routes](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html#route-table-routes) in the *Amazon VPC User Guide* .
You must specify either a destination CIDR block or prefix list ID. You must also specify exactly one of the resources as the target.
If you create a route that references a transit gateway in the same template where you create the transit gateway, you must declare a dependency on the transit gateway attachment. The route table cannot use the transit gateway until it has successfully attached to the VPC. Add a [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) in the `AWS::EC2::Route` resource to explicitly declare a dependency on the `AWS::EC2::TransitGatewayAttachment` resource.
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"
cfnRoute := awscdk.Aws_ec2.NewCfnRoute(this, jsii.String("MyCfnRoute"), &CfnRouteProps{
RouteTableId: jsii.String("routeTableId"),
// the properties below are optional
CarrierGatewayId: jsii.String("carrierGatewayId"),
CoreNetworkArn: jsii.String("coreNetworkArn"),
DestinationCidrBlock: jsii.String("destinationCidrBlock"),
DestinationIpv6CidrBlock: jsii.String("destinationIpv6CidrBlock"),
DestinationPrefixListId: jsii.String("destinationPrefixListId"),
EgressOnlyInternetGatewayId: jsii.String("egressOnlyInternetGatewayId"),
GatewayId: jsii.String("gatewayId"),
InstanceId: jsii.String("instanceId"),
LocalGatewayId: jsii.String("localGatewayId"),
NatGatewayId: jsii.String("natGatewayId"),
NetworkInterfaceId: jsii.String("networkInterfaceId"),
TransitGatewayId: jsii.String("transitGatewayId"),
VpcEndpointId: jsii.String("vpcEndpointId"),
VpcPeeringConnectionId: jsii.String("vpcPeeringConnectionId"),
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html
func NewCfnRoute ¶
func NewCfnRoute(scope constructs.Construct, id *string, props *CfnRouteProps) CfnRoute
type CfnRouteProps ¶
type CfnRouteProps struct {
// The ID of the route table for the route.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-routetableid
//
RouteTableId *string `field:"required" json:"routeTableId" yaml:"routeTableId"`
// The ID of the carrier gateway.
//
// You can only use this option when the VPC contains a subnet which is associated with a Wavelength Zone.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-carriergatewayid
//
CarrierGatewayId *string `field:"optional" json:"carrierGatewayId" yaml:"carrierGatewayId"`
// The Amazon Resource Name (ARN) of the core network.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-corenetworkarn
//
CoreNetworkArn *string `field:"optional" json:"coreNetworkArn" yaml:"coreNetworkArn"`
// The IPv4 CIDR address block used for the destination match.
//
// Routing decisions are based on the most specific match. We modify the specified CIDR block to its canonical form; for example, if you specify `100.68.0.18/18` , we modify it to `100.68.0.0/18` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-destinationcidrblock
//
DestinationCidrBlock *string `field:"optional" json:"destinationCidrBlock" yaml:"destinationCidrBlock"`
// The IPv6 CIDR block used for the destination match.
//
// Routing decisions are based on the most specific match.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-destinationipv6cidrblock
//
DestinationIpv6CidrBlock *string `field:"optional" json:"destinationIpv6CidrBlock" yaml:"destinationIpv6CidrBlock"`
// The ID of a prefix list used for the destination match.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-destinationprefixlistid
//
DestinationPrefixListId *string `field:"optional" json:"destinationPrefixListId" yaml:"destinationPrefixListId"`
// [IPv6 traffic only] The ID of an egress-only internet gateway.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-egressonlyinternetgatewayid
//
EgressOnlyInternetGatewayId *string `field:"optional" json:"egressOnlyInternetGatewayId" yaml:"egressOnlyInternetGatewayId"`
// The ID of an internet gateway or virtual private gateway attached to your VPC.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-gatewayid
//
GatewayId *string `field:"optional" json:"gatewayId" yaml:"gatewayId"`
// The ID of a NAT instance in your VPC.
//
// The operation fails if you specify an instance ID unless exactly one network interface is attached.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-instanceid
//
InstanceId *string `field:"optional" json:"instanceId" yaml:"instanceId"`
// The ID of the local gateway.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-localgatewayid
//
LocalGatewayId *string `field:"optional" json:"localGatewayId" yaml:"localGatewayId"`
// [IPv4 traffic only] The ID of a NAT gateway.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-natgatewayid
//
NatGatewayId *string `field:"optional" json:"natGatewayId" yaml:"natGatewayId"`
// The ID of a network interface.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-networkinterfaceid
//
NetworkInterfaceId *string `field:"optional" json:"networkInterfaceId" yaml:"networkInterfaceId"`
// The ID of a transit gateway.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-transitgatewayid
//
TransitGatewayId *string `field:"optional" json:"transitGatewayId" yaml:"transitGatewayId"`
// The ID of a VPC endpoint.
//
// Supported for Gateway Load Balancer endpoints only.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-vpcendpointid
//
VpcEndpointId *string `field:"optional" json:"vpcEndpointId" yaml:"vpcEndpointId"`
// The ID of a VPC peering connection.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-vpcpeeringconnectionid
//
VpcPeeringConnectionId *string `field:"optional" json:"vpcPeeringConnectionId" yaml:"vpcPeeringConnectionId"`
}
Properties for defining a `CfnRoute`.
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"
cfnRouteProps := &CfnRouteProps{
RouteTableId: jsii.String("routeTableId"),
// the properties below are optional
CarrierGatewayId: jsii.String("carrierGatewayId"),
CoreNetworkArn: jsii.String("coreNetworkArn"),
DestinationCidrBlock: jsii.String("destinationCidrBlock"),
DestinationIpv6CidrBlock: jsii.String("destinationIpv6CidrBlock"),
DestinationPrefixListId: jsii.String("destinationPrefixListId"),
EgressOnlyInternetGatewayId: jsii.String("egressOnlyInternetGatewayId"),
GatewayId: jsii.String("gatewayId"),
InstanceId: jsii.String("instanceId"),
LocalGatewayId: jsii.String("localGatewayId"),
NatGatewayId: jsii.String("natGatewayId"),
NetworkInterfaceId: jsii.String("networkInterfaceId"),
TransitGatewayId: jsii.String("transitGatewayId"),
VpcEndpointId: jsii.String("vpcEndpointId"),
VpcPeeringConnectionId: jsii.String("vpcPeeringConnectionId"),
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html
type CfnRouteTable ¶
type CfnRouteTable interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggable
// The ID of the route table.
AttrRouteTableId() *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
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
// Any tags assigned to the route table.
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 ID of the VPC.
VpcId() *string
SetVpcId(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{})
}
Specifies a route table for the specified VPC.
After you create a route table, you can add routes and associate the table with a subnet.
For more information, see [Route tables](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html) in the *Amazon VPC User 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"
cfnRouteTable := awscdk.Aws_ec2.NewCfnRouteTable(this, jsii.String("MyCfnRouteTable"), &CfnRouteTableProps{
VpcId: jsii.String("vpcId"),
// the properties below are optional
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routetable.html
func NewCfnRouteTable ¶
func NewCfnRouteTable(scope constructs.Construct, id *string, props *CfnRouteTableProps) CfnRouteTable
type CfnRouteTableProps ¶
type CfnRouteTableProps struct {
// The ID of the VPC.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routetable.html#cfn-ec2-routetable-vpcid
//
VpcId *string `field:"required" json:"vpcId" yaml:"vpcId"`
// Any tags assigned to the route table.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routetable.html#cfn-ec2-routetable-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnRouteTable`.
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"
cfnRouteTableProps := &CfnRouteTableProps{
VpcId: jsii.String("vpcId"),
// the properties below are optional
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routetable.html
type CfnSecurityGroup ¶
type CfnSecurityGroup interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggable
// The ID of the security group, such as `sg-94b3a1f6` .
AttrGroupId() *string
// The group name or group ID depending on whether the SG is created in default or specific VPC.
AttrId() *string
// The ID of the VPC, such as `vpc-0669f8f9` .
AttrVpcId() *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 description for the security group.
GroupDescription() *string
SetGroupDescription(val *string)
// The name of the security group.
GroupName() *string
SetGroupName(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 outbound rules associated with the security group.
SecurityGroupEgress() interface{}
SetSecurityGroupEgress(val interface{})
// The inbound rules associated with the security group.
SecurityGroupIngress() interface{}
SetSecurityGroupIngress(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
// Any tags assigned to the security group.
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 ID of the VPC for the security group.
VpcId() *string
SetVpcId(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{})
}
Specifies a security group.
To create a security group, use the [VpcId](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html#cfn-ec2-securitygroup-vpcid) property to specify the VPC for which to create the security group.
If you do not specify an egress rule, we add egress rules that allow IPv4 and IPv6 traffic on all ports and protocols to any destination. We do not add these rules if you specify your own egress rules.
This type supports updates. For more information about updating stacks, see [AWS CloudFormation Stacks Updates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html) .
> To cross-reference two security groups in the ingress and egress rules of those security groups, use the [AWS::EC2::SecurityGroupEgress](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-security-group-egress.html) and [AWS::EC2::SecurityGroupIngress](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-security-group-ingress.html) resources to define your rules. Do not use the embedded ingress and egress rules in the `AWS::EC2::SecurityGroup` . Doing so creates a circular dependency, which AWS CloudFormation doesn't allow.
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"
cfnSecurityGroup := awscdk.Aws_ec2.NewCfnSecurityGroup(this, jsii.String("MyCfnSecurityGroup"), &CfnSecurityGroupProps{
GroupDescription: jsii.String("groupDescription"),
// the properties below are optional
GroupName: jsii.String("groupName"),
SecurityGroupEgress: []interface{}{
&EgressProperty{
IpProtocol: jsii.String("ipProtocol"),
// the properties below are optional
CidrIp: jsii.String("cidrIp"),
CidrIpv6: jsii.String("cidrIpv6"),
Description: jsii.String("description"),
DestinationPrefixListId: jsii.String("destinationPrefixListId"),
DestinationSecurityGroupId: jsii.String("destinationSecurityGroupId"),
FromPort: jsii.Number(123),
ToPort: jsii.Number(123),
},
},
SecurityGroupIngress: []interface{}{
&IngressProperty{
IpProtocol: jsii.String("ipProtocol"),
// the properties below are optional
CidrIp: jsii.String("cidrIp"),
CidrIpv6: jsii.String("cidrIpv6"),
Description: jsii.String("description"),
FromPort: jsii.Number(123),
SourcePrefixListId: jsii.String("sourcePrefixListId"),
SourceSecurityGroupId: jsii.String("sourceSecurityGroupId"),
SourceSecurityGroupName: jsii.String("sourceSecurityGroupName"),
SourceSecurityGroupOwnerId: jsii.String("sourceSecurityGroupOwnerId"),
ToPort: jsii.Number(123),
},
},
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
VpcId: jsii.String("vpcId"),
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroup.html
func NewCfnSecurityGroup ¶
func NewCfnSecurityGroup(scope constructs.Construct, id *string, props *CfnSecurityGroupProps) CfnSecurityGroup
type CfnSecurityGroupEgress ¶
type CfnSecurityGroupEgress interface {
awscdk.CfnResource
awscdk.IInspectable
AttrId() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// The IPv4 address range, in CIDR format.
CidrIp() *string
SetCidrIp(val *string)
// The IPv6 address range, in CIDR format.
CidrIpv6() *string
SetCidrIpv6(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 description of an egress (outbound) security group rule.
Description() *string
SetDescription(val *string)
// The prefix list IDs for an AWS service.
DestinationPrefixListId() *string
SetDestinationPrefixListId(val *string)
// The ID of the security group.
DestinationSecurityGroupId() *string
SetDestinationSecurityGroupId(val *string)
// If the protocol is TCP or UDP, this is the start of the port range.
FromPort() *float64
SetFromPort(val *float64)
// The ID of the security group.
GroupId() *string
SetGroupId(val *string)
// The IP protocol name ( `tcp` , `udp` , `icmp` , `icmpv6` ) or number (see [Protocol Numbers](https://docs.aws.amazon.com/http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml) ).
IpProtocol() *string
SetIpProtocol(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
// If the protocol is TCP or UDP, this is the end of the port range.
ToPort() *float64
SetToPort(val *float64)
// 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{})
}
Adds the specified outbound (egress) rule to a security group.
An outbound rule permits instances to send traffic to the specified IPv4 or IPv6 address range, the IP addresses that are specified by a prefix list, or the instances that are associated with a destination security group. For more information, see [Security group rules](https://docs.aws.amazon.com/vpc/latest/userguide/security-group-rules.html) .
You must specify exactly one of the following destinations: an IPv4 address range, an IPv6 address range, a prefix list, or a security group.
You must specify a protocol for each rule (for example, TCP). If the protocol is TCP or UDP, you must also specify a port or port range. If the protocol is ICMP or ICMPv6, you must also specify the ICMP/ICMPv6 type and code. To specify all types or all codes, use -1.
Rule changes are propagated to instances associated with the security group as quickly as possible. However, a small delay might occur.
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"
cfnSecurityGroupEgress := awscdk.Aws_ec2.NewCfnSecurityGroupEgress(this, jsii.String("MyCfnSecurityGroupEgress"), &CfnSecurityGroupEgressProps{
GroupId: jsii.String("groupId"),
IpProtocol: jsii.String("ipProtocol"),
// the properties below are optional
CidrIp: jsii.String("cidrIp"),
CidrIpv6: jsii.String("cidrIpv6"),
Description: jsii.String("description"),
DestinationPrefixListId: jsii.String("destinationPrefixListId"),
DestinationSecurityGroupId: jsii.String("destinationSecurityGroupId"),
FromPort: jsii.Number(123),
ToPort: jsii.Number(123),
})
func NewCfnSecurityGroupEgress ¶
func NewCfnSecurityGroupEgress(scope constructs.Construct, id *string, props *CfnSecurityGroupEgressProps) CfnSecurityGroupEgress
type CfnSecurityGroupEgressProps ¶
type CfnSecurityGroupEgressProps struct {
// The ID of the security group.
//
// You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupegress.html#cfn-ec2-securitygroupegress-groupid
//
GroupId *string `field:"required" json:"groupId" yaml:"groupId"`
// The IP protocol name ( `tcp` , `udp` , `icmp` , `icmpv6` ) or number (see [Protocol Numbers](https://docs.aws.amazon.com/http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml) ).
//
// Use `-1` to specify all protocols. When authorizing security group rules, specifying `-1` or a protocol number other than `tcp` , `udp` , `icmp` , or `icmpv6` allows traffic on all ports, regardless of any port range you specify. For `tcp` , `udp` , and `icmp` , you must specify a port range. For `icmpv6` , the port range is optional; if you omit the port range, traffic for all types and codes is allowed.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupegress.html#cfn-ec2-securitygroupegress-ipprotocol
//
IpProtocol *string `field:"required" json:"ipProtocol" yaml:"ipProtocol"`
// The IPv4 address range, in CIDR format.
//
// You must specify exactly one of the following: `CidrIp` , `CidrIpv6` , `DestinationPrefixListId` , or `DestinationSecurityGroupId` .
//
// For examples of rules that you can add to security groups for specific access scenarios, see [Security group rules for different use cases](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html) in the *Amazon EC2 User Guide* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupegress.html#cfn-ec2-securitygroupegress-cidrip
//
CidrIp *string `field:"optional" json:"cidrIp" yaml:"cidrIp"`
// The IPv6 address range, in CIDR format.
//
// You must specify exactly one of the following: `CidrIp` , `CidrIpv6` , `DestinationPrefixListId` , or `DestinationSecurityGroupId` .
//
// For examples of rules that you can add to security groups for specific access scenarios, see [Security group rules for different use cases](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html) in the *Amazon EC2 User Guide* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupegress.html#cfn-ec2-securitygroupegress-cidripv6
//
CidrIpv6 *string `field:"optional" json:"cidrIpv6" yaml:"cidrIpv6"`
// The description of an egress (outbound) security group rule.
//
// Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupegress.html#cfn-ec2-securitygroupegress-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// The prefix list IDs for an AWS service.
//
// This is the AWS service to access through a VPC endpoint from instances associated with the security group.
//
// You must specify exactly one of the following: `CidrIp` , `CidrIpv6` , `DestinationPrefixListId` , or `DestinationSecurityGroupId` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupegress.html#cfn-ec2-securitygroupegress-destinationprefixlistid
//
DestinationPrefixListId *string `field:"optional" json:"destinationPrefixListId" yaml:"destinationPrefixListId"`
// The ID of the security group.
//
// You must specify exactly one of the following: `CidrIp` , `CidrIpv6` , `DestinationPrefixListId` , or `DestinationSecurityGroupId` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupegress.html#cfn-ec2-securitygroupegress-destinationsecuritygroupid
//
DestinationSecurityGroupId *string `field:"optional" json:"destinationSecurityGroupId" yaml:"destinationSecurityGroupId"`
// If the protocol is TCP or UDP, this is the start of the port range.
//
// If the protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP types).
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupegress.html#cfn-ec2-securitygroupegress-fromport
//
FromPort *float64 `field:"optional" json:"fromPort" yaml:"fromPort"`
// If the protocol is TCP or UDP, this is the end of the port range.
//
// If the protocol is ICMP or ICMPv6, this is the ICMP code or -1 (all ICMP codes). If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes).
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupegress.html#cfn-ec2-securitygroupegress-toport
//
ToPort *float64 `field:"optional" json:"toPort" yaml:"toPort"`
}
Properties for defining a `CfnSecurityGroupEgress`.
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"
cfnSecurityGroupEgressProps := &CfnSecurityGroupEgressProps{
GroupId: jsii.String("groupId"),
IpProtocol: jsii.String("ipProtocol"),
// the properties below are optional
CidrIp: jsii.String("cidrIp"),
CidrIpv6: jsii.String("cidrIpv6"),
Description: jsii.String("description"),
DestinationPrefixListId: jsii.String("destinationPrefixListId"),
DestinationSecurityGroupId: jsii.String("destinationSecurityGroupId"),
FromPort: jsii.Number(123),
ToPort: jsii.Number(123),
}
type CfnSecurityGroupIngress ¶
type CfnSecurityGroupIngress interface {
awscdk.CfnResource
awscdk.IInspectable
// The Security Group Rule Id.
AttrId() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// The IPv4 address range, in CIDR format.
CidrIp() *string
SetCidrIp(val *string)
// The IPv6 address range, in CIDR format.
CidrIpv6() *string
SetCidrIpv6(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
// Updates the description of an ingress (inbound) security group rule.
Description() *string
SetDescription(val *string)
// The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number.
FromPort() *float64
SetFromPort(val *float64)
// The ID of the security group.
GroupId() *string
SetGroupId(val *string)
// The name of the security group.
GroupName() *string
SetGroupName(val *string)
// The IP protocol name ( `tcp` , `udp` , `icmp` , `icmpv6` ) or number (see [Protocol Numbers](https://docs.aws.amazon.com/http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml) ).
IpProtocol() *string
SetIpProtocol(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 ID of a prefix list.
SourcePrefixListId() *string
SetSourcePrefixListId(val *string)
// The ID of the security group.
SourceSecurityGroupId() *string
SetSourceSecurityGroupId(val *string)
// [Default VPC] The name of the source security group.
SourceSecurityGroupName() *string
SetSourceSecurityGroupName(val *string)
// [nondefault VPC] The AWS account ID for the source security group, if the source security group is in a different account.
SourceSecurityGroupOwnerId() *string
SetSourceSecurityGroupOwnerId(val *string)
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code.
ToPort() *float64
SetToPort(val *float64)
// 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{})
}
Adds an inbound (ingress) rule to a security group.
An inbound rule permits instances to receive traffic from the specified IPv4 or IPv6 address range, the IP addresses that are specified by a prefix list, or the instances that are associated with a source security group. For more information, see [Security group rules](https://docs.aws.amazon.com/vpc/latest/userguide/security-group-rules.html) .
You must specify exactly one of the following sources: an IPv4 address range, an IPv6 address range, a prefix list, or a security group.
You must specify a protocol for each rule (for example, TCP). If the protocol is TCP or UDP, you must also specify a port or port range. If the protocol is ICMP or ICMPv6, you must also specify the ICMP/ICMPv6 type and code.
Rule changes are propagated to instances associated with the security group as quickly as possible. However, a small delay might occur.
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"
cfnSecurityGroupIngress := awscdk.Aws_ec2.NewCfnSecurityGroupIngress(this, jsii.String("MyCfnSecurityGroupIngress"), &CfnSecurityGroupIngressProps{
IpProtocol: jsii.String("ipProtocol"),
// the properties below are optional
CidrIp: jsii.String("cidrIp"),
CidrIpv6: jsii.String("cidrIpv6"),
Description: jsii.String("description"),
FromPort: jsii.Number(123),
GroupId: jsii.String("groupId"),
GroupName: jsii.String("groupName"),
SourcePrefixListId: jsii.String("sourcePrefixListId"),
SourceSecurityGroupId: jsii.String("sourceSecurityGroupId"),
SourceSecurityGroupName: jsii.String("sourceSecurityGroupName"),
SourceSecurityGroupOwnerId: jsii.String("sourceSecurityGroupOwnerId"),
ToPort: jsii.Number(123),
})
func NewCfnSecurityGroupIngress ¶
func NewCfnSecurityGroupIngress(scope constructs.Construct, id *string, props *CfnSecurityGroupIngressProps) CfnSecurityGroupIngress
type CfnSecurityGroupIngressProps ¶
type CfnSecurityGroupIngressProps struct {
// The IP protocol name ( `tcp` , `udp` , `icmp` , `icmpv6` ) or number (see [Protocol Numbers](https://docs.aws.amazon.com/http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml) ).
//
// Use `-1` to specify all protocols. When authorizing security group rules, specifying `-1` or a protocol number other than `tcp` , `udp` , `icmp` , or `icmpv6` allows traffic on all ports, regardless of any port range you specify. For `tcp` , `udp` , and `icmp` , you must specify a port range. For `icmpv6` , the port range is optional; if you omit the port range, traffic for all types and codes is allowed.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupingress.html#cfn-ec2-securitygroupingress-ipprotocol
//
IpProtocol *string `field:"required" json:"ipProtocol" yaml:"ipProtocol"`
// The IPv4 address range, in CIDR format.
//
// You must specify exactly one of the following: `CidrIp` , `CidrIpv6` , `SourcePrefixListId` , or `SourceSecurityGroupId` .
//
// For examples of rules that you can add to security groups for specific access scenarios, see [Security group rules for different use cases](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html) in the *Amazon EC2 User Guide* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupingress.html#cfn-ec2-securitygroupingress-cidrip
//
CidrIp *string `field:"optional" json:"cidrIp" yaml:"cidrIp"`
// The IPv6 address range, in CIDR format.
//
// You must specify exactly one of the following: `CidrIp` , `CidrIpv6` , `SourcePrefixListId` , or `SourceSecurityGroupId` .
//
// For examples of rules that you can add to security groups for specific access scenarios, see [Security group rules for different use cases](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html) in the *Amazon EC2 User Guide* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupingress.html#cfn-ec2-securitygroupingress-cidripv6
//
CidrIpv6 *string `field:"optional" json:"cidrIpv6" yaml:"cidrIpv6"`
// Updates the description of an ingress (inbound) security group rule.
//
// You can replace an existing description, or add a description to a rule that did not have one previously.
//
// Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupingress.html#cfn-ec2-securitygroupingress-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number.
//
// A value of `-1` indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.
//
// Use this for ICMP and any protocol that uses ports.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupingress.html#cfn-ec2-securitygroupingress-fromport
//
FromPort *float64 `field:"optional" json:"fromPort" yaml:"fromPort"`
// The ID of the security group.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupingress.html#cfn-ec2-securitygroupingress-groupid
//
GroupId *string `field:"optional" json:"groupId" yaml:"groupId"`
// The name of the security group.
//
// Constraints: Up to 255 characters in length. Cannot start with `sg-` .
//
// Valid characters: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupingress.html#cfn-ec2-securitygroupingress-groupname
//
GroupName *string `field:"optional" json:"groupName" yaml:"groupName"`
// The ID of a prefix list.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupingress.html#cfn-ec2-securitygroupingress-sourceprefixlistid
//
SourcePrefixListId *string `field:"optional" json:"sourcePrefixListId" yaml:"sourcePrefixListId"`
// The ID of the security group.
//
// You must specify either the security group ID or the security group name. For security groups in a nondefault VPC, you must specify the security group ID.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupingress.html#cfn-ec2-securitygroupingress-sourcesecuritygroupid
//
SourceSecurityGroupId *string `field:"optional" json:"sourceSecurityGroupId" yaml:"sourceSecurityGroupId"`
// [Default VPC] The name of the source security group.
//
// You must specify either the security group ID or the security group name. You can't specify the group name in combination with an IP address range. Creates rules that grant full ICMP, UDP, and TCP access.
//
// For security groups in a nondefault VPC, you must specify the group ID.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupingress.html#cfn-ec2-securitygroupingress-sourcesecuritygroupname
//
SourceSecurityGroupName *string `field:"optional" json:"sourceSecurityGroupName" yaml:"sourceSecurityGroupName"`
// [nondefault VPC] The AWS account ID for the source security group, if the source security group is in a different account.
//
// You can't specify this property with an IP address range. Creates rules that grant full ICMP, UDP, and TCP access.
//
// If you specify `SourceSecurityGroupName` or `SourceSecurityGroupId` and that security group is owned by a different account than the account creating the stack, you must specify `SourceSecurityGroupOwnerId` ; otherwise, this property is optional.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupingress.html#cfn-ec2-securitygroupingress-sourcesecuritygroupownerid
//
SourceSecurityGroupOwnerId *string `field:"optional" json:"sourceSecurityGroupOwnerId" yaml:"sourceSecurityGroupOwnerId"`
// The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code.
//
// A value of `-1` indicates all ICMP/ICMPv6 codes for the specified ICMP type. If you specify all ICMP/ICMPv6 types, you must specify all codes.
//
// Use this for ICMP and any protocol that uses ports.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupingress.html#cfn-ec2-securitygroupingress-toport
//
ToPort *float64 `field:"optional" json:"toPort" yaml:"toPort"`
}
Properties for defining a `CfnSecurityGroupIngress`.
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"
cfnSecurityGroupIngressProps := &CfnSecurityGroupIngressProps{
IpProtocol: jsii.String("ipProtocol"),
// the properties below are optional
CidrIp: jsii.String("cidrIp"),
CidrIpv6: jsii.String("cidrIpv6"),
Description: jsii.String("description"),
FromPort: jsii.Number(123),
GroupId: jsii.String("groupId"),
GroupName: jsii.String("groupName"),
SourcePrefixListId: jsii.String("sourcePrefixListId"),
SourceSecurityGroupId: jsii.String("sourceSecurityGroupId"),
SourceSecurityGroupName: jsii.String("sourceSecurityGroupName"),
SourceSecurityGroupOwnerId: jsii.String("sourceSecurityGroupOwnerId"),
ToPort: jsii.Number(123),
}
type CfnSecurityGroupProps ¶
type CfnSecurityGroupProps struct {
// A description for the security group.
//
// Constraints: Up to 255 characters in length
//
// Valid characters: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroup.html#cfn-ec2-securitygroup-groupdescription
//
GroupDescription *string `field:"required" json:"groupDescription" yaml:"groupDescription"`
// The name of the security group.
//
// Constraints: Up to 255 characters in length. Cannot start with `sg-` .
//
// Valid characters: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroup.html#cfn-ec2-securitygroup-groupname
//
GroupName *string `field:"optional" json:"groupName" yaml:"groupName"`
// The outbound rules associated with the security group.
//
// There is a short interruption during which you cannot connect to the security group.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroup.html#cfn-ec2-securitygroup-securitygroupegress
//
SecurityGroupEgress interface{} `field:"optional" json:"securityGroupEgress" yaml:"securityGroupEgress"`
// The inbound rules associated with the security group.
//
// There is a short interruption during which you cannot connect to the security group.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroup.html#cfn-ec2-securitygroup-securitygroupingress
//
SecurityGroupIngress interface{} `field:"optional" json:"securityGroupIngress" yaml:"securityGroupIngress"`
// Any tags assigned to the security group.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroup.html#cfn-ec2-securitygroup-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
// The ID of the VPC for the security group.
//
// If you do not specify a VPC, the default is to use the default VPC for the Region. If there's no specified VPC and no default VPC, security group creation fails.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroup.html#cfn-ec2-securitygroup-vpcid
//
VpcId *string `field:"optional" json:"vpcId" yaml:"vpcId"`
}
Properties for defining a `CfnSecurityGroup`.
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"
cfnSecurityGroupProps := &CfnSecurityGroupProps{
GroupDescription: jsii.String("groupDescription"),
// the properties below are optional
GroupName: jsii.String("groupName"),
SecurityGroupEgress: []interface{}{
&EgressProperty{
IpProtocol: jsii.String("ipProtocol"),
// the properties below are optional
CidrIp: jsii.String("cidrIp"),
CidrIpv6: jsii.String("cidrIpv6"),
Description: jsii.String("description"),
DestinationPrefixListId: jsii.String("destinationPrefixListId"),
DestinationSecurityGroupId: jsii.String("destinationSecurityGroupId"),
FromPort: jsii.Number(123),
ToPort: jsii.Number(123),
},
},
SecurityGroupIngress: []interface{}{
&IngressProperty{
IpProtocol: jsii.String("ipProtocol"),
// the properties below are optional
CidrIp: jsii.String("cidrIp"),
CidrIpv6: jsii.String("cidrIpv6"),
Description: jsii.String("description"),
FromPort: jsii.Number(123),
SourcePrefixListId: jsii.String("sourcePrefixListId"),
SourceSecurityGroupId: jsii.String("sourceSecurityGroupId"),
SourceSecurityGroupName: jsii.String("sourceSecurityGroupName"),
SourceSecurityGroupOwnerId: jsii.String("sourceSecurityGroupOwnerId"),
ToPort: jsii.Number(123),
},
},
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
VpcId: jsii.String("vpcId"),
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroup.html
type CfnSecurityGroup_EgressProperty ¶
type CfnSecurityGroup_EgressProperty struct {
// The IP protocol name ( `tcp` , `udp` , `icmp` , `icmpv6` ) or number (see [Protocol Numbers](https://docs.aws.amazon.com/http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml) ).
//
// Use `-1` to specify all protocols. When authorizing security group rules, specifying `-1` or a protocol number other than `tcp` , `udp` , `icmp` , or `icmpv6` allows traffic on all ports, regardless of any port range you specify. For `tcp` , `udp` , and `icmp` , you must specify a port range. For `icmpv6` , the port range is optional; if you omit the port range, traffic for all types and codes is allowed.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-securitygroup-egress.html#cfn-ec2-securitygroup-egress-ipprotocol
//
IpProtocol *string `field:"required" json:"ipProtocol" yaml:"ipProtocol"`
// The IPv4 address range, in CIDR format.
//
// You must specify exactly one of the following: `CidrIp` , `CidrIpv6` , `DestinationPrefixListId` , or `DestinationSecurityGroupId` .
//
// For examples of rules that you can add to security groups for specific access scenarios, see [Security group rules for different use cases](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html) in the *Amazon EC2 User Guide* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-securitygroup-egress.html#cfn-ec2-securitygroup-egress-cidrip
//
CidrIp *string `field:"optional" json:"cidrIp" yaml:"cidrIp"`
// The IPv6 address range, in CIDR format.
//
// You must specify exactly one of the following: `CidrIp` , `CidrIpv6` , `DestinationPrefixListId` , or `DestinationSecurityGroupId` .
//
// For examples of rules that you can add to security groups for specific access scenarios, see [Security group rules for different use cases](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html) in the *Amazon EC2 User Guide* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-securitygroup-egress.html#cfn-ec2-securitygroup-egress-cidripv6
//
CidrIpv6 *string `field:"optional" json:"cidrIpv6" yaml:"cidrIpv6"`
// A description for the security group rule.
//
// Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-securitygroup-egress.html#cfn-ec2-securitygroup-egress-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// The prefix list IDs for the destination AWS service.
//
// This is the AWS service that you want to access through a VPC endpoint from instances associated with the security group.
//
// You must specify exactly one of the following: `CidrIp` , `CidrIpv6` , `DestinationPrefixListId` , or `DestinationSecurityGroupId` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-securitygroup-egress.html#cfn-ec2-securitygroup-egress-destinationprefixlistid
//
DestinationPrefixListId *string `field:"optional" json:"destinationPrefixListId" yaml:"destinationPrefixListId"`
// The ID of the destination VPC security group.
//
// You must specify exactly one of the following: `CidrIp` , `CidrIpv6` , `DestinationPrefixListId` , or `DestinationSecurityGroupId` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-securitygroup-egress.html#cfn-ec2-securitygroup-egress-destinationsecuritygroupid
//
DestinationSecurityGroupId *string `field:"optional" json:"destinationSecurityGroupId" yaml:"destinationSecurityGroupId"`
// If the protocol is TCP or UDP, this is the start of the port range.
//
// If the protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP types).
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-securitygroup-egress.html#cfn-ec2-securitygroup-egress-fromport
//
FromPort *float64 `field:"optional" json:"fromPort" yaml:"fromPort"`
// If the protocol is TCP or UDP, this is the end of the port range.
//
// If the protocol is ICMP or ICMPv6, this is the ICMP code or -1 (all ICMP codes). If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes).
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-securitygroup-egress.html#cfn-ec2-securitygroup-egress-toport
//
ToPort *float64 `field:"optional" json:"toPort" yaml:"toPort"`
}
Adds the specified outbound (egress) rule to a security group.
An outbound rule permits instances to send traffic to the specified IPv4 or IPv6 address range, the IP address ranges that are specified by a prefix list, or the instances that are associated with a destination security group. For more information, see [Security group rules](https://docs.aws.amazon.com/vpc/latest/userguide/security-group-rules.html) .
You must specify exactly one of the following destinations: an IPv4 address range, an IPv6 address range, a prefix list, or a security group.
You must specify a protocol for each rule (for example, TCP). If the protocol is TCP or UDP, you must also specify a port or port range. If the protocol is ICMP or ICMPv6, you must also specify the ICMP/ICMPv6 type and code.
Rule changes are propagated to instances associated with the security group as quickly as possible. However, a small delay might occur.
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"
egressProperty := &EgressProperty{
IpProtocol: jsii.String("ipProtocol"),
// the properties below are optional
CidrIp: jsii.String("cidrIp"),
CidrIpv6: jsii.String("cidrIpv6"),
Description: jsii.String("description"),
DestinationPrefixListId: jsii.String("destinationPrefixListId"),
DestinationSecurityGroupId: jsii.String("destinationSecurityGroupId"),
FromPort: jsii.Number(123),
ToPort: jsii.Number(123),
}
type CfnSecurityGroup_IngressProperty ¶
type CfnSecurityGroup_IngressProperty struct {
// The IP protocol name ( `tcp` , `udp` , `icmp` , `icmpv6` ) or number (see [Protocol Numbers](https://docs.aws.amazon.com/http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml) ).
//
// Use `-1` to specify all protocols. When authorizing security group rules, specifying `-1` or a protocol number other than `tcp` , `udp` , `icmp` , or `icmpv6` allows traffic on all ports, regardless of any port range you specify. For `tcp` , `udp` , and `icmp` , you must specify a port range. For `icmpv6` , the port range is optional; if you omit the port range, traffic for all types and codes is allowed.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-securitygroup-ingress.html#cfn-ec2-securitygroup-ingress-ipprotocol
//
IpProtocol *string `field:"required" json:"ipProtocol" yaml:"ipProtocol"`
// The IPv4 address range, in CIDR format.
//
// You must specify exactly one of the following: `CidrIp` , `CidrIpv6` , `SourcePrefixListId` , or `SourceSecurityGroupId` .
//
// For examples of rules that you can add to security groups for specific access scenarios, see [Security group rules for different use cases](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html) in the *Amazon EC2 User Guide* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-securitygroup-ingress.html#cfn-ec2-securitygroup-ingress-cidrip
//
CidrIp *string `field:"optional" json:"cidrIp" yaml:"cidrIp"`
// The IPv6 address range, in CIDR format.
//
// You must specify exactly one of the following: `CidrIp` , `CidrIpv6` , `SourcePrefixListId` , or `SourceSecurityGroupId` .
//
// For examples of rules that you can add to security groups for specific access scenarios, see [Security group rules for different use cases](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html) in the *Amazon EC2 User Guide* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-securitygroup-ingress.html#cfn-ec2-securitygroup-ingress-cidripv6
//
CidrIpv6 *string `field:"optional" json:"cidrIpv6" yaml:"cidrIpv6"`
// Updates the description of an ingress (inbound) security group rule.
//
// You can replace an existing description, or add a description to a rule that did not have one previously.
//
// Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-securitygroup-ingress.html#cfn-ec2-securitygroup-ingress-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// If the protocol is TCP or UDP, this is the start of the port range.
//
// If the protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP types).
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-securitygroup-ingress.html#cfn-ec2-securitygroup-ingress-fromport
//
FromPort *float64 `field:"optional" json:"fromPort" yaml:"fromPort"`
// The ID of a prefix list.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-securitygroup-ingress.html#cfn-ec2-securitygroup-ingress-sourceprefixlistid
//
SourcePrefixListId *string `field:"optional" json:"sourcePrefixListId" yaml:"sourcePrefixListId"`
// The ID of the security group.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-securitygroup-ingress.html#cfn-ec2-securitygroup-ingress-sourcesecuritygroupid
//
SourceSecurityGroupId *string `field:"optional" json:"sourceSecurityGroupId" yaml:"sourceSecurityGroupId"`
// [Default VPC] The name of the source security group.
//
// You must specify either the security group ID or the security group name. You can't specify the group name in combination with an IP address range. Creates rules that grant full ICMP, UDP, and TCP access.
//
// For security groups in a nondefault VPC, you must specify the group ID.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-securitygroup-ingress.html#cfn-ec2-securitygroup-ingress-sourcesecuritygroupname
//
SourceSecurityGroupName *string `field:"optional" json:"sourceSecurityGroupName" yaml:"sourceSecurityGroupName"`
// [nondefault VPC] The AWS account ID for the source security group, if the source security group is in a different account.
//
// You can't specify this property with an IP address range. Creates rules that grant full ICMP, UDP, and TCP access.
//
// If you specify `SourceSecurityGroupName` or `SourceSecurityGroupId` and that security group is owned by a different account than the account creating the stack, you must specify the `SourceSecurityGroupOwnerId` ; otherwise, this property is optional.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-securitygroup-ingress.html#cfn-ec2-securitygroup-ingress-sourcesecuritygroupownerid
//
SourceSecurityGroupOwnerId *string `field:"optional" json:"sourceSecurityGroupOwnerId" yaml:"sourceSecurityGroupOwnerId"`
// If the protocol is TCP or UDP, this is the end of the port range.
//
// If the protocol is ICMP or ICMPv6, this is the ICMP code or -1 (all ICMP codes). If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes).
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-securitygroup-ingress.html#cfn-ec2-securitygroup-ingress-toport
//
ToPort *float64 `field:"optional" json:"toPort" yaml:"toPort"`
}
Adds an inbound (ingress) rule to a security group.
An inbound rule permits instances to receive traffic from the specified IPv4 or IPv6 address range, the IP address ranges that are specified by a prefix list, or the instances that are associated with a source security group. For more information, see [Security group rules](https://docs.aws.amazon.com/vpc/latest/userguide/security-group-rules.html) .
You must specify exactly one of the following sources: an IPv4 address range, an IPv6 address range, a prefix list, or a security group.
You must specify a protocol for each rule (for example, TCP). If the protocol is TCP or UDP, you must also specify a port or port range. If the protocol is ICMP or ICMPv6, you must also specify the ICMP/ICMPv6 type and code.
Rule changes are propagated to instances associated with the security group as quickly as possible. However, a small delay might occur.
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"
ingressProperty := &IngressProperty{
IpProtocol: jsii.String("ipProtocol"),
// the properties below are optional
CidrIp: jsii.String("cidrIp"),
CidrIpv6: jsii.String("cidrIpv6"),
Description: jsii.String("description"),
FromPort: jsii.Number(123),
SourcePrefixListId: jsii.String("sourcePrefixListId"),
SourceSecurityGroupId: jsii.String("sourceSecurityGroupId"),
SourceSecurityGroupName: jsii.String("sourceSecurityGroupName"),
SourceSecurityGroupOwnerId: jsii.String("sourceSecurityGroupOwnerId"),
ToPort: jsii.Number(123),
}
type CfnSnapshotBlockPublicAccess ¶ added in v2.116.0
type CfnSnapshotBlockPublicAccess interface {
awscdk.CfnResource
awscdk.IInspectable
// `Ref` returns the ID of the AWS account.
AttrAccountId() *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 mode in which to enable block public access for snapshots for the Region.
State() *string
SetState(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{})
}
Specifies the state of the *block public access for snapshots* setting for the Region.
For more information, see [Block public access for snapshots](https://docs.aws.amazon.com/ebs/latest/userguide/block-public-access-snapshots.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"
cfnSnapshotBlockPublicAccess := awscdk.Aws_ec2.NewCfnSnapshotBlockPublicAccess(this, jsii.String("MyCfnSnapshotBlockPublicAccess"), &CfnSnapshotBlockPublicAccessProps{
State: jsii.String("state"),
})
func NewCfnSnapshotBlockPublicAccess ¶ added in v2.116.0
func NewCfnSnapshotBlockPublicAccess(scope constructs.Construct, id *string, props *CfnSnapshotBlockPublicAccessProps) CfnSnapshotBlockPublicAccess
type CfnSnapshotBlockPublicAccessProps ¶ added in v2.116.0
type CfnSnapshotBlockPublicAccessProps struct {
// The mode in which to enable block public access for snapshots for the Region.
//
// Specify one of the following values:
//
// - `block-all-sharing` - Prevents all public sharing of snapshots in the Region. Users in the account will no longer be able to request new public sharing. Additionally, snapshots that are already publicly shared are treated as private and they are no longer publicly available.
//
// > If you enable block public access for snapshots in `block-all-sharing` mode, it does not change the permissions for snapshots that are already publicly shared. Instead, it prevents these snapshots from be publicly visible and publicly accessible. Therefore, the attributes for these snapshots still indicate that they are publicly shared, even though they are not publicly available.
// - `block-new-sharing` - Prevents only new public sharing of snapshots in the Region. Users in the account will no longer be able to request new public sharing. However, snapshots that are already publicly shared, remain publicly available.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-snapshotblockpublicaccess.html#cfn-ec2-snapshotblockpublicaccess-state
//
State *string `field:"required" json:"state" yaml:"state"`
}
Properties for defining a `CfnSnapshotBlockPublicAccess`.
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"
cfnSnapshotBlockPublicAccessProps := &CfnSnapshotBlockPublicAccessProps{
State: jsii.String("state"),
}
type CfnSpotFleet ¶
type CfnSpotFleet interface {
awscdk.CfnResource
awscdk.IInspectable
// The ID of the Spot Fleet.
AttrId() *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
// Describes the configuration of a Spot Fleet request.
SpotFleetRequestConfigData() interface{}
SetSpotFleetRequestConfigData(val interface{})
// 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{})
}
Specifies a Spot Fleet request.
The Spot Fleet request specifies the total target capacity and the On-Demand target capacity. Amazon EC2 calculates the difference between the total capacity and On-Demand capacity, and launches the difference as Spot capacity.
You can submit a single request that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet.
By default, the Spot Fleet requests Spot Instances in the Spot Instance pool where the price per unit is the lowest. Each launch specification can include its own instance weighting that reflects the value of the instance type to your application workload.
Alternatively, you can specify that the Spot Fleet distribute the target capacity across the Spot pools included in its launch specifications. By ensuring that the Spot Instances in your Spot Fleet are in different Spot pools, you can improve the availability of your fleet.
You can specify tags for the Spot Fleet request and instances launched by the fleet. You cannot tag other resource types in a Spot Fleet request because only the `spot-fleet-request` and `instance` resource types are supported.
For more information, see [Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet.html) in the *Amazon EC2 User 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"
cfnSpotFleet := awscdk.Aws_ec2.NewCfnSpotFleet(this, jsii.String("MyCfnSpotFleet"), &CfnSpotFleetProps{
SpotFleetRequestConfigData: &SpotFleetRequestConfigDataProperty{
IamFleetRole: jsii.String("iamFleetRole"),
TargetCapacity: jsii.Number(123),
// the properties below are optional
AllocationStrategy: jsii.String("allocationStrategy"),
Context: jsii.String("context"),
ExcessCapacityTerminationPolicy: jsii.String("excessCapacityTerminationPolicy"),
InstanceInterruptionBehavior: jsii.String("instanceInterruptionBehavior"),
InstancePoolsToUseCount: jsii.Number(123),
LaunchSpecifications: []interface{}{
&SpotFleetLaunchSpecificationProperty{
ImageId: jsii.String("imageId"),
// the properties below are optional
BlockDeviceMappings: []interface{}{
&BlockDeviceMappingProperty{
DeviceName: jsii.String("deviceName"),
// the properties below are optional
Ebs: &EbsBlockDeviceProperty{
DeleteOnTermination: jsii.Boolean(false),
Encrypted: jsii.Boolean(false),
Iops: jsii.Number(123),
SnapshotId: jsii.String("snapshotId"),
VolumeSize: jsii.Number(123),
VolumeType: jsii.String("volumeType"),
},
NoDevice: jsii.String("noDevice"),
VirtualName: jsii.String("virtualName"),
},
},
EbsOptimized: jsii.Boolean(false),
IamInstanceProfile: &IamInstanceProfileSpecificationProperty{
Arn: jsii.String("arn"),
},
InstanceRequirements: &InstanceRequirementsRequestProperty{
AcceleratorCount: &AcceleratorCountRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
AcceleratorManufacturers: []*string{
jsii.String("acceleratorManufacturers"),
},
AcceleratorNames: []*string{
jsii.String("acceleratorNames"),
},
AcceleratorTotalMemoryMiB: &AcceleratorTotalMemoryMiBRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
AcceleratorTypes: []*string{
jsii.String("acceleratorTypes"),
},
AllowedInstanceTypes: []*string{
jsii.String("allowedInstanceTypes"),
},
BareMetal: jsii.String("bareMetal"),
BaselineEbsBandwidthMbps: &BaselineEbsBandwidthMbpsRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
BurstablePerformance: jsii.String("burstablePerformance"),
CpuManufacturers: []*string{
jsii.String("cpuManufacturers"),
},
ExcludedInstanceTypes: []*string{
jsii.String("excludedInstanceTypes"),
},
InstanceGenerations: []*string{
jsii.String("instanceGenerations"),
},
LocalStorage: jsii.String("localStorage"),
LocalStorageTypes: []*string{
jsii.String("localStorageTypes"),
},
MaxSpotPriceAsPercentageOfOptimalOnDemandPrice: jsii.Number(123),
MemoryGiBPerVCpu: &MemoryGiBPerVCpuRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
MemoryMiB: &MemoryMiBRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
NetworkBandwidthGbps: &NetworkBandwidthGbpsRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
NetworkInterfaceCount: &NetworkInterfaceCountRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
OnDemandMaxPricePercentageOverLowestPrice: jsii.Number(123),
RequireHibernateSupport: jsii.Boolean(false),
SpotMaxPricePercentageOverLowestPrice: jsii.Number(123),
TotalLocalStorageGb: &TotalLocalStorageGBRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
VCpuCount: &VCpuCountRangeRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
},
InstanceType: jsii.String("instanceType"),
KernelId: jsii.String("kernelId"),
KeyName: jsii.String("keyName"),
Monitoring: &SpotFleetMonitoringProperty{
Enabled: jsii.Boolean(false),
},
NetworkInterfaces: []interface{}{
&InstanceNetworkInterfaceSpecificationProperty{
AssociatePublicIpAddress: jsii.Boolean(false),
DeleteOnTermination: jsii.Boolean(false),
Description: jsii.String("description"),
DeviceIndex: jsii.Number(123),
Groups: []*string{
jsii.String("groups"),
},
Ipv6AddressCount: jsii.Number(123),
Ipv6Addresses: []interface{}{
&InstanceIpv6AddressProperty{
Ipv6Address: jsii.String("ipv6Address"),
},
},
NetworkInterfaceId: jsii.String("networkInterfaceId"),
PrivateIpAddresses: []interface{}{
&PrivateIpAddressSpecificationProperty{
PrivateIpAddress: jsii.String("privateIpAddress"),
// the properties below are optional
Primary: jsii.Boolean(false),
},
},
SecondaryPrivateIpAddressCount: jsii.Number(123),
SubnetId: jsii.String("subnetId"),
},
},
Placement: &SpotPlacementProperty{
AvailabilityZone: jsii.String("availabilityZone"),
GroupName: jsii.String("groupName"),
Tenancy: jsii.String("tenancy"),
},
RamdiskId: jsii.String("ramdiskId"),
SecurityGroups: []interface{}{
&GroupIdentifierProperty{
GroupId: jsii.String("groupId"),
},
},
SpotPrice: jsii.String("spotPrice"),
SubnetId: jsii.String("subnetId"),
TagSpecifications: []interface{}{
&SpotFleetTagSpecificationProperty{
ResourceType: jsii.String("resourceType"),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
},
},
UserData: jsii.String("userData"),
WeightedCapacity: jsii.Number(123),
},
},
LaunchTemplateConfigs: []interface{}{
&LaunchTemplateConfigProperty{
LaunchTemplateSpecification: &FleetLaunchTemplateSpecificationProperty{
Version: jsii.String("version"),
// the properties below are optional
LaunchTemplateId: jsii.String("launchTemplateId"),
LaunchTemplateName: jsii.String("launchTemplateName"),
},
Overrides: []interface{}{
&LaunchTemplateOverridesProperty{
AvailabilityZone: jsii.String("availabilityZone"),
InstanceRequirements: &InstanceRequirementsRequestProperty{
AcceleratorCount: &AcceleratorCountRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
AcceleratorManufacturers: []*string{
jsii.String("acceleratorManufacturers"),
},
AcceleratorNames: []*string{
jsii.String("acceleratorNames"),
},
AcceleratorTotalMemoryMiB: &AcceleratorTotalMemoryMiBRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
AcceleratorTypes: []*string{
jsii.String("acceleratorTypes"),
},
AllowedInstanceTypes: []*string{
jsii.String("allowedInstanceTypes"),
},
BareMetal: jsii.String("bareMetal"),
BaselineEbsBandwidthMbps: &BaselineEbsBandwidthMbpsRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
BurstablePerformance: jsii.String("burstablePerformance"),
CpuManufacturers: []*string{
jsii.String("cpuManufacturers"),
},
ExcludedInstanceTypes: []*string{
jsii.String("excludedInstanceTypes"),
},
InstanceGenerations: []*string{
jsii.String("instanceGenerations"),
},
LocalStorage: jsii.String("localStorage"),
LocalStorageTypes: []*string{
jsii.String("localStorageTypes"),
},
MaxSpotPriceAsPercentageOfOptimalOnDemandPrice: jsii.Number(123),
MemoryGiBPerVCpu: &MemoryGiBPerVCpuRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
MemoryMiB: &MemoryMiBRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
NetworkBandwidthGbps: &NetworkBandwidthGbpsRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
NetworkInterfaceCount: &NetworkInterfaceCountRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
OnDemandMaxPricePercentageOverLowestPrice: jsii.Number(123),
RequireHibernateSupport: jsii.Boolean(false),
SpotMaxPricePercentageOverLowestPrice: jsii.Number(123),
TotalLocalStorageGb: &TotalLocalStorageGBRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
VCpuCount: &VCpuCountRangeRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
},
InstanceType: jsii.String("instanceType"),
Priority: jsii.Number(123),
SpotPrice: jsii.String("spotPrice"),
SubnetId: jsii.String("subnetId"),
WeightedCapacity: jsii.Number(123),
},
},
},
},
LoadBalancersConfig: &LoadBalancersConfigProperty{
ClassicLoadBalancersConfig: &ClassicLoadBalancersConfigProperty{
ClassicLoadBalancers: []interface{}{
&ClassicLoadBalancerProperty{
Name: jsii.String("name"),
},
},
},
TargetGroupsConfig: &TargetGroupsConfigProperty{
TargetGroups: []interface{}{
&TargetGroupProperty{
Arn: jsii.String("arn"),
},
},
},
},
OnDemandAllocationStrategy: jsii.String("onDemandAllocationStrategy"),
OnDemandMaxTotalPrice: jsii.String("onDemandMaxTotalPrice"),
OnDemandTargetCapacity: jsii.Number(123),
ReplaceUnhealthyInstances: jsii.Boolean(false),
SpotMaintenanceStrategies: &SpotMaintenanceStrategiesProperty{
CapacityRebalance: &SpotCapacityRebalanceProperty{
ReplacementStrategy: jsii.String("replacementStrategy"),
TerminationDelay: jsii.Number(123),
},
},
SpotMaxTotalPrice: jsii.String("spotMaxTotalPrice"),
SpotPrice: jsii.String("spotPrice"),
TagSpecifications: []interface{}{
&SpotFleetTagSpecificationProperty{
ResourceType: jsii.String("resourceType"),
Tags: []*cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
},
},
TargetCapacityUnitType: jsii.String("targetCapacityUnitType"),
TerminateInstancesWithExpiration: jsii.Boolean(false),
Type: jsii.String("type"),
ValidFrom: jsii.String("validFrom"),
ValidUntil: jsii.String("validUntil"),
},
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-spotfleet.html
func NewCfnSpotFleet ¶
func NewCfnSpotFleet(scope constructs.Construct, id *string, props *CfnSpotFleetProps) CfnSpotFleet
type CfnSpotFleetProps ¶
type CfnSpotFleetProps struct {
// Describes the configuration of a Spot Fleet request.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-spotfleet.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata
//
SpotFleetRequestConfigData interface{} `field:"required" json:"spotFleetRequestConfigData" yaml:"spotFleetRequestConfigData"`
}
Properties for defining a `CfnSpotFleet`.
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"
cfnSpotFleetProps := &CfnSpotFleetProps{
SpotFleetRequestConfigData: &SpotFleetRequestConfigDataProperty{
IamFleetRole: jsii.String("iamFleetRole"),
TargetCapacity: jsii.Number(123),
// the properties below are optional
AllocationStrategy: jsii.String("allocationStrategy"),
Context: jsii.String("context"),
ExcessCapacityTerminationPolicy: jsii.String("excessCapacityTerminationPolicy"),
InstanceInterruptionBehavior: jsii.String("instanceInterruptionBehavior"),
InstancePoolsToUseCount: jsii.Number(123),
LaunchSpecifications: []interface{}{
&SpotFleetLaunchSpecificationProperty{
ImageId: jsii.String("imageId"),
// the properties below are optional
BlockDeviceMappings: []interface{}{
&BlockDeviceMappingProperty{
DeviceName: jsii.String("deviceName"),
// the properties below are optional
Ebs: &EbsBlockDeviceProperty{
DeleteOnTermination: jsii.Boolean(false),
Encrypted: jsii.Boolean(false),
Iops: jsii.Number(123),
SnapshotId: jsii.String("snapshotId"),
VolumeSize: jsii.Number(123),
VolumeType: jsii.String("volumeType"),
},
NoDevice: jsii.String("noDevice"),
VirtualName: jsii.String("virtualName"),
},
},
EbsOptimized: jsii.Boolean(false),
IamInstanceProfile: &IamInstanceProfileSpecificationProperty{
Arn: jsii.String("arn"),
},
InstanceRequirements: &InstanceRequirementsRequestProperty{
AcceleratorCount: &AcceleratorCountRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
AcceleratorManufacturers: []*string{
jsii.String("acceleratorManufacturers"),
},
AcceleratorNames: []*string{
jsii.String("acceleratorNames"),
},
AcceleratorTotalMemoryMiB: &AcceleratorTotalMemoryMiBRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
AcceleratorTypes: []*string{
jsii.String("acceleratorTypes"),
},
AllowedInstanceTypes: []*string{
jsii.String("allowedInstanceTypes"),
},
BareMetal: jsii.String("bareMetal"),
BaselineEbsBandwidthMbps: &BaselineEbsBandwidthMbpsRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
BurstablePerformance: jsii.String("burstablePerformance"),
CpuManufacturers: []*string{
jsii.String("cpuManufacturers"),
},
ExcludedInstanceTypes: []*string{
jsii.String("excludedInstanceTypes"),
},
InstanceGenerations: []*string{
jsii.String("instanceGenerations"),
},
LocalStorage: jsii.String("localStorage"),
LocalStorageTypes: []*string{
jsii.String("localStorageTypes"),
},
MaxSpotPriceAsPercentageOfOptimalOnDemandPrice: jsii.Number(123),
MemoryGiBPerVCpu: &MemoryGiBPerVCpuRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
MemoryMiB: &MemoryMiBRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
NetworkBandwidthGbps: &NetworkBandwidthGbpsRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
NetworkInterfaceCount: &NetworkInterfaceCountRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
OnDemandMaxPricePercentageOverLowestPrice: jsii.Number(123),
RequireHibernateSupport: jsii.Boolean(false),
SpotMaxPricePercentageOverLowestPrice: jsii.Number(123),
TotalLocalStorageGb: &TotalLocalStorageGBRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
VCpuCount: &VCpuCountRangeRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
},
InstanceType: jsii.String("instanceType"),
KernelId: jsii.String("kernelId"),
KeyName: jsii.String("keyName"),
Monitoring: &SpotFleetMonitoringProperty{
Enabled: jsii.Boolean(false),
},
NetworkInterfaces: []interface{}{
&InstanceNetworkInterfaceSpecificationProperty{
AssociatePublicIpAddress: jsii.Boolean(false),
DeleteOnTermination: jsii.Boolean(false),
Description: jsii.String("description"),
DeviceIndex: jsii.Number(123),
Groups: []*string{
jsii.String("groups"),
},
Ipv6AddressCount: jsii.Number(123),
Ipv6Addresses: []interface{}{
&InstanceIpv6AddressProperty{
Ipv6Address: jsii.String("ipv6Address"),
},
},
NetworkInterfaceId: jsii.String("networkInterfaceId"),
PrivateIpAddresses: []interface{}{
&PrivateIpAddressSpecificationProperty{
PrivateIpAddress: jsii.String("privateIpAddress"),
// the properties below are optional
Primary: jsii.Boolean(false),
},
},
SecondaryPrivateIpAddressCount: jsii.Number(123),
SubnetId: jsii.String("subnetId"),
},
},
Placement: &SpotPlacementProperty{
AvailabilityZone: jsii.String("availabilityZone"),
GroupName: jsii.String("groupName"),
Tenancy: jsii.String("tenancy"),
},
RamdiskId: jsii.String("ramdiskId"),
SecurityGroups: []interface{}{
&GroupIdentifierProperty{
GroupId: jsii.String("groupId"),
},
},
SpotPrice: jsii.String("spotPrice"),
SubnetId: jsii.String("subnetId"),
TagSpecifications: []interface{}{
&SpotFleetTagSpecificationProperty{
ResourceType: jsii.String("resourceType"),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
},
},
UserData: jsii.String("userData"),
WeightedCapacity: jsii.Number(123),
},
},
LaunchTemplateConfigs: []interface{}{
&LaunchTemplateConfigProperty{
LaunchTemplateSpecification: &FleetLaunchTemplateSpecificationProperty{
Version: jsii.String("version"),
// the properties below are optional
LaunchTemplateId: jsii.String("launchTemplateId"),
LaunchTemplateName: jsii.String("launchTemplateName"),
},
Overrides: []interface{}{
&LaunchTemplateOverridesProperty{
AvailabilityZone: jsii.String("availabilityZone"),
InstanceRequirements: &InstanceRequirementsRequestProperty{
AcceleratorCount: &AcceleratorCountRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
AcceleratorManufacturers: []*string{
jsii.String("acceleratorManufacturers"),
},
AcceleratorNames: []*string{
jsii.String("acceleratorNames"),
},
AcceleratorTotalMemoryMiB: &AcceleratorTotalMemoryMiBRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
AcceleratorTypes: []*string{
jsii.String("acceleratorTypes"),
},
AllowedInstanceTypes: []*string{
jsii.String("allowedInstanceTypes"),
},
BareMetal: jsii.String("bareMetal"),
BaselineEbsBandwidthMbps: &BaselineEbsBandwidthMbpsRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
BurstablePerformance: jsii.String("burstablePerformance"),
CpuManufacturers: []*string{
jsii.String("cpuManufacturers"),
},
ExcludedInstanceTypes: []*string{
jsii.String("excludedInstanceTypes"),
},
InstanceGenerations: []*string{
jsii.String("instanceGenerations"),
},
LocalStorage: jsii.String("localStorage"),
LocalStorageTypes: []*string{
jsii.String("localStorageTypes"),
},
MaxSpotPriceAsPercentageOfOptimalOnDemandPrice: jsii.Number(123),
MemoryGiBPerVCpu: &MemoryGiBPerVCpuRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
MemoryMiB: &MemoryMiBRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
NetworkBandwidthGbps: &NetworkBandwidthGbpsRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
NetworkInterfaceCount: &NetworkInterfaceCountRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
OnDemandMaxPricePercentageOverLowestPrice: jsii.Number(123),
RequireHibernateSupport: jsii.Boolean(false),
SpotMaxPricePercentageOverLowestPrice: jsii.Number(123),
TotalLocalStorageGb: &TotalLocalStorageGBRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
VCpuCount: &VCpuCountRangeRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
},
InstanceType: jsii.String("instanceType"),
Priority: jsii.Number(123),
SpotPrice: jsii.String("spotPrice"),
SubnetId: jsii.String("subnetId"),
WeightedCapacity: jsii.Number(123),
},
},
},
},
LoadBalancersConfig: &LoadBalancersConfigProperty{
ClassicLoadBalancersConfig: &ClassicLoadBalancersConfigProperty{
ClassicLoadBalancers: []interface{}{
&ClassicLoadBalancerProperty{
Name: jsii.String("name"),
},
},
},
TargetGroupsConfig: &TargetGroupsConfigProperty{
TargetGroups: []interface{}{
&TargetGroupProperty{
Arn: jsii.String("arn"),
},
},
},
},
OnDemandAllocationStrategy: jsii.String("onDemandAllocationStrategy"),
OnDemandMaxTotalPrice: jsii.String("onDemandMaxTotalPrice"),
OnDemandTargetCapacity: jsii.Number(123),
ReplaceUnhealthyInstances: jsii.Boolean(false),
SpotMaintenanceStrategies: &SpotMaintenanceStrategiesProperty{
CapacityRebalance: &SpotCapacityRebalanceProperty{
ReplacementStrategy: jsii.String("replacementStrategy"),
TerminationDelay: jsii.Number(123),
},
},
SpotMaxTotalPrice: jsii.String("spotMaxTotalPrice"),
SpotPrice: jsii.String("spotPrice"),
TagSpecifications: []interface{}{
&SpotFleetTagSpecificationProperty{
ResourceType: jsii.String("resourceType"),
Tags: []*cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
},
},
TargetCapacityUnitType: jsii.String("targetCapacityUnitType"),
TerminateInstancesWithExpiration: jsii.Boolean(false),
Type: jsii.String("type"),
ValidFrom: jsii.String("validFrom"),
ValidUntil: jsii.String("validUntil"),
},
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-spotfleet.html
type CfnSpotFleet_AcceleratorCountRequestProperty ¶
type CfnSpotFleet_AcceleratorCountRequestProperty struct {
// The maximum number of accelerators.
//
// To specify no maximum limit, omit this parameter. To exclude accelerator-enabled instance types, set `Max` to `0` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-acceleratorcountrequest.html#cfn-ec2-spotfleet-acceleratorcountrequest-max
//
Max *float64 `field:"optional" json:"max" yaml:"max"`
// The minimum number of accelerators.
//
// To specify no minimum limit, omit this parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-acceleratorcountrequest.html#cfn-ec2-spotfleet-acceleratorcountrequest-min
//
Min *float64 `field:"optional" json:"min" yaml:"min"`
}
The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) on an instance.
To exclude accelerator-enabled instance types, set `Max` to `0` .
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"
acceleratorCountRequestProperty := &AcceleratorCountRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
}
type CfnSpotFleet_AcceleratorTotalMemoryMiBRequestProperty ¶
type CfnSpotFleet_AcceleratorTotalMemoryMiBRequestProperty struct {
// The maximum amount of accelerator memory, in MiB.
//
// To specify no maximum limit, omit this parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-acceleratortotalmemorymibrequest.html#cfn-ec2-spotfleet-acceleratortotalmemorymibrequest-max
//
Max *float64 `field:"optional" json:"max" yaml:"max"`
// The minimum amount of accelerator memory, in MiB.
//
// To specify no minimum limit, omit this parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-acceleratortotalmemorymibrequest.html#cfn-ec2-spotfleet-acceleratortotalmemorymibrequest-min
//
Min *float64 `field:"optional" json:"min" yaml:"min"`
}
The minimum and maximum amount of total accelerator memory, in MiB.
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"
acceleratorTotalMemoryMiBRequestProperty := &AcceleratorTotalMemoryMiBRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
}
type CfnSpotFleet_BaselineEbsBandwidthMbpsRequestProperty ¶
type CfnSpotFleet_BaselineEbsBandwidthMbpsRequestProperty struct {
// The maximum baseline bandwidth, in Mbps.
//
// To specify no maximum limit, omit this parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-baselineebsbandwidthmbpsrequest.html#cfn-ec2-spotfleet-baselineebsbandwidthmbpsrequest-max
//
Max *float64 `field:"optional" json:"max" yaml:"max"`
// The minimum baseline bandwidth, in Mbps.
//
// To specify no minimum limit, omit this parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-baselineebsbandwidthmbpsrequest.html#cfn-ec2-spotfleet-baselineebsbandwidthmbpsrequest-min
//
Min *float64 `field:"optional" json:"min" yaml:"min"`
}
The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps.
For more information, see [Amazon EBS–optimized instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) in the *Amazon EC2 User 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"
baselineEbsBandwidthMbpsRequestProperty := &BaselineEbsBandwidthMbpsRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
}
type CfnSpotFleet_BlockDeviceMappingProperty ¶
type CfnSpotFleet_BlockDeviceMappingProperty struct {
// The device name (for example, `/dev/sdh` or `xvdh` ).
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-blockdevicemapping.html#cfn-ec2-spotfleet-blockdevicemapping-devicename
//
DeviceName *string `field:"required" json:"deviceName" yaml:"deviceName"`
// Parameters used to automatically set up EBS volumes when the instance is launched.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-blockdevicemapping.html#cfn-ec2-spotfleet-blockdevicemapping-ebs
//
Ebs interface{} `field:"optional" json:"ebs" yaml:"ebs"`
// To omit the device from the block device mapping, specify an empty string.
//
// When this property is specified, the device is removed from the block device mapping regardless of the assigned value.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-blockdevicemapping.html#cfn-ec2-spotfleet-blockdevicemapping-nodevice
//
NoDevice *string `field:"optional" json:"noDevice" yaml:"noDevice"`
// The virtual device name ( `ephemeral` N).
//
// Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for `ephemeral0` and `ephemeral1` . The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.
//
// NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.
//
// Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-blockdevicemapping.html#cfn-ec2-spotfleet-blockdevicemapping-virtualname
//
VirtualName *string `field:"optional" json:"virtualName" yaml:"virtualName"`
}
Specifies a block device mapping.
You can specify `Ebs` or `VirtualName` , but not both.
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"
blockDeviceMappingProperty := &BlockDeviceMappingProperty{
DeviceName: jsii.String("deviceName"),
// the properties below are optional
Ebs: &EbsBlockDeviceProperty{
DeleteOnTermination: jsii.Boolean(false),
Encrypted: jsii.Boolean(false),
Iops: jsii.Number(123),
SnapshotId: jsii.String("snapshotId"),
VolumeSize: jsii.Number(123),
VolumeType: jsii.String("volumeType"),
},
NoDevice: jsii.String("noDevice"),
VirtualName: jsii.String("virtualName"),
}
type CfnSpotFleet_ClassicLoadBalancerProperty ¶
type CfnSpotFleet_ClassicLoadBalancerProperty struct {
// The name of the load balancer.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-classicloadbalancer.html#cfn-ec2-spotfleet-classicloadbalancer-name
//
Name *string `field:"required" json:"name" yaml:"name"`
}
Specifies a Classic 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"
classicLoadBalancerProperty := &ClassicLoadBalancerProperty{
Name: jsii.String("name"),
}
type CfnSpotFleet_ClassicLoadBalancersConfigProperty ¶
type CfnSpotFleet_ClassicLoadBalancersConfigProperty struct {
// One or more Classic Load Balancers.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-classicloadbalancersconfig.html#cfn-ec2-spotfleet-classicloadbalancersconfig-classicloadbalancers
//
ClassicLoadBalancers interface{} `field:"required" json:"classicLoadBalancers" yaml:"classicLoadBalancers"`
}
Specifies the Classic Load Balancers to attach to a Spot Fleet.
Spot Fleet registers the running Spot Instances with these Classic Load Balancers.
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"
classicLoadBalancersConfigProperty := &ClassicLoadBalancersConfigProperty{
ClassicLoadBalancers: []interface{}{
&ClassicLoadBalancerProperty{
Name: jsii.String("name"),
},
},
}
type CfnSpotFleet_EbsBlockDeviceProperty ¶
type CfnSpotFleet_EbsBlockDeviceProperty struct {
// Indicates whether the EBS volume is deleted on instance termination.
//
// For more information, see [Preserving Amazon EBS volumes on instance termination](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/terminating-instances.html#preserving-volumes-on-termination) in the *Amazon EC2 User Guide* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-ebsblockdevice.html#cfn-ec2-spotfleet-ebsblockdevice-deleteontermination
//
DeleteOnTermination interface{} `field:"optional" json:"deleteOnTermination" yaml:"deleteOnTermination"`
// Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot.
//
// The effect of setting the encryption state to `true` depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see [Amazon EBS Encryption](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-parameters) in the *Amazon EC2 User Guide* .
//
// In no case can you remove encryption from an encrypted volume.
//
// Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see [Supported Instance Types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#EBSEncryption_supported_instances) .
//
// This parameter is not returned by [DescribeImageAttribute](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeImageAttribute.html) .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-ebsblockdevice.html#cfn-ec2-spotfleet-ebsblockdevice-encrypted
//
Encrypted interface{} `field:"optional" json:"encrypted" yaml:"encrypted"`
// The number of I/O operations per second (IOPS).
//
// For `gp3` , `io1` , and `io2` volumes, this represents the number of IOPS that are provisioned for the volume. For `gp2` volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
//
// The following are the supported values for each volume type:
//
// - `gp3` : 3,000 - 16,000 IOPS
// - `io1` : 100 - 64,000 IOPS
// - `io2` : 100 - 256,000 IOPS
//
// For `io2` volumes, you can achieve up to 256,000 IOPS on [instances built on the Nitro System](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances) . On other instances, you can achieve performance up to 32,000 IOPS.
//
// This parameter is required for `io1` and `io2` volumes. The default for `gp3` volumes is 3,000 IOPS.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-ebsblockdevice.html#cfn-ec2-spotfleet-ebsblockdevice-iops
//
Iops *float64 `field:"optional" json:"iops" yaml:"iops"`
// The ID of the snapshot.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-ebsblockdevice.html#cfn-ec2-spotfleet-ebsblockdevice-snapshotid
//
SnapshotId *string `field:"optional" json:"snapshotId" yaml:"snapshotId"`
// The size of the volume, in GiBs.
//
// You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.
//
// The following are the supported sizes for each volume type:
//
// - `gp2` and `gp3` : 1 - 16,384 GiB
// - `io1` : 4 - 16,384 GiB
// - `io2` : 4 - 65,536 GiB
// - `st1` and `sc1` : 125 - 16,384 GiB
// - `standard` : 1 - 1024 GiB.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-ebsblockdevice.html#cfn-ec2-spotfleet-ebsblockdevice-volumesize
//
VolumeSize *float64 `field:"optional" json:"volumeSize" yaml:"volumeSize"`
// The volume type.
//
// For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volume-types.html) in the *Amazon EBS User Guide* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-ebsblockdevice.html#cfn-ec2-spotfleet-ebsblockdevice-volumetype
//
VolumeType *string `field:"optional" json:"volumeType" yaml:"volumeType"`
}
Describes a block device for an EBS volume.
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"
ebsBlockDeviceProperty := &EbsBlockDeviceProperty{
DeleteOnTermination: jsii.Boolean(false),
Encrypted: jsii.Boolean(false),
Iops: jsii.Number(123),
SnapshotId: jsii.String("snapshotId"),
VolumeSize: jsii.Number(123),
VolumeType: jsii.String("volumeType"),
}
type CfnSpotFleet_FleetLaunchTemplateSpecificationProperty ¶
type CfnSpotFleet_FleetLaunchTemplateSpecificationProperty struct {
// The version number of the launch template.
//
// Specifying `$Latest` or `$Default` for the template version number is not supported. However, you can specify `LatestVersionNumber` or `DefaultVersionNumber` using the `Fn::GetAtt` intrinsic function. For more information, see [Fn::GetAtt](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#aws-resource-ec2-launchtemplate-return-values-fn--getatt) .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-fleetlaunchtemplatespecification.html#cfn-ec2-spotfleet-fleetlaunchtemplatespecification-version
//
Version *string `field:"required" json:"version" yaml:"version"`
// The ID of the launch template.
//
// You must specify the `LaunchTemplateId` or the `LaunchTemplateName` , but not both.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-fleetlaunchtemplatespecification.html#cfn-ec2-spotfleet-fleetlaunchtemplatespecification-launchtemplateid
//
LaunchTemplateId *string `field:"optional" json:"launchTemplateId" yaml:"launchTemplateId"`
// The name of the launch template.
//
// You must specify the `LaunchTemplateName` or the `LaunchTemplateId` , but not both.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-fleetlaunchtemplatespecification.html#cfn-ec2-spotfleet-fleetlaunchtemplatespecification-launchtemplatename
//
LaunchTemplateName *string `field:"optional" json:"launchTemplateName" yaml:"launchTemplateName"`
}
Specifies the launch template to be used by the Spot Fleet request for configuring Amazon EC2 instances.
You must specify the following:
- The ID or the name of the launch template, but not both. - The version of the launch template.
`FleetLaunchTemplateSpecification` is a property of the [AWS::EC2::SpotFleet](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-spotfleet.html) resource.
For information about creating a launch template, see [AWS::EC2::LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html) and [Create a launch template](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html#create-launch-template) in the *Amazon EC2 User Guide* .
For examples of launch templates, see [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#aws-resource-ec2-launchtemplate--examples) .
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"
fleetLaunchTemplateSpecificationProperty := &FleetLaunchTemplateSpecificationProperty{
Version: jsii.String("version"),
// the properties below are optional
LaunchTemplateId: jsii.String("launchTemplateId"),
LaunchTemplateName: jsii.String("launchTemplateName"),
}
type CfnSpotFleet_GroupIdentifierProperty ¶
type CfnSpotFleet_GroupIdentifierProperty struct {
// The ID of the security group.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-groupidentifier.html#cfn-ec2-spotfleet-groupidentifier-groupid
//
GroupId *string `field:"required" json:"groupId" yaml:"groupId"`
}
Describes a security group.
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"
groupIdentifierProperty := &GroupIdentifierProperty{
GroupId: jsii.String("groupId"),
}
type CfnSpotFleet_IamInstanceProfileSpecificationProperty ¶
type CfnSpotFleet_IamInstanceProfileSpecificationProperty struct {
// The Amazon Resource Name (ARN) of the instance profile.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-iaminstanceprofilespecification.html#cfn-ec2-spotfleet-iaminstanceprofilespecification-arn
//
Arn *string `field:"optional" json:"arn" yaml:"arn"`
}
Describes an IAM instance profile.
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"
iamInstanceProfileSpecificationProperty := &IamInstanceProfileSpecificationProperty{
Arn: jsii.String("arn"),
}
type CfnSpotFleet_InstanceIpv6AddressProperty ¶
type CfnSpotFleet_InstanceIpv6AddressProperty struct {
// The IPv6 address.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instanceipv6address.html#cfn-ec2-spotfleet-instanceipv6address-ipv6address
//
Ipv6Address *string `field:"required" json:"ipv6Address" yaml:"ipv6Address"`
}
Describes an IPv6 address.
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"
instanceIpv6AddressProperty := &InstanceIpv6AddressProperty{
Ipv6Address: jsii.String("ipv6Address"),
}
type CfnSpotFleet_InstanceNetworkInterfaceSpecificationProperty ¶
type CfnSpotFleet_InstanceNetworkInterfaceSpecificationProperty struct {
// Indicates whether to assign a public IPv4 address to an instance you launch in a VPC.
//
// The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is `true` .
//
// AWS charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the *Public IPv4 Address* tab on the [Amazon VPC pricing page](https://docs.aws.amazon.com/vpc/pricing/) .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancenetworkinterfacespecification.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-associatepublicipaddress
//
AssociatePublicIpAddress interface{} `field:"optional" json:"associatePublicIpAddress" yaml:"associatePublicIpAddress"`
// Indicates whether the network interface is deleted when the instance is terminated.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancenetworkinterfacespecification.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-deleteontermination
//
DeleteOnTermination interface{} `field:"optional" json:"deleteOnTermination" yaml:"deleteOnTermination"`
// The description of the network interface.
//
// Applies only if creating a network interface when launching an instance.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancenetworkinterfacespecification.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// The position of the network interface in the attachment order.
//
// A primary network interface has a device index of 0.
//
// If you specify a network interface when launching an instance, you must specify the device index.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancenetworkinterfacespecification.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-deviceindex
//
DeviceIndex *float64 `field:"optional" json:"deviceIndex" yaml:"deviceIndex"`
// The IDs of the security groups for the network interface.
//
// Applies only if creating a network interface when launching an instance.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancenetworkinterfacespecification.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-groups
//
Groups *[]*string `field:"optional" json:"groups" yaml:"groups"`
// A number of IPv6 addresses to assign to the network interface.
//
// Amazon EC2 chooses the IPv6 addresses from the range of the subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancenetworkinterfacespecification.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-ipv6addresscount
//
Ipv6AddressCount *float64 `field:"optional" json:"ipv6AddressCount" yaml:"ipv6AddressCount"`
// The IPv6 addresses to assign to the network interface.
//
// You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancenetworkinterfacespecification.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-ipv6addresses
//
Ipv6Addresses interface{} `field:"optional" json:"ipv6Addresses" yaml:"ipv6Addresses"`
// The ID of the network interface.
//
// If you are creating a Spot Fleet, omit this parameter because you can’t specify a network interface ID in a launch specification.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancenetworkinterfacespecification.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-networkinterfaceid
//
NetworkInterfaceId *string `field:"optional" json:"networkInterfaceId" yaml:"networkInterfaceId"`
// The private IPv4 addresses to assign to the network interface.
//
// Only one private IPv4 address can be designated as primary. You cannot specify this option if you're launching more than one instance in a [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) request.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancenetworkinterfacespecification.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-privateipaddresses
//
PrivateIpAddresses interface{} `field:"optional" json:"privateIpAddresses" yaml:"privateIpAddresses"`
// The number of secondary private IPv4 addresses.
//
// You can't specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you're launching more than one instance in a [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) request.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancenetworkinterfacespecification.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-secondaryprivateipaddresscount
//
SecondaryPrivateIpAddressCount *float64 `field:"optional" json:"secondaryPrivateIpAddressCount" yaml:"secondaryPrivateIpAddressCount"`
// The ID of the subnet associated with the network interface.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancenetworkinterfacespecification.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-subnetid
//
SubnetId *string `field:"optional" json:"subnetId" yaml:"subnetId"`
}
Describes a network interface.
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"
instanceNetworkInterfaceSpecificationProperty := &InstanceNetworkInterfaceSpecificationProperty{
AssociatePublicIpAddress: jsii.Boolean(false),
DeleteOnTermination: jsii.Boolean(false),
Description: jsii.String("description"),
DeviceIndex: jsii.Number(123),
Groups: []*string{
jsii.String("groups"),
},
Ipv6AddressCount: jsii.Number(123),
Ipv6Addresses: []interface{}{
&InstanceIpv6AddressProperty{
Ipv6Address: jsii.String("ipv6Address"),
},
},
NetworkInterfaceId: jsii.String("networkInterfaceId"),
PrivateIpAddresses: []interface{}{
&PrivateIpAddressSpecificationProperty{
PrivateIpAddress: jsii.String("privateIpAddress"),
// the properties below are optional
Primary: jsii.Boolean(false),
},
},
SecondaryPrivateIpAddressCount: jsii.Number(123),
SubnetId: jsii.String("subnetId"),
}
type CfnSpotFleet_InstanceRequirementsRequestProperty ¶
type CfnSpotFleet_InstanceRequirementsRequestProperty struct {
// The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) on an instance.
//
// To exclude accelerator-enabled instance types, set `Max` to `0` .
//
// Default: No minimum or maximum limits.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-acceleratorcount
//
AcceleratorCount interface{} `field:"optional" json:"acceleratorCount" yaml:"acceleratorCount"`
// Indicates whether instance types must have accelerators by specific manufacturers.
//
// - For instance types with AWS devices, specify `amazon-web-services` .
// - For instance types with AMD devices, specify `amd` .
// - For instance types with Habana devices, specify `habana` .
// - For instance types with NVIDIA devices, specify `nvidia` .
// - For instance types with Xilinx devices, specify `xilinx` .
//
// Default: Any manufacturer.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-acceleratormanufacturers
//
AcceleratorManufacturers *[]*string `field:"optional" json:"acceleratorManufacturers" yaml:"acceleratorManufacturers"`
// The accelerators that must be on the instance type.
//
// - For instance types with NVIDIA A10G GPUs, specify `a10g` .
// - For instance types with NVIDIA A100 GPUs, specify `a100` .
// - For instance types with NVIDIA H100 GPUs, specify `h100` .
// - For instance types with AWS Inferentia chips, specify `inferentia` .
// - For instance types with NVIDIA GRID K520 GPUs, specify `k520` .
// - For instance types with NVIDIA K80 GPUs, specify `k80` .
// - For instance types with NVIDIA M60 GPUs, specify `m60` .
// - For instance types with AMD Radeon Pro V520 GPUs, specify `radeon-pro-v520` .
// - For instance types with NVIDIA T4 GPUs, specify `t4` .
// - For instance types with NVIDIA T4G GPUs, specify `t4g` .
// - For instance types with Xilinx VU9P FPGAs, specify `vu9p` .
// - For instance types with NVIDIA V100 GPUs, specify `v100` .
//
// Default: Any accelerator.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-acceleratornames
//
AcceleratorNames *[]*string `field:"optional" json:"acceleratorNames" yaml:"acceleratorNames"`
// The minimum and maximum amount of total accelerator memory, in MiB.
//
// Default: No minimum or maximum limits.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-acceleratortotalmemorymib
//
AcceleratorTotalMemoryMiB interface{} `field:"optional" json:"acceleratorTotalMemoryMiB" yaml:"acceleratorTotalMemoryMiB"`
// The accelerator types that must be on the instance type.
//
// - To include instance types with GPU hardware, specify `gpu` .
// - To include instance types with FPGA hardware, specify `fpga` .
// - To include instance types with inference hardware, specify `inference` .
//
// Default: Any accelerator type.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-acceleratortypes
//
AcceleratorTypes *[]*string `field:"optional" json:"acceleratorTypes" yaml:"acceleratorTypes"`
// The instance types to apply your specified attributes against.
//
// All other instance types are ignored, even if they match your specified attributes.
//
// You can use strings with one or more wild cards, represented by an asterisk ( `*` ), to allow an instance type, size, or generation. The following are examples: `m5.8xlarge` , `c5*.*` , `m5a.*` , `r*` , `*3*` .
//
// For example, if you specify `c5*` ,Amazon EC2 will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specify `m5a.*` , Amazon EC2 will allow all the M5a instance types, but not the M5n instance types.
//
// > If you specify `AllowedInstanceTypes` , you can't specify `ExcludedInstanceTypes` .
//
// Default: All instance types.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-allowedinstancetypes
//
AllowedInstanceTypes *[]*string `field:"optional" json:"allowedInstanceTypes" yaml:"allowedInstanceTypes"`
// Indicates whether bare metal instance types must be included, excluded, or required.
//
// - To include bare metal instance types, specify `included` .
// - To require only bare metal instance types, specify `required` .
// - To exclude bare metal instance types, specify `excluded` .
//
// Default: `excluded`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-baremetal
//
BareMetal *string `field:"optional" json:"bareMetal" yaml:"bareMetal"`
// The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps.
//
// For more information, see [Amazon EBS–optimized instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) in the *Amazon EC2 User Guide* .
//
// Default: No minimum or maximum limits.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-baselineebsbandwidthmbps
//
BaselineEbsBandwidthMbps interface{} `field:"optional" json:"baselineEbsBandwidthMbps" yaml:"baselineEbsBandwidthMbps"`
// Indicates whether burstable performance T instance types are included, excluded, or required.
//
// For more information, see [Burstable performance instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html) .
//
// - To include burstable performance instance types, specify `included` .
// - To require only burstable performance instance types, specify `required` .
// - To exclude burstable performance instance types, specify `excluded` .
//
// Default: `excluded`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-burstableperformance
//
BurstablePerformance *string `field:"optional" json:"burstablePerformance" yaml:"burstablePerformance"`
// The CPU manufacturers to include.
//
// - For instance types with Intel CPUs, specify `intel` .
// - For instance types with AMD CPUs, specify `amd` .
// - For instance types with AWS CPUs, specify `amazon-web-services` .
//
// > Don't confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template.
//
// Default: Any manufacturer.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-cpumanufacturers
//
CpuManufacturers *[]*string `field:"optional" json:"cpuManufacturers" yaml:"cpuManufacturers"`
// The instance types to exclude.
//
// You can use strings with one or more wild cards, represented by an asterisk ( `*` ), to exclude an instance family, type, size, or generation. The following are examples: `m5.8xlarge` , `c5*.*` , `m5a.*` , `r*` , `*3*` .
//
// For example, if you specify `c5*` ,Amazon EC2 will exclude the entire C5 instance family, which includes all C5a and C5n instance types. If you specify `m5a.*` , Amazon EC2 will exclude all the M5a instance types, but not the M5n instance types.
//
// > If you specify `ExcludedInstanceTypes` , you can't specify `AllowedInstanceTypes` .
//
// Default: No excluded instance types.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-excludedinstancetypes
//
ExcludedInstanceTypes *[]*string `field:"optional" json:"excludedInstanceTypes" yaml:"excludedInstanceTypes"`
// Indicates whether current or previous generation instance types are included.
//
// The current generation instance types are recommended for use. Current generation instance types are typically the latest two to three generations in each instance family. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide* .
//
// For current generation instance types, specify `current` .
//
// For previous generation instance types, specify `previous` .
//
// Default: Current and previous generation instance types.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-instancegenerations
//
InstanceGenerations *[]*string `field:"optional" json:"instanceGenerations" yaml:"instanceGenerations"`
// Indicates whether instance types with instance store volumes are included, excluded, or required.
//
// For more information, [Amazon EC2 instance store](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html) in the *Amazon EC2 User Guide* .
//
// - To include instance types with instance store volumes, specify `included` .
// - To require only instance types with instance store volumes, specify `required` .
// - To exclude instance types with instance store volumes, specify `excluded` .
//
// Default: `included`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-localstorage
//
LocalStorage *string `field:"optional" json:"localStorage" yaml:"localStorage"`
// The type of local storage that is required.
//
// - For instance types with hard disk drive (HDD) storage, specify `hdd` .
// - For instance types with solid state drive (SSD) storage, specify `ssd` .
//
// Default: `hdd` and `ssd`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-localstoragetypes
//
LocalStorageTypes *[]*string `field:"optional" json:"localStorageTypes" yaml:"localStorageTypes"`
// [Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price.
//
// The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold.
//
// The parameter accepts an integer, which Amazon EC2 interprets as a percentage.
//
// If you set `TargetCapacityUnitType` to `vcpu` or `memory-mib` , the price protection threshold is based on the per vCPU or per memory price instead of the per instance price.
//
// > Only one of `SpotMaxPricePercentageOverLowestPrice` or `MaxSpotPriceAsPercentageOfOptimalOnDemandPrice` can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as `999999` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-maxspotpriceaspercentageofoptimalondemandprice
//
MaxSpotPriceAsPercentageOfOptimalOnDemandPrice *float64 `field:"optional" json:"maxSpotPriceAsPercentageOfOptimalOnDemandPrice" yaml:"maxSpotPriceAsPercentageOfOptimalOnDemandPrice"`
// The minimum and maximum amount of memory per vCPU, in GiB.
//
// Default: No minimum or maximum limits.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-memorygibpervcpu
//
MemoryGiBPerVCpu interface{} `field:"optional" json:"memoryGiBPerVCpu" yaml:"memoryGiBPerVCpu"`
// The minimum and maximum amount of memory, in MiB.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-memorymib
//
MemoryMiB interface{} `field:"optional" json:"memoryMiB" yaml:"memoryMiB"`
// The minimum and maximum amount of baseline network bandwidth, in gigabits per second (Gbps).
//
// For more information, see [Amazon EC2 instance network bandwidth](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-network-bandwidth.html) in the *Amazon EC2 User Guide* .
//
// Default: No minimum or maximum limits.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-networkbandwidthgbps
//
NetworkBandwidthGbps interface{} `field:"optional" json:"networkBandwidthGbps" yaml:"networkBandwidthGbps"`
// The minimum and maximum number of network interfaces.
//
// Default: No minimum or maximum limits.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-networkinterfacecount
//
NetworkInterfaceCount interface{} `field:"optional" json:"networkInterfaceCount" yaml:"networkInterfaceCount"`
// [Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price.
//
// The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold.
//
// The parameter accepts an integer, which Amazon EC2 interprets as a percentage.
//
// To indicate no price protection threshold, specify a high value, such as `999999` .
//
// This parameter is not supported for [GetSpotPlacementScores](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html) and [GetInstanceTypesFromInstanceRequirements](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceTypesFromInstanceRequirements.html) .
//
// > If you set `TargetCapacityUnitType` to `vcpu` or `memory-mib` , the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.
//
// Default: `20`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-ondemandmaxpricepercentageoverlowestprice
//
OnDemandMaxPricePercentageOverLowestPrice *float64 `field:"optional" json:"onDemandMaxPricePercentageOverLowestPrice" yaml:"onDemandMaxPricePercentageOverLowestPrice"`
// Indicates whether instance types must support hibernation for On-Demand Instances.
//
// This parameter is not supported for [GetSpotPlacementScores](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html) .
//
// Default: `false`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-requirehibernatesupport
//
RequireHibernateSupport interface{} `field:"optional" json:"requireHibernateSupport" yaml:"requireHibernateSupport"`
// [Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price.
//
// The identified Spot price is the Spot price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified Spot price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose Spot price exceeds your specified threshold.
//
// The parameter accepts an integer, which Amazon EC2 interprets as a percentage.
//
// If you set `TargetCapacityUnitType` to `vcpu` or `memory-mib` , the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.
//
// This parameter is not supported for [GetSpotPlacementScores](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html) and [GetInstanceTypesFromInstanceRequirements](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceTypesFromInstanceRequirements.html) .
//
// > Only one of `SpotMaxPricePercentageOverLowestPrice` or `MaxSpotPriceAsPercentageOfOptimalOnDemandPrice` can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as `999999` .
//
// Default: `100`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-spotmaxpricepercentageoverlowestprice
//
SpotMaxPricePercentageOverLowestPrice *float64 `field:"optional" json:"spotMaxPricePercentageOverLowestPrice" yaml:"spotMaxPricePercentageOverLowestPrice"`
// The minimum and maximum amount of total local storage, in GB.
//
// Default: No minimum or maximum limits.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-totallocalstoragegb
//
TotalLocalStorageGb interface{} `field:"optional" json:"totalLocalStorageGb" yaml:"totalLocalStorageGb"`
// The minimum and maximum number of vCPUs.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html#cfn-ec2-spotfleet-instancerequirementsrequest-vcpucount
//
VCpuCount interface{} `field:"optional" json:"vCpuCount" yaml:"vCpuCount"`
}
The attributes for the instance types.
When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.
You must specify `VCpuCount` and `MemoryMiB` . All other attributes are optional. Any unspecified optional attribute is set to its default.
When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values.
To limit the list of instance types from which Amazon EC2 can identify matching instance types, you can use one of the following parameters, but not both in the same request:
- `AllowedInstanceTypes` - The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes. - `ExcludedInstanceTypes` - The instance types to exclude from the list, even if they match your specified attributes.
> If you specify `InstanceRequirements` , you can't specify `InstanceType` . > > Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the [launch instance wizard](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-instance-wizard.html) , or with the [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) API or [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) AWS CloudFormation resource, you can't specify `InstanceRequirements` .
For more information, see [Attribute-based instance type selection for EC2 Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html) , [Attribute-based instance type selection for Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-attribute-based-instance-type-selection.html) , and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User 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"
instanceRequirementsRequestProperty := &InstanceRequirementsRequestProperty{
AcceleratorCount: &AcceleratorCountRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
AcceleratorManufacturers: []*string{
jsii.String("acceleratorManufacturers"),
},
AcceleratorNames: []*string{
jsii.String("acceleratorNames"),
},
AcceleratorTotalMemoryMiB: &AcceleratorTotalMemoryMiBRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
AcceleratorTypes: []*string{
jsii.String("acceleratorTypes"),
},
AllowedInstanceTypes: []*string{
jsii.String("allowedInstanceTypes"),
},
BareMetal: jsii.String("bareMetal"),
BaselineEbsBandwidthMbps: &BaselineEbsBandwidthMbpsRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
BurstablePerformance: jsii.String("burstablePerformance"),
CpuManufacturers: []*string{
jsii.String("cpuManufacturers"),
},
ExcludedInstanceTypes: []*string{
jsii.String("excludedInstanceTypes"),
},
InstanceGenerations: []*string{
jsii.String("instanceGenerations"),
},
LocalStorage: jsii.String("localStorage"),
LocalStorageTypes: []*string{
jsii.String("localStorageTypes"),
},
MaxSpotPriceAsPercentageOfOptimalOnDemandPrice: jsii.Number(123),
MemoryGiBPerVCpu: &MemoryGiBPerVCpuRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
MemoryMiB: &MemoryMiBRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
NetworkBandwidthGbps: &NetworkBandwidthGbpsRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
NetworkInterfaceCount: &NetworkInterfaceCountRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
OnDemandMaxPricePercentageOverLowestPrice: jsii.Number(123),
RequireHibernateSupport: jsii.Boolean(false),
SpotMaxPricePercentageOverLowestPrice: jsii.Number(123),
TotalLocalStorageGb: &TotalLocalStorageGBRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
VCpuCount: &VCpuCountRangeRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
}
type CfnSpotFleet_LaunchTemplateConfigProperty ¶
type CfnSpotFleet_LaunchTemplateConfigProperty struct {
// The launch template to use.
//
// Make sure that the launch template does not contain the `NetworkInterfaceId` parameter because you can't specify a network interface ID in a Spot Fleet.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-launchtemplateconfig.html#cfn-ec2-spotfleet-launchtemplateconfig-launchtemplatespecification
//
LaunchTemplateSpecification interface{} `field:"optional" json:"launchTemplateSpecification" yaml:"launchTemplateSpecification"`
// Any parameters that you specify override the same parameters in the launch template.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-launchtemplateconfig.html#cfn-ec2-spotfleet-launchtemplateconfig-overrides
//
Overrides interface{} `field:"optional" json:"overrides" yaml:"overrides"`
}
Specifies a launch template and overrides.
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"
launchTemplateConfigProperty := &LaunchTemplateConfigProperty{
LaunchTemplateSpecification: &FleetLaunchTemplateSpecificationProperty{
Version: jsii.String("version"),
// the properties below are optional
LaunchTemplateId: jsii.String("launchTemplateId"),
LaunchTemplateName: jsii.String("launchTemplateName"),
},
Overrides: []interface{}{
&LaunchTemplateOverridesProperty{
AvailabilityZone: jsii.String("availabilityZone"),
InstanceRequirements: &InstanceRequirementsRequestProperty{
AcceleratorCount: &AcceleratorCountRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
AcceleratorManufacturers: []*string{
jsii.String("acceleratorManufacturers"),
},
AcceleratorNames: []*string{
jsii.String("acceleratorNames"),
},
AcceleratorTotalMemoryMiB: &AcceleratorTotalMemoryMiBRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
AcceleratorTypes: []*string{
jsii.String("acceleratorTypes"),
},
AllowedInstanceTypes: []*string{
jsii.String("allowedInstanceTypes"),
},
BareMetal: jsii.String("bareMetal"),
BaselineEbsBandwidthMbps: &BaselineEbsBandwidthMbpsRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
BurstablePerformance: jsii.String("burstablePerformance"),
CpuManufacturers: []*string{
jsii.String("cpuManufacturers"),
},
ExcludedInstanceTypes: []*string{
jsii.String("excludedInstanceTypes"),
},
InstanceGenerations: []*string{
jsii.String("instanceGenerations"),
},
LocalStorage: jsii.String("localStorage"),
LocalStorageTypes: []*string{
jsii.String("localStorageTypes"),
},
MaxSpotPriceAsPercentageOfOptimalOnDemandPrice: jsii.Number(123),
MemoryGiBPerVCpu: &MemoryGiBPerVCpuRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
MemoryMiB: &MemoryMiBRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
NetworkBandwidthGbps: &NetworkBandwidthGbpsRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
NetworkInterfaceCount: &NetworkInterfaceCountRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
OnDemandMaxPricePercentageOverLowestPrice: jsii.Number(123),
RequireHibernateSupport: jsii.Boolean(false),
SpotMaxPricePercentageOverLowestPrice: jsii.Number(123),
TotalLocalStorageGb: &TotalLocalStorageGBRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
VCpuCount: &VCpuCountRangeRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
},
InstanceType: jsii.String("instanceType"),
Priority: jsii.Number(123),
SpotPrice: jsii.String("spotPrice"),
SubnetId: jsii.String("subnetId"),
WeightedCapacity: jsii.Number(123),
},
},
}
type CfnSpotFleet_LaunchTemplateOverridesProperty ¶
type CfnSpotFleet_LaunchTemplateOverridesProperty struct {
// The Availability Zone in which to launch the instances.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-launchtemplateoverrides.html#cfn-ec2-spotfleet-launchtemplateoverrides-availabilityzone
//
AvailabilityZone *string `field:"optional" json:"availabilityZone" yaml:"availabilityZone"`
// The instance requirements.
//
// When you specify instance requirements, Amazon EC2 will identify instance types with the provided requirements, and then use your On-Demand and Spot allocation strategies to launch instances from these instance types, in the same way as when you specify a list of instance types.
//
// > If you specify `InstanceRequirements` , you can't specify `InstanceType` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-launchtemplateoverrides.html#cfn-ec2-spotfleet-launchtemplateoverrides-instancerequirements
//
InstanceRequirements interface{} `field:"optional" json:"instanceRequirements" yaml:"instanceRequirements"`
// The instance type.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-launchtemplateoverrides.html#cfn-ec2-spotfleet-launchtemplateoverrides-instancetype
//
InstanceType *string `field:"optional" json:"instanceType" yaml:"instanceType"`
// The priority for the launch template override. The highest priority is launched first.
//
// If `OnDemandAllocationStrategy` is set to `prioritized` , Spot Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity.
//
// If the Spot `AllocationStrategy` is set to `capacityOptimizedPrioritized` , Spot Fleet uses priority on a best-effort basis to determine which launch template override to use in fulfilling Spot capacity, but optimizes for capacity first.
//
// Valid values are whole numbers starting at `0` . The lower the number, the higher the priority. If no number is set, the launch template override has the lowest priority. You can set the same priority for different launch template overrides.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-launchtemplateoverrides.html#cfn-ec2-spotfleet-launchtemplateoverrides-priority
//
Priority *float64 `field:"optional" json:"priority" yaml:"priority"`
// The maximum price per unit hour that you are willing to pay for a Spot Instance.
//
// We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
//
// > If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-launchtemplateoverrides.html#cfn-ec2-spotfleet-launchtemplateoverrides-spotprice
//
SpotPrice *string `field:"optional" json:"spotPrice" yaml:"spotPrice"`
// The ID of the subnet in which to launch the instances.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-launchtemplateoverrides.html#cfn-ec2-spotfleet-launchtemplateoverrides-subnetid
//
SubnetId *string `field:"optional" json:"subnetId" yaml:"subnetId"`
// The number of units provided by the specified instance type.
//
// These are the same units that you chose to set the target capacity in terms of instances, or a performance characteristic such as vCPUs, memory, or I/O.
//
// If the target capacity divided by this value is not a whole number, Amazon EC2 rounds the number of instances to the next whole number. If this value is not specified, the default is 1.
//
// > When specifying weights, the price used in the `lowestPrice` and `priceCapacityOptimized` allocation strategies is per *unit* hour (where the instance price is divided by the specified weight). However, if all the specified weights are above the requested `TargetCapacity` , resulting in only 1 instance being launched, the price used is per *instance* hour.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-launchtemplateoverrides.html#cfn-ec2-spotfleet-launchtemplateoverrides-weightedcapacity
//
WeightedCapacity *float64 `field:"optional" json:"weightedCapacity" yaml:"weightedCapacity"`
}
Specifies overrides for a launch template.
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"
launchTemplateOverridesProperty := &LaunchTemplateOverridesProperty{
AvailabilityZone: jsii.String("availabilityZone"),
InstanceRequirements: &InstanceRequirementsRequestProperty{
AcceleratorCount: &AcceleratorCountRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
AcceleratorManufacturers: []*string{
jsii.String("acceleratorManufacturers"),
},
AcceleratorNames: []*string{
jsii.String("acceleratorNames"),
},
AcceleratorTotalMemoryMiB: &AcceleratorTotalMemoryMiBRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
AcceleratorTypes: []*string{
jsii.String("acceleratorTypes"),
},
AllowedInstanceTypes: []*string{
jsii.String("allowedInstanceTypes"),
},
BareMetal: jsii.String("bareMetal"),
BaselineEbsBandwidthMbps: &BaselineEbsBandwidthMbpsRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
BurstablePerformance: jsii.String("burstablePerformance"),
CpuManufacturers: []*string{
jsii.String("cpuManufacturers"),
},
ExcludedInstanceTypes: []*string{
jsii.String("excludedInstanceTypes"),
},
InstanceGenerations: []*string{
jsii.String("instanceGenerations"),
},
LocalStorage: jsii.String("localStorage"),
LocalStorageTypes: []*string{
jsii.String("localStorageTypes"),
},
MaxSpotPriceAsPercentageOfOptimalOnDemandPrice: jsii.Number(123),
MemoryGiBPerVCpu: &MemoryGiBPerVCpuRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
MemoryMiB: &MemoryMiBRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
NetworkBandwidthGbps: &NetworkBandwidthGbpsRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
NetworkInterfaceCount: &NetworkInterfaceCountRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
OnDemandMaxPricePercentageOverLowestPrice: jsii.Number(123),
RequireHibernateSupport: jsii.Boolean(false),
SpotMaxPricePercentageOverLowestPrice: jsii.Number(123),
TotalLocalStorageGb: &TotalLocalStorageGBRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
VCpuCount: &VCpuCountRangeRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
},
InstanceType: jsii.String("instanceType"),
Priority: jsii.Number(123),
SpotPrice: jsii.String("spotPrice"),
SubnetId: jsii.String("subnetId"),
WeightedCapacity: jsii.Number(123),
}
type CfnSpotFleet_LoadBalancersConfigProperty ¶
type CfnSpotFleet_LoadBalancersConfigProperty struct {
// The Classic Load Balancers.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-loadbalancersconfig.html#cfn-ec2-spotfleet-loadbalancersconfig-classicloadbalancersconfig
//
ClassicLoadBalancersConfig interface{} `field:"optional" json:"classicLoadBalancersConfig" yaml:"classicLoadBalancersConfig"`
// The target groups.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-loadbalancersconfig.html#cfn-ec2-spotfleet-loadbalancersconfig-targetgroupsconfig
//
TargetGroupsConfig interface{} `field:"optional" json:"targetGroupsConfig" yaml:"targetGroupsConfig"`
}
Specifies the Classic Load Balancers and target groups to attach to a Spot Fleet request.
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"
loadBalancersConfigProperty := &LoadBalancersConfigProperty{
ClassicLoadBalancersConfig: &ClassicLoadBalancersConfigProperty{
ClassicLoadBalancers: []interface{}{
&ClassicLoadBalancerProperty{
Name: jsii.String("name"),
},
},
},
TargetGroupsConfig: &TargetGroupsConfigProperty{
TargetGroups: []interface{}{
&TargetGroupProperty{
Arn: jsii.String("arn"),
},
},
},
}
type CfnSpotFleet_MemoryGiBPerVCpuRequestProperty ¶
type CfnSpotFleet_MemoryGiBPerVCpuRequestProperty struct {
// The maximum amount of memory per vCPU, in GiB.
//
// To specify no maximum limit, omit this parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-memorygibpervcpurequest.html#cfn-ec2-spotfleet-memorygibpervcpurequest-max
//
Max *float64 `field:"optional" json:"max" yaml:"max"`
// The minimum amount of memory per vCPU, in GiB.
//
// To specify no minimum limit, omit this parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-memorygibpervcpurequest.html#cfn-ec2-spotfleet-memorygibpervcpurequest-min
//
Min *float64 `field:"optional" json:"min" yaml:"min"`
}
The minimum and maximum amount of memory per vCPU, in GiB.
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"
memoryGiBPerVCpuRequestProperty := &MemoryGiBPerVCpuRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
}
type CfnSpotFleet_MemoryMiBRequestProperty ¶
type CfnSpotFleet_MemoryMiBRequestProperty struct {
// The maximum amount of memory, in MiB.
//
// To specify no maximum limit, omit this parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-memorymibrequest.html#cfn-ec2-spotfleet-memorymibrequest-max
//
Max *float64 `field:"optional" json:"max" yaml:"max"`
// The minimum amount of memory, in MiB.
//
// To specify no minimum limit, specify `0` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-memorymibrequest.html#cfn-ec2-spotfleet-memorymibrequest-min
//
Min *float64 `field:"optional" json:"min" yaml:"min"`
}
The minimum and maximum amount of memory, in MiB.
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"
memoryMiBRequestProperty := &MemoryMiBRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
}
type CfnSpotFleet_NetworkBandwidthGbpsRequestProperty ¶ added in v2.51.0
type CfnSpotFleet_NetworkBandwidthGbpsRequestProperty struct {
// The maximum amount of network bandwidth, in Gbps.
//
// To specify no maximum limit, omit this parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-networkbandwidthgbpsrequest.html#cfn-ec2-spotfleet-networkbandwidthgbpsrequest-max
//
Max *float64 `field:"optional" json:"max" yaml:"max"`
// The minimum amount of network bandwidth, in Gbps.
//
// To specify no minimum limit, omit this parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-networkbandwidthgbpsrequest.html#cfn-ec2-spotfleet-networkbandwidthgbpsrequest-min
//
Min *float64 `field:"optional" json:"min" yaml:"min"`
}
The minimum and maximum amount of baseline network bandwidth, in gigabits per second (Gbps).
For more information, see [Amazon EC2 instance network bandwidth](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-network-bandwidth.html) in the *Amazon EC2 User Guide* .
Default: No minimum or maximum limits.
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"
networkBandwidthGbpsRequestProperty := &NetworkBandwidthGbpsRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
}
type CfnSpotFleet_NetworkInterfaceCountRequestProperty ¶
type CfnSpotFleet_NetworkInterfaceCountRequestProperty struct {
// The maximum number of network interfaces.
//
// To specify no maximum limit, omit this parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-networkinterfacecountrequest.html#cfn-ec2-spotfleet-networkinterfacecountrequest-max
//
Max *float64 `field:"optional" json:"max" yaml:"max"`
// The minimum number of network interfaces.
//
// To specify no minimum limit, omit this parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-networkinterfacecountrequest.html#cfn-ec2-spotfleet-networkinterfacecountrequest-min
//
Min *float64 `field:"optional" json:"min" yaml:"min"`
}
The minimum and maximum number of network interfaces.
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"
networkInterfaceCountRequestProperty := &NetworkInterfaceCountRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
}
type CfnSpotFleet_PrivateIpAddressSpecificationProperty ¶
type CfnSpotFleet_PrivateIpAddressSpecificationProperty struct {
// The private IPv4 address.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-privateipaddressspecification.html#cfn-ec2-spotfleet-privateipaddressspecification-privateipaddress
//
PrivateIpAddress *string `field:"required" json:"privateIpAddress" yaml:"privateIpAddress"`
// Indicates whether the private IPv4 address is the primary private IPv4 address.
//
// Only one IPv4 address can be designated as primary.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-privateipaddressspecification.html#cfn-ec2-spotfleet-privateipaddressspecification-primary
//
Primary interface{} `field:"optional" json:"primary" yaml:"primary"`
}
Describes a secondary private IPv4 address for a network interface.
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"
privateIpAddressSpecificationProperty := &PrivateIpAddressSpecificationProperty{
PrivateIpAddress: jsii.String("privateIpAddress"),
// the properties below are optional
Primary: jsii.Boolean(false),
}
type CfnSpotFleet_SpotCapacityRebalanceProperty ¶
type CfnSpotFleet_SpotCapacityRebalanceProperty struct {
// The replacement strategy to use. Only available for fleets of type `maintain` .
//
// `launch` - Spot Fleet launches a new replacement Spot Instance when a rebalance notification is emitted for an existing Spot Instance in the fleet. Spot Fleet does not terminate the instances that receive a rebalance notification. You can terminate the old instances, or you can leave them running. You are charged for all instances while they are running.
//
// `launch-before-terminate` - Spot Fleet launches a new replacement Spot Instance when a rebalance notification is emitted for an existing Spot Instance in the fleet, and then, after a delay that you specify (in `TerminationDelay` ), terminates the instances that received a rebalance notification.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotcapacityrebalance.html#cfn-ec2-spotfleet-spotcapacityrebalance-replacementstrategy
//
ReplacementStrategy *string `field:"optional" json:"replacementStrategy" yaml:"replacementStrategy"`
// The amount of time (in seconds) that Amazon EC2 waits before terminating the old Spot Instance after launching a new replacement Spot Instance.
//
// Required when `ReplacementStrategy` is set to `launch-before-terminate` .
//
// Not valid when `ReplacementStrategy` is set to `launch` .
//
// Valid values: Minimum value of `120` seconds. Maximum value of `7200` seconds.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotcapacityrebalance.html#cfn-ec2-spotfleet-spotcapacityrebalance-terminationdelay
//
TerminationDelay *float64 `field:"optional" json:"terminationDelay" yaml:"terminationDelay"`
}
The Spot Instance replacement strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an elevated risk of being interrupted.
For more information, see [Capacity rebalancing](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-capacity-rebalance.html) in the *Amazon EC2 User 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"
spotCapacityRebalanceProperty := &SpotCapacityRebalanceProperty{
ReplacementStrategy: jsii.String("replacementStrategy"),
TerminationDelay: jsii.Number(123),
}
type CfnSpotFleet_SpotFleetLaunchSpecificationProperty ¶
type CfnSpotFleet_SpotFleetLaunchSpecificationProperty struct {
// The ID of the AMI.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetlaunchspecification.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-imageid
//
ImageId *string `field:"required" json:"imageId" yaml:"imageId"`
// One or more block devices that are mapped to the Spot Instances.
//
// You can't specify both a snapshot ID and an encryption value. This is because only blank volumes can be encrypted on creation. If a snapshot is the basis for a volume, it is not blank and its encryption status is used for the volume encryption status.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetlaunchspecification.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-blockdevicemappings
//
BlockDeviceMappings interface{} `field:"optional" json:"blockDeviceMappings" yaml:"blockDeviceMappings"`
// Indicates whether the instances are optimized for EBS I/O.
//
// This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
//
// Default: `false`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetlaunchspecification.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-ebsoptimized
//
// Default: - false.
//
EbsOptimized interface{} `field:"optional" json:"ebsOptimized" yaml:"ebsOptimized"`
// The IAM instance profile.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetlaunchspecification.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-iaminstanceprofile
//
IamInstanceProfile interface{} `field:"optional" json:"iamInstanceProfile" yaml:"iamInstanceProfile"`
// The attributes for the instance types.
//
// When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.
//
// > If you specify `InstanceRequirements` , you can't specify `InstanceType` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetlaunchspecification.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-instancerequirements
//
InstanceRequirements interface{} `field:"optional" json:"instanceRequirements" yaml:"instanceRequirements"`
// The instance type.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetlaunchspecification.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-instancetype
//
InstanceType *string `field:"optional" json:"instanceType" yaml:"instanceType"`
// The ID of the kernel.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetlaunchspecification.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-kernelid
//
KernelId *string `field:"optional" json:"kernelId" yaml:"kernelId"`
// The name of the key pair.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetlaunchspecification.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-keyname
//
KeyName *string `field:"optional" json:"keyName" yaml:"keyName"`
// Enable or disable monitoring for the instances.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetlaunchspecification.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-monitoring
//
Monitoring interface{} `field:"optional" json:"monitoring" yaml:"monitoring"`
// The network interfaces.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetlaunchspecification.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-networkinterfaces
//
NetworkInterfaces interface{} `field:"optional" json:"networkInterfaces" yaml:"networkInterfaces"`
// The placement information.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetlaunchspecification.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-placement
//
Placement interface{} `field:"optional" json:"placement" yaml:"placement"`
// The ID of the RAM disk.
//
// Some kernels require additional drivers at launch. Check the kernel requirements for information about whether you need to specify a RAM disk. To find kernel requirements, refer to the AWS Resource Center and search for the kernel ID.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetlaunchspecification.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-ramdiskid
//
RamdiskId *string `field:"optional" json:"ramdiskId" yaml:"ramdiskId"`
// The security groups.
//
// If you specify a network interface, you must specify any security groups as part of the network interface instead of using this parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetlaunchspecification.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-securitygroups
//
SecurityGroups interface{} `field:"optional" json:"securityGroups" yaml:"securityGroups"`
// The maximum price per unit hour that you are willing to pay for a Spot Instance.
//
// We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
//
// > If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetlaunchspecification.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-spotprice
//
SpotPrice *string `field:"optional" json:"spotPrice" yaml:"spotPrice"`
// The IDs of the subnets in which to launch the instances.
//
// To specify multiple subnets, separate them using commas; for example, "subnet-1234abcdeexample1, subnet-0987cdef6example2".
//
// If you specify a network interface, you must specify any subnets as part of the network interface instead of using this parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetlaunchspecification.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-subnetid
//
SubnetId *string `field:"optional" json:"subnetId" yaml:"subnetId"`
// The tags to apply during creation.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetlaunchspecification.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-tagspecifications
//
TagSpecifications interface{} `field:"optional" json:"tagSpecifications" yaml:"tagSpecifications"`
// The base64-encoded user data that instances use when starting up.
//
// User data is limited to 16 KB.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetlaunchspecification.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-userdata
//
UserData *string `field:"optional" json:"userData" yaml:"userData"`
// The number of units provided by the specified instance type.
//
// These are the same units that you chose to set the target capacity in terms of instances, or a performance characteristic such as vCPUs, memory, or I/O.
//
// If the target capacity divided by this value is not a whole number, Amazon EC2 rounds the number of instances to the next whole number. If this value is not specified, the default is 1.
//
// > When specifying weights, the price used in the `lowestPrice` and `priceCapacityOptimized` allocation strategies is per *unit* hour (where the instance price is divided by the specified weight). However, if all the specified weights are above the requested `TargetCapacity` , resulting in only 1 instance being launched, the price used is per *instance* hour.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetlaunchspecification.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-weightedcapacity
//
WeightedCapacity *float64 `field:"optional" json:"weightedCapacity" yaml:"weightedCapacity"`
}
Specifies the launch specification for one or more Spot Instances.
If you include On-Demand capacity in your fleet request, you can't use `SpotFleetLaunchSpecification` ; you must use [LaunchTemplateConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-launchtemplateconfig.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"
spotFleetLaunchSpecificationProperty := &SpotFleetLaunchSpecificationProperty{
ImageId: jsii.String("imageId"),
// the properties below are optional
BlockDeviceMappings: []interface{}{
&BlockDeviceMappingProperty{
DeviceName: jsii.String("deviceName"),
// the properties below are optional
Ebs: &EbsBlockDeviceProperty{
DeleteOnTermination: jsii.Boolean(false),
Encrypted: jsii.Boolean(false),
Iops: jsii.Number(123),
SnapshotId: jsii.String("snapshotId"),
VolumeSize: jsii.Number(123),
VolumeType: jsii.String("volumeType"),
},
NoDevice: jsii.String("noDevice"),
VirtualName: jsii.String("virtualName"),
},
},
EbsOptimized: jsii.Boolean(false),
IamInstanceProfile: &IamInstanceProfileSpecificationProperty{
Arn: jsii.String("arn"),
},
InstanceRequirements: &InstanceRequirementsRequestProperty{
AcceleratorCount: &AcceleratorCountRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
AcceleratorManufacturers: []*string{
jsii.String("acceleratorManufacturers"),
},
AcceleratorNames: []*string{
jsii.String("acceleratorNames"),
},
AcceleratorTotalMemoryMiB: &AcceleratorTotalMemoryMiBRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
AcceleratorTypes: []*string{
jsii.String("acceleratorTypes"),
},
AllowedInstanceTypes: []*string{
jsii.String("allowedInstanceTypes"),
},
BareMetal: jsii.String("bareMetal"),
BaselineEbsBandwidthMbps: &BaselineEbsBandwidthMbpsRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
BurstablePerformance: jsii.String("burstablePerformance"),
CpuManufacturers: []*string{
jsii.String("cpuManufacturers"),
},
ExcludedInstanceTypes: []*string{
jsii.String("excludedInstanceTypes"),
},
InstanceGenerations: []*string{
jsii.String("instanceGenerations"),
},
LocalStorage: jsii.String("localStorage"),
LocalStorageTypes: []*string{
jsii.String("localStorageTypes"),
},
MaxSpotPriceAsPercentageOfOptimalOnDemandPrice: jsii.Number(123),
MemoryGiBPerVCpu: &MemoryGiBPerVCpuRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
MemoryMiB: &MemoryMiBRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
NetworkBandwidthGbps: &NetworkBandwidthGbpsRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
NetworkInterfaceCount: &NetworkInterfaceCountRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
OnDemandMaxPricePercentageOverLowestPrice: jsii.Number(123),
RequireHibernateSupport: jsii.Boolean(false),
SpotMaxPricePercentageOverLowestPrice: jsii.Number(123),
TotalLocalStorageGb: &TotalLocalStorageGBRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
VCpuCount: &VCpuCountRangeRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
},
InstanceType: jsii.String("instanceType"),
KernelId: jsii.String("kernelId"),
KeyName: jsii.String("keyName"),
Monitoring: &SpotFleetMonitoringProperty{
Enabled: jsii.Boolean(false),
},
NetworkInterfaces: []interface{}{
&InstanceNetworkInterfaceSpecificationProperty{
AssociatePublicIpAddress: jsii.Boolean(false),
DeleteOnTermination: jsii.Boolean(false),
Description: jsii.String("description"),
DeviceIndex: jsii.Number(123),
Groups: []*string{
jsii.String("groups"),
},
Ipv6AddressCount: jsii.Number(123),
Ipv6Addresses: []interface{}{
&InstanceIpv6AddressProperty{
Ipv6Address: jsii.String("ipv6Address"),
},
},
NetworkInterfaceId: jsii.String("networkInterfaceId"),
PrivateIpAddresses: []interface{}{
&PrivateIpAddressSpecificationProperty{
PrivateIpAddress: jsii.String("privateIpAddress"),
// the properties below are optional
Primary: jsii.Boolean(false),
},
},
SecondaryPrivateIpAddressCount: jsii.Number(123),
SubnetId: jsii.String("subnetId"),
},
},
Placement: &SpotPlacementProperty{
AvailabilityZone: jsii.String("availabilityZone"),
GroupName: jsii.String("groupName"),
Tenancy: jsii.String("tenancy"),
},
RamdiskId: jsii.String("ramdiskId"),
SecurityGroups: []interface{}{
&GroupIdentifierProperty{
GroupId: jsii.String("groupId"),
},
},
SpotPrice: jsii.String("spotPrice"),
SubnetId: jsii.String("subnetId"),
TagSpecifications: []interface{}{
&SpotFleetTagSpecificationProperty{
ResourceType: jsii.String("resourceType"),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
},
},
UserData: jsii.String("userData"),
WeightedCapacity: jsii.Number(123),
}
type CfnSpotFleet_SpotFleetMonitoringProperty ¶
type CfnSpotFleet_SpotFleetMonitoringProperty struct {
// Enables monitoring for the instance.
//
// Default: `false`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetmonitoring.html#cfn-ec2-spotfleet-spotfleetmonitoring-enabled
//
// Default: - false.
//
Enabled interface{} `field:"optional" json:"enabled" yaml:"enabled"`
}
Describes whether monitoring is enabled.
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"
spotFleetMonitoringProperty := &SpotFleetMonitoringProperty{
Enabled: jsii.Boolean(false),
}
type CfnSpotFleet_SpotFleetRequestConfigDataProperty ¶
type CfnSpotFleet_SpotFleetRequestConfigDataProperty struct {
// The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that grants the Spot Fleet the permission to request, launch, terminate, and tag instances on your behalf.
//
// For more information, see [Spot Fleet Prerequisites](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-requests.html#spot-fleet-prerequisites) in the *Amazon EC2 User Guide* . Spot Fleet can terminate Spot Instances on your behalf when you cancel its Spot Fleet request or when the Spot Fleet request expires, if you set `TerminateInstancesWithExpiration` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-iamfleetrole
//
IamFleetRole *string `field:"required" json:"iamFleetRole" yaml:"iamFleetRole"`
// The number of units to request for the Spot Fleet.
//
// You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is `maintain` , you can specify a target capacity of 0 and add capacity later.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-targetcapacity
//
TargetCapacity *float64 `field:"required" json:"targetCapacity" yaml:"targetCapacity"`
// The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the Spot Fleet launch configuration.
//
// For more information, see [Allocation strategies for Spot Instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-allocation-strategy.html) in the *Amazon EC2 User Guide* .
//
// - **priceCapacityOptimized (recommended)** - Spot Fleet identifies the pools with the highest capacity availability for the number of instances that are launching. This means that we will request Spot Instances from the pools that we believe have the lowest chance of interruption in the near term. Spot Fleet then requests Spot Instances from the lowest priced of these pools.
// - **capacityOptimized** - Spot Fleet identifies the pools with the highest capacity availability for the number of instances that are launching. This means that we will request Spot Instances from the pools that we believe have the lowest chance of interruption in the near term. To give certain instance types a higher chance of launching first, use `capacityOptimizedPrioritized` . Set a priority for each instance type by using the `Priority` parameter for `LaunchTemplateOverrides` . You can assign the same priority to different `LaunchTemplateOverrides` . EC2 implements the priorities on a best-effort basis, but optimizes for capacity first. `capacityOptimizedPrioritized` is supported only if your Spot Fleet uses a launch template. Note that if the `OnDemandAllocationStrategy` is set to `prioritized` , the same priority is applied when fulfilling On-Demand capacity.
// - **diversified** - Spot Fleet requests instances from all of the Spot Instance pools that you specify.
// - **lowestPrice (not recommended)** - > We don't recommend the `lowestPrice` allocation strategy because it has the highest risk of interruption for your Spot Instances.
//
// Spot Fleet requests instances from the lowest priced Spot Instance pool that has available capacity. If the lowest priced pool doesn't have available capacity, the Spot Instances come from the next lowest priced pool that has available capacity. If a pool runs out of capacity before fulfilling your desired capacity, Spot Fleet will continue to fulfill your request by drawing from the next lowest priced pool. To ensure that your desired capacity is met, you might receive Spot Instances from several pools. Because this strategy only considers instance price and not capacity availability, it might lead to high interruption rates.
//
// Default: `lowestPrice`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-allocationstrategy
//
AllocationStrategy *string `field:"optional" json:"allocationStrategy" yaml:"allocationStrategy"`
// Reserved.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-context
//
Context *string `field:"optional" json:"context" yaml:"context"`
// Indicates whether running Spot Instances should be terminated if you decrease the target capacity of the Spot Fleet request below the current size of the Spot Fleet.
//
// Supported only for fleets of type `maintain` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-excesscapacityterminationpolicy
//
ExcessCapacityTerminationPolicy *string `field:"optional" json:"excessCapacityTerminationPolicy" yaml:"excessCapacityTerminationPolicy"`
// The behavior when a Spot Instance is interrupted.
//
// The default is `terminate` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-instanceinterruptionbehavior
//
InstanceInterruptionBehavior *string `field:"optional" json:"instanceInterruptionBehavior" yaml:"instanceInterruptionBehavior"`
// The number of Spot pools across which to allocate your target Spot capacity.
//
// Valid only when Spot *AllocationStrategy* is set to `lowest-price` . Spot Fleet selects the cheapest Spot pools and evenly allocates your target Spot capacity across the number of Spot pools that you specify.
//
// Note that Spot Fleet attempts to draw Spot Instances from the number of pools that you specify on a best effort basis. If a pool runs out of Spot capacity before fulfilling your target capacity, Spot Fleet will continue to fulfill your request by drawing from the next cheapest pool. To ensure that your target capacity is met, you might receive Spot Instances from more than the number of pools that you specified. Similarly, if most of the pools have no Spot capacity, you might receive your full target capacity from fewer than the number of pools that you specified.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-instancepoolstousecount
//
InstancePoolsToUseCount *float64 `field:"optional" json:"instancePoolsToUseCount" yaml:"instancePoolsToUseCount"`
// The launch specifications for the Spot Fleet request.
//
// If you specify `LaunchSpecifications` , you can't specify `LaunchTemplateConfigs` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications
//
LaunchSpecifications interface{} `field:"optional" json:"launchSpecifications" yaml:"launchSpecifications"`
// The launch template and overrides.
//
// If you specify `LaunchTemplateConfigs` , you can't specify `LaunchSpecifications` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-launchtemplateconfigs
//
LaunchTemplateConfigs interface{} `field:"optional" json:"launchTemplateConfigs" yaml:"launchTemplateConfigs"`
// One or more Classic Load Balancers and target groups to attach to the Spot Fleet request.
//
// Spot Fleet registers the running Spot Instances with the specified Classic Load Balancers and target groups.
//
// With Network Load Balancers, Spot Fleet cannot register instances that have the following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2, M3, and T1.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-loadbalancersconfig
//
LoadBalancersConfig interface{} `field:"optional" json:"loadBalancersConfig" yaml:"loadBalancersConfig"`
// The order of the launch template overrides to use in fulfilling On-Demand capacity.
//
// If you specify `lowestPrice` , Spot Fleet uses price to determine the order, launching the lowest price first. If you specify `prioritized` , Spot Fleet uses the priority that you assign to each Spot Fleet launch template override, launching the highest priority first. If you do not specify a value, Spot Fleet defaults to `lowestPrice` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-ondemandallocationstrategy
//
OnDemandAllocationStrategy *string `field:"optional" json:"onDemandAllocationStrategy" yaml:"onDemandAllocationStrategy"`
// The maximum amount per hour for On-Demand Instances that you're willing to pay.
//
// You can use the `onDemandMaxTotalPrice` parameter, the `spotMaxTotalPrice` parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the maximum amount you're willing to pay. When the maximum amount you're willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity.
//
// > If your fleet includes T instances that are configured as `unlimited` , and if their average CPU usage exceeds the baseline utilization, you will incur a charge for surplus credits. The `onDemandMaxTotalPrice` does not account for surplus credits, and, if you use surplus credits, your final cost might be higher than what you specified for `onDemandMaxTotalPrice` . For more information, see [Surplus credits can incur charges](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances-unlimited-mode-concepts.html#unlimited-mode-surplus-credits) in the *Amazon EC2 User Guide* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-ondemandmaxtotalprice
//
OnDemandMaxTotalPrice *string `field:"optional" json:"onDemandMaxTotalPrice" yaml:"onDemandMaxTotalPrice"`
// The number of On-Demand units to request.
//
// You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is `maintain` , you can specify a target capacity of 0 and add capacity later.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-ondemandtargetcapacity
//
OnDemandTargetCapacity *float64 `field:"optional" json:"onDemandTargetCapacity" yaml:"onDemandTargetCapacity"`
// Indicates whether Spot Fleet should replace unhealthy instances.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-replaceunhealthyinstances
//
ReplaceUnhealthyInstances interface{} `field:"optional" json:"replaceUnhealthyInstances" yaml:"replaceUnhealthyInstances"`
// The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-spotmaintenancestrategies
//
SpotMaintenanceStrategies interface{} `field:"optional" json:"spotMaintenanceStrategies" yaml:"spotMaintenanceStrategies"`
// The maximum amount per hour for Spot Instances that you're willing to pay.
//
// You can use the `spotMaxTotalPrice` parameter, the `onDemandMaxTotalPrice` parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the maximum amount you're willing to pay. When the maximum amount you're willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity.
//
// > If your fleet includes T instances that are configured as `unlimited` , and if their average CPU usage exceeds the baseline utilization, you will incur a charge for surplus credits. The `spotMaxTotalPrice` does not account for surplus credits, and, if you use surplus credits, your final cost might be higher than what you specified for `spotMaxTotalPrice` . For more information, see [Surplus credits can incur charges](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances-unlimited-mode-concepts.html#unlimited-mode-surplus-credits) in the *Amazon EC2 User Guide* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-spotmaxtotalprice
//
SpotMaxTotalPrice *string `field:"optional" json:"spotMaxTotalPrice" yaml:"spotMaxTotalPrice"`
// The maximum price per unit hour that you are willing to pay for a Spot Instance.
//
// We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
//
// > If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-spotprice
//
SpotPrice *string `field:"optional" json:"spotPrice" yaml:"spotPrice"`
// The key-value pair for tagging the Spot Fleet request on creation.
//
// The value for `ResourceType` must be `spot-fleet-request` , otherwise the Spot Fleet request fails. To tag instances at launch, specify the tags in the [launch template](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html#create-launch-template) (valid only if you use `LaunchTemplateConfigs` ) or in the `[SpotFleetTagSpecification](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SpotFleetTagSpecification.html)` (valid only if you use `LaunchSpecifications` ). For information about tagging after launch, see [Tag your resources](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#tag-resources) .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-tagspecifications
//
TagSpecifications interface{} `field:"optional" json:"tagSpecifications" yaml:"tagSpecifications"`
// The unit for the target capacity. You can specify this parameter only when using attribute-based instance type selection.
//
// Default: `units` (the number of instances).
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-targetcapacityunittype
//
TargetCapacityUnitType *string `field:"optional" json:"targetCapacityUnitType" yaml:"targetCapacityUnitType"`
// Indicates whether running Spot Instances are terminated when the Spot Fleet request expires.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-terminateinstanceswithexpiration
//
TerminateInstancesWithExpiration interface{} `field:"optional" json:"terminateInstancesWithExpiration" yaml:"terminateInstancesWithExpiration"`
// The type of request.
//
// Indicates whether the Spot Fleet only requests the target capacity or also attempts to maintain it. When this value is `request` , the Spot Fleet only places the required requests. It does not attempt to replenish Spot Instances if capacity is diminished, nor does it submit requests in alternative Spot pools if capacity is not available. When this value is `maintain` , the Spot Fleet maintains the target capacity. The Spot Fleet places the required requests to meet capacity and automatically replenishes any interrupted instances. Default: `maintain` . `instant` is listed but is not used by Spot Fleet.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-type
//
Type *string `field:"optional" json:"type" yaml:"type"`
// The start date and time of the request, in UTC format ( *YYYY* - *MM* - *DD* T *HH* : *MM* : *SS* Z).
//
// By default, Amazon EC2 starts fulfilling the request immediately.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-validfrom
//
ValidFrom *string `field:"optional" json:"validFrom" yaml:"validFrom"`
// The end date and time of the request, in UTC format ( *YYYY* - *MM* - *DD* T *HH* : *MM* : *SS* Z).
//
// After the end date and time, no new Spot Instance requests are placed or able to fulfill the request. If no value is specified, the Spot Fleet request remains until you cancel it.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-validuntil
//
ValidUntil *string `field:"optional" json:"validUntil" yaml:"validUntil"`
}
Specifies the configuration of a Spot Fleet request.
For more information, see [Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet.html) in the *Amazon EC2 User Guide* .
You must specify either `LaunchSpecifications` or `LaunchTemplateConfigs` .
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"
spotFleetRequestConfigDataProperty := &SpotFleetRequestConfigDataProperty{
IamFleetRole: jsii.String("iamFleetRole"),
TargetCapacity: jsii.Number(123),
// the properties below are optional
AllocationStrategy: jsii.String("allocationStrategy"),
Context: jsii.String("context"),
ExcessCapacityTerminationPolicy: jsii.String("excessCapacityTerminationPolicy"),
InstanceInterruptionBehavior: jsii.String("instanceInterruptionBehavior"),
InstancePoolsToUseCount: jsii.Number(123),
LaunchSpecifications: []interface{}{
&SpotFleetLaunchSpecificationProperty{
ImageId: jsii.String("imageId"),
// the properties below are optional
BlockDeviceMappings: []interface{}{
&BlockDeviceMappingProperty{
DeviceName: jsii.String("deviceName"),
// the properties below are optional
Ebs: &EbsBlockDeviceProperty{
DeleteOnTermination: jsii.Boolean(false),
Encrypted: jsii.Boolean(false),
Iops: jsii.Number(123),
SnapshotId: jsii.String("snapshotId"),
VolumeSize: jsii.Number(123),
VolumeType: jsii.String("volumeType"),
},
NoDevice: jsii.String("noDevice"),
VirtualName: jsii.String("virtualName"),
},
},
EbsOptimized: jsii.Boolean(false),
IamInstanceProfile: &IamInstanceProfileSpecificationProperty{
Arn: jsii.String("arn"),
},
InstanceRequirements: &InstanceRequirementsRequestProperty{
AcceleratorCount: &AcceleratorCountRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
AcceleratorManufacturers: []*string{
jsii.String("acceleratorManufacturers"),
},
AcceleratorNames: []*string{
jsii.String("acceleratorNames"),
},
AcceleratorTotalMemoryMiB: &AcceleratorTotalMemoryMiBRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
AcceleratorTypes: []*string{
jsii.String("acceleratorTypes"),
},
AllowedInstanceTypes: []*string{
jsii.String("allowedInstanceTypes"),
},
BareMetal: jsii.String("bareMetal"),
BaselineEbsBandwidthMbps: &BaselineEbsBandwidthMbpsRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
BurstablePerformance: jsii.String("burstablePerformance"),
CpuManufacturers: []*string{
jsii.String("cpuManufacturers"),
},
ExcludedInstanceTypes: []*string{
jsii.String("excludedInstanceTypes"),
},
InstanceGenerations: []*string{
jsii.String("instanceGenerations"),
},
LocalStorage: jsii.String("localStorage"),
LocalStorageTypes: []*string{
jsii.String("localStorageTypes"),
},
MaxSpotPriceAsPercentageOfOptimalOnDemandPrice: jsii.Number(123),
MemoryGiBPerVCpu: &MemoryGiBPerVCpuRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
MemoryMiB: &MemoryMiBRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
NetworkBandwidthGbps: &NetworkBandwidthGbpsRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
NetworkInterfaceCount: &NetworkInterfaceCountRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
OnDemandMaxPricePercentageOverLowestPrice: jsii.Number(123),
RequireHibernateSupport: jsii.Boolean(false),
SpotMaxPricePercentageOverLowestPrice: jsii.Number(123),
TotalLocalStorageGb: &TotalLocalStorageGBRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
VCpuCount: &VCpuCountRangeRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
},
InstanceType: jsii.String("instanceType"),
KernelId: jsii.String("kernelId"),
KeyName: jsii.String("keyName"),
Monitoring: &SpotFleetMonitoringProperty{
Enabled: jsii.Boolean(false),
},
NetworkInterfaces: []interface{}{
&InstanceNetworkInterfaceSpecificationProperty{
AssociatePublicIpAddress: jsii.Boolean(false),
DeleteOnTermination: jsii.Boolean(false),
Description: jsii.String("description"),
DeviceIndex: jsii.Number(123),
Groups: []*string{
jsii.String("groups"),
},
Ipv6AddressCount: jsii.Number(123),
Ipv6Addresses: []interface{}{
&InstanceIpv6AddressProperty{
Ipv6Address: jsii.String("ipv6Address"),
},
},
NetworkInterfaceId: jsii.String("networkInterfaceId"),
PrivateIpAddresses: []interface{}{
&PrivateIpAddressSpecificationProperty{
PrivateIpAddress: jsii.String("privateIpAddress"),
// the properties below are optional
Primary: jsii.Boolean(false),
},
},
SecondaryPrivateIpAddressCount: jsii.Number(123),
SubnetId: jsii.String("subnetId"),
},
},
Placement: &SpotPlacementProperty{
AvailabilityZone: jsii.String("availabilityZone"),
GroupName: jsii.String("groupName"),
Tenancy: jsii.String("tenancy"),
},
RamdiskId: jsii.String("ramdiskId"),
SecurityGroups: []interface{}{
&GroupIdentifierProperty{
GroupId: jsii.String("groupId"),
},
},
SpotPrice: jsii.String("spotPrice"),
SubnetId: jsii.String("subnetId"),
TagSpecifications: []interface{}{
&SpotFleetTagSpecificationProperty{
ResourceType: jsii.String("resourceType"),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
},
},
UserData: jsii.String("userData"),
WeightedCapacity: jsii.Number(123),
},
},
LaunchTemplateConfigs: []interface{}{
&LaunchTemplateConfigProperty{
LaunchTemplateSpecification: &FleetLaunchTemplateSpecificationProperty{
Version: jsii.String("version"),
// the properties below are optional
LaunchTemplateId: jsii.String("launchTemplateId"),
LaunchTemplateName: jsii.String("launchTemplateName"),
},
Overrides: []interface{}{
&LaunchTemplateOverridesProperty{
AvailabilityZone: jsii.String("availabilityZone"),
InstanceRequirements: &InstanceRequirementsRequestProperty{
AcceleratorCount: &AcceleratorCountRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
AcceleratorManufacturers: []*string{
jsii.String("acceleratorManufacturers"),
},
AcceleratorNames: []*string{
jsii.String("acceleratorNames"),
},
AcceleratorTotalMemoryMiB: &AcceleratorTotalMemoryMiBRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
AcceleratorTypes: []*string{
jsii.String("acceleratorTypes"),
},
AllowedInstanceTypes: []*string{
jsii.String("allowedInstanceTypes"),
},
BareMetal: jsii.String("bareMetal"),
BaselineEbsBandwidthMbps: &BaselineEbsBandwidthMbpsRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
BurstablePerformance: jsii.String("burstablePerformance"),
CpuManufacturers: []*string{
jsii.String("cpuManufacturers"),
},
ExcludedInstanceTypes: []*string{
jsii.String("excludedInstanceTypes"),
},
InstanceGenerations: []*string{
jsii.String("instanceGenerations"),
},
LocalStorage: jsii.String("localStorage"),
LocalStorageTypes: []*string{
jsii.String("localStorageTypes"),
},
MaxSpotPriceAsPercentageOfOptimalOnDemandPrice: jsii.Number(123),
MemoryGiBPerVCpu: &MemoryGiBPerVCpuRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
MemoryMiB: &MemoryMiBRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
NetworkBandwidthGbps: &NetworkBandwidthGbpsRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
NetworkInterfaceCount: &NetworkInterfaceCountRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
OnDemandMaxPricePercentageOverLowestPrice: jsii.Number(123),
RequireHibernateSupport: jsii.Boolean(false),
SpotMaxPricePercentageOverLowestPrice: jsii.Number(123),
TotalLocalStorageGb: &TotalLocalStorageGBRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
VCpuCount: &VCpuCountRangeRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
},
},
InstanceType: jsii.String("instanceType"),
Priority: jsii.Number(123),
SpotPrice: jsii.String("spotPrice"),
SubnetId: jsii.String("subnetId"),
WeightedCapacity: jsii.Number(123),
},
},
},
},
LoadBalancersConfig: &LoadBalancersConfigProperty{
ClassicLoadBalancersConfig: &ClassicLoadBalancersConfigProperty{
ClassicLoadBalancers: []interface{}{
&ClassicLoadBalancerProperty{
Name: jsii.String("name"),
},
},
},
TargetGroupsConfig: &TargetGroupsConfigProperty{
TargetGroups: []interface{}{
&TargetGroupProperty{
Arn: jsii.String("arn"),
},
},
},
},
OnDemandAllocationStrategy: jsii.String("onDemandAllocationStrategy"),
OnDemandMaxTotalPrice: jsii.String("onDemandMaxTotalPrice"),
OnDemandTargetCapacity: jsii.Number(123),
ReplaceUnhealthyInstances: jsii.Boolean(false),
SpotMaintenanceStrategies: &SpotMaintenanceStrategiesProperty{
CapacityRebalance: &SpotCapacityRebalanceProperty{
ReplacementStrategy: jsii.String("replacementStrategy"),
TerminationDelay: jsii.Number(123),
},
},
SpotMaxTotalPrice: jsii.String("spotMaxTotalPrice"),
SpotPrice: jsii.String("spotPrice"),
TagSpecifications: []interface{}{
&SpotFleetTagSpecificationProperty{
ResourceType: jsii.String("resourceType"),
Tags: []*cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
},
},
TargetCapacityUnitType: jsii.String("targetCapacityUnitType"),
TerminateInstancesWithExpiration: jsii.Boolean(false),
Type: jsii.String("type"),
ValidFrom: jsii.String("validFrom"),
ValidUntil: jsii.String("validUntil"),
}
type CfnSpotFleet_SpotFleetTagSpecificationProperty ¶
type CfnSpotFleet_SpotFleetTagSpecificationProperty struct {
// The type of resource.
//
// Currently, the only resource type that is supported is `instance` . To tag the Spot Fleet request on creation, use the `TagSpecifications` parameter in `[SpotFleetRequestConfigData](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SpotFleetRequestConfigData.html)` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleettagspecification.html#cfn-ec2-spotfleet-spotfleettagspecification-resourcetype
//
ResourceType *string `field:"optional" json:"resourceType" yaml:"resourceType"`
// The tags.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleettagspecification.html#cfn-ec2-spotfleet-spotfleettagspecification-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
The tags for a Spot Fleet resource.
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"
spotFleetTagSpecificationProperty := &SpotFleetTagSpecificationProperty{
ResourceType: jsii.String("resourceType"),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
type CfnSpotFleet_SpotMaintenanceStrategiesProperty ¶
type CfnSpotFleet_SpotMaintenanceStrategiesProperty struct {
// The Spot Instance replacement strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an elevated risk of being interrupted.
//
// For more information, see [Capacity rebalancing](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-capacity-rebalance.html) in the *Amazon EC2 User Guide* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotmaintenancestrategies.html#cfn-ec2-spotfleet-spotmaintenancestrategies-capacityrebalance
//
CapacityRebalance interface{} `field:"optional" json:"capacityRebalance" yaml:"capacityRebalance"`
}
The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.
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"
spotMaintenanceStrategiesProperty := &SpotMaintenanceStrategiesProperty{
CapacityRebalance: &SpotCapacityRebalanceProperty{
ReplacementStrategy: jsii.String("replacementStrategy"),
TerminationDelay: jsii.Number(123),
},
}
type CfnSpotFleet_SpotPlacementProperty ¶
type CfnSpotFleet_SpotPlacementProperty struct {
// The Availability Zone.
//
// To specify multiple Availability Zones, separate them using commas; for example, "us-west-2a, us-west-2b".
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotplacement.html#cfn-ec2-spotfleet-spotplacement-availabilityzone
//
AvailabilityZone *string `field:"optional" json:"availabilityZone" yaml:"availabilityZone"`
// The name of the placement group.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotplacement.html#cfn-ec2-spotfleet-spotplacement-groupname
//
GroupName *string `field:"optional" json:"groupName" yaml:"groupName"`
// The tenancy of the instance (if the instance is running in a VPC).
//
// An instance with a tenancy of `dedicated` runs on single-tenant hardware. The `host` tenancy is not supported for Spot Instances.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotplacement.html#cfn-ec2-spotfleet-spotplacement-tenancy
//
Tenancy *string `field:"optional" json:"tenancy" yaml:"tenancy"`
}
Describes Spot Instance placement.
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"
spotPlacementProperty := &SpotPlacementProperty{
AvailabilityZone: jsii.String("availabilityZone"),
GroupName: jsii.String("groupName"),
Tenancy: jsii.String("tenancy"),
}
type CfnSpotFleet_TargetGroupProperty ¶
type CfnSpotFleet_TargetGroupProperty struct {
// The Amazon Resource Name (ARN) of the target group.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-targetgroup.html#cfn-ec2-spotfleet-targetgroup-arn
//
Arn *string `field:"required" json:"arn" yaml:"arn"`
}
Describes a load balancer target group.
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"
targetGroupProperty := &TargetGroupProperty{
Arn: jsii.String("arn"),
}
type CfnSpotFleet_TargetGroupsConfigProperty ¶
type CfnSpotFleet_TargetGroupsConfigProperty struct {
// One or more target groups.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-targetgroupsconfig.html#cfn-ec2-spotfleet-targetgroupsconfig-targetgroups
//
TargetGroups interface{} `field:"required" json:"targetGroups" yaml:"targetGroups"`
}
Describes the target groups to attach to a Spot Fleet.
Spot Fleet registers the running Spot Instances with these target groups.
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"
targetGroupsConfigProperty := &TargetGroupsConfigProperty{
TargetGroups: []interface{}{
&TargetGroupProperty{
Arn: jsii.String("arn"),
},
},
}
type CfnSpotFleet_TotalLocalStorageGBRequestProperty ¶
type CfnSpotFleet_TotalLocalStorageGBRequestProperty struct {
// The maximum amount of total local storage, in GB.
//
// To specify no maximum limit, omit this parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-totallocalstoragegbrequest.html#cfn-ec2-spotfleet-totallocalstoragegbrequest-max
//
Max *float64 `field:"optional" json:"max" yaml:"max"`
// The minimum amount of total local storage, in GB.
//
// To specify no minimum limit, omit this parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-totallocalstoragegbrequest.html#cfn-ec2-spotfleet-totallocalstoragegbrequest-min
//
Min *float64 `field:"optional" json:"min" yaml:"min"`
}
The minimum and maximum amount of total local storage, in GB.
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"
totalLocalStorageGBRequestProperty := &TotalLocalStorageGBRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
}
type CfnSpotFleet_VCpuCountRangeRequestProperty ¶
type CfnSpotFleet_VCpuCountRangeRequestProperty struct {
// The maximum number of vCPUs.
//
// To specify no maximum limit, omit this parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-vcpucountrangerequest.html#cfn-ec2-spotfleet-vcpucountrangerequest-max
//
Max *float64 `field:"optional" json:"max" yaml:"max"`
// The minimum number of vCPUs.
//
// To specify no minimum limit, specify `0` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-vcpucountrangerequest.html#cfn-ec2-spotfleet-vcpucountrangerequest-min
//
Min *float64 `field:"optional" json:"min" yaml:"min"`
}
The minimum and maximum number of vCPUs.
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"
vCpuCountRangeRequestProperty := &VCpuCountRangeRequestProperty{
Max: jsii.Number(123),
Min: jsii.Number(123),
}
type CfnSubnet ¶
type CfnSubnet interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggable
// Indicates whether a network interface created in this subnet receives an IPv6 address.
//
// The default value is `false` .
AssignIpv6AddressOnCreation() interface{}
SetAssignIpv6AddressOnCreation(val interface{})
// The Availability Zone of this subnet.
//
// For example, `us-east-1a` .
AttrAvailabilityZone() *string
// The Availability Zone ID of this subnet.
//
// For example, `use1-az1` .
AttrAvailabilityZoneId() *string
// The IPv4 CIDR blocks that are associated with the subnet.
AttrCidrBlock() *string
// The IPv6 CIDR blocks that are associated with the subnet.
AttrIpv6CidrBlocks() *[]*string
// The ID of the network ACL that is associated with the subnet's VPC, such as `acl-5fb85d36` .
AttrNetworkAclAssociationId() *string
// The Amazon Resource Name (ARN) of the Outpost.
AttrOutpostArn() *string
// The ID of the subnet.
AttrSubnetId() *string
// The ID of the subnet's VPC, such as `vpc-11ad4878` .
AttrVpcId() *string
// The Availability Zone of the subnet.
AvailabilityZone() *string
SetAvailabilityZone(val *string)
// The AZ ID of the subnet.
AvailabilityZoneId() *string
SetAvailabilityZoneId(val *string)
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// The IPv4 CIDR block assigned to the subnet.
CidrBlock() *string
SetCidrBlock(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
// Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations.
EnableDns64() interface{}
SetEnableDns64(val interface{})
// Indicates the device position for local network interfaces in this subnet.
EnableLniAtDeviceIndex() *float64
SetEnableLniAtDeviceIndex(val *float64)
// An IPv4 IPAM pool ID for the subnet.
Ipv4IpamPoolId() *string
SetIpv4IpamPoolId(val *string)
// An IPv4 netmask length for the subnet.
Ipv4NetmaskLength() *float64
SetIpv4NetmaskLength(val *float64)
// The IPv6 CIDR block.
Ipv6CidrBlock() *string
SetIpv6CidrBlock(val *string)
// An IPv6 IPAM pool ID for the subnet.
Ipv6IpamPoolId() *string
SetIpv6IpamPoolId(val *string)
// Indicates whether this is an IPv6 only subnet.
Ipv6Native() interface{}
SetIpv6Native(val interface{})
// An IPv6 netmask length for the subnet.
Ipv6NetmaskLength() *float64
SetIpv6NetmaskLength(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
// Indicates whether instances launched in this subnet receive a public IPv4 address.
//
// The default value is `false` .
MapPublicIpOnLaunch() interface{}
SetMapPublicIpOnLaunch(val interface{})
// The tree node.
Node() constructs.Node
// The Amazon Resource Name (ARN) of the Outpost.
OutpostArn() *string
SetOutpostArn(val *string)
// The hostname type for EC2 instances launched into this subnet and how DNS A and AAAA record queries to the instances should be handled.
PrivateDnsNameOptionsOnLaunch() interface{}
SetPrivateDnsNameOptionsOnLaunch(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
// Any tags assigned to the subnet.
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 ID of the VPC the subnet is in.
VpcId() *string
SetVpcId(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{})
}
Specifies a subnet for the specified VPC.
For an IPv4 only subnet, specify an IPv4 CIDR block. If the VPC has an IPv6 CIDR block, you can create an IPv6 only subnet or a dual stack subnet instead. For an IPv6 only subnet, specify an IPv6 CIDR block. For a dual stack subnet, specify both an IPv4 CIDR block and an IPv6 CIDR block.
For more information, see [Subnets for your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/configure-subnets.html) in the *Amazon VPC User Guide* .
Example:
var vpc vpc
func associateSubnetWithV6Cidr(vpc *vpc, count *f64, subnet iSubnet) {
cfnSubnet := *subnet.Node.defaultChild.(cfnSubnet)
cfnSubnet.Ipv6CidrBlock = awscdk.Fn_Select(count, awscdk.Fn_Cidr(awscdk.Fn_Select(jsii.Number(0), vpc.VpcIpv6CidrBlocks), jsii.Number(256), (jsii.Number(128 - 64)).toString()))
cfnSubnet.AssignIpv6AddressOnCreation = true
}
// make an ipv6 cidr
ipv6cidr := ec2.NewCfnVPCCidrBlock(this, jsii.String("CIDR6"), &CfnVPCCidrBlockProps{
VpcId: vpc.VpcId,
AmazonProvidedIpv6CidrBlock: jsii.Boolean(true),
})
// connect the ipv6 cidr to all vpc subnets
subnetcount := 0
subnets := vpc.PublicSubnets.concat(vpc.PrivateSubnets)
for _, subnet := range subnets {
// Wait for the ipv6 cidr to complete
subnet.Node.AddDependency(ipv6cidr)
associateSubnetWithV6Cidr(vpc, subnetcount, subnet)
subnetcount = subnetcount + 1
}
cluster := eks.NewCluster(this, jsii.String("hello-eks"), &ClusterProps{
Version: eks.KubernetesVersion_V1_30(),
Vpc: vpc,
IpFamily: eks.IpFamily_IP_V6,
VpcSubnets: []subnetSelection{
&subnetSelection{
Subnets: vpc.*PublicSubnets,
},
},
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html
func NewCfnSubnet ¶
func NewCfnSubnet(scope constructs.Construct, id *string, props *CfnSubnetProps) CfnSubnet
type CfnSubnetCidrBlock ¶
type CfnSubnetCidrBlock interface {
awscdk.CfnResource
awscdk.IInspectable
// The ID of the association.
AttrId() *string
// The source that allocated the IP address space.
//
// `byoip` or `amazon` indicates public IP address space allocated by Amazon or space that you have allocated with Bring your own IP (BYOIP). `none` indicates private space.
AttrIpSource() *string
// Public IPv6 addresses are those advertised on the internet from AWS .
//
// Private IP addresses are not and cannot be advertised on the internet from AWS .
AttrIpv6AddressAttribute() *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 IPv6 network range for the subnet, in CIDR notation.
Ipv6CidrBlock() *string
SetIpv6CidrBlock(val *string)
// An IPv6 IPAM pool ID for the subnet.
Ipv6IpamPoolId() *string
SetIpv6IpamPoolId(val *string)
// An IPv6 netmask length for the subnet.
Ipv6NetmaskLength() *float64
SetIpv6NetmaskLength(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 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 ID of the subnet.
SubnetId() *string
SetSubnetId(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{})
}
Associates a CIDR block with your subnet.
You can associate a single IPv6 CIDR block with your subnet.
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"
cfnSubnetCidrBlock := awscdk.Aws_ec2.NewCfnSubnetCidrBlock(this, jsii.String("MyCfnSubnetCidrBlock"), &CfnSubnetCidrBlockProps{
SubnetId: jsii.String("subnetId"),
// the properties below are optional
Ipv6CidrBlock: jsii.String("ipv6CidrBlock"),
Ipv6IpamPoolId: jsii.String("ipv6IpamPoolId"),
Ipv6NetmaskLength: jsii.Number(123),
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetcidrblock.html
func NewCfnSubnetCidrBlock ¶
func NewCfnSubnetCidrBlock(scope constructs.Construct, id *string, props *CfnSubnetCidrBlockProps) CfnSubnetCidrBlock
type CfnSubnetCidrBlockProps ¶
type CfnSubnetCidrBlockProps struct {
// The ID of the subnet.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetcidrblock.html#cfn-ec2-subnetcidrblock-subnetid
//
SubnetId *string `field:"required" json:"subnetId" yaml:"subnetId"`
// The IPv6 network range for the subnet, in CIDR notation.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetcidrblock.html#cfn-ec2-subnetcidrblock-ipv6cidrblock
//
Ipv6CidrBlock *string `field:"optional" json:"ipv6CidrBlock" yaml:"ipv6CidrBlock"`
// An IPv6 IPAM pool ID for the subnet.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetcidrblock.html#cfn-ec2-subnetcidrblock-ipv6ipampoolid
//
Ipv6IpamPoolId *string `field:"optional" json:"ipv6IpamPoolId" yaml:"ipv6IpamPoolId"`
// An IPv6 netmask length for the subnet.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetcidrblock.html#cfn-ec2-subnetcidrblock-ipv6netmasklength
//
Ipv6NetmaskLength *float64 `field:"optional" json:"ipv6NetmaskLength" yaml:"ipv6NetmaskLength"`
}
Properties for defining a `CfnSubnetCidrBlock`.
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"
cfnSubnetCidrBlockProps := &CfnSubnetCidrBlockProps{
SubnetId: jsii.String("subnetId"),
// the properties below are optional
Ipv6CidrBlock: jsii.String("ipv6CidrBlock"),
Ipv6IpamPoolId: jsii.String("ipv6IpamPoolId"),
Ipv6NetmaskLength: jsii.Number(123),
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetcidrblock.html
type CfnSubnetNetworkAclAssociation ¶
type CfnSubnetNetworkAclAssociation interface {
awscdk.CfnResource
awscdk.IInspectable
// Returns the value of this object's AssociationId property.
AttrAssociationId() *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 ID of the network ACL.
NetworkAclId() *string
SetNetworkAclId(val *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 ID of the subnet.
SubnetId() *string
SetSubnetId(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{})
}
Associates a subnet with a network ACL. For more information, see [ReplaceNetworkAclAssociation](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-ReplaceNetworkAclAssociation.html) in the *Amazon EC2 API Reference* .
When `AWS::EC2::SubnetNetworkAclAssociation` resources are created during create or update operations, AWS CloudFormation adopts existing resources that share the same key properties (the properties that contribute to uniquely identify the resource). However, if the operation fails and rolls back, AWS CloudFormation deletes the previously out-of-band resources. You can protect against this behavior by using `Retain` deletion policies. For more information, see [DeletionPolicy Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.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"
cfnSubnetNetworkAclAssociation := awscdk.Aws_ec2.NewCfnSubnetNetworkAclAssociation(this, jsii.String("MyCfnSubnetNetworkAclAssociation"), &CfnSubnetNetworkAclAssociationProps{
NetworkAclId: jsii.String("networkAclId"),
SubnetId: jsii.String("subnetId"),
})
func NewCfnSubnetNetworkAclAssociation ¶
func NewCfnSubnetNetworkAclAssociation(scope constructs.Construct, id *string, props *CfnSubnetNetworkAclAssociationProps) CfnSubnetNetworkAclAssociation
type CfnSubnetNetworkAclAssociationProps ¶
type CfnSubnetNetworkAclAssociationProps struct {
// The ID of the network ACL.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetnetworkaclassociation.html#cfn-ec2-subnetnetworkaclassociation-networkaclid
//
NetworkAclId *string `field:"required" json:"networkAclId" yaml:"networkAclId"`
// The ID of the subnet.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetnetworkaclassociation.html#cfn-ec2-subnetnetworkaclassociation-subnetid
//
SubnetId *string `field:"required" json:"subnetId" yaml:"subnetId"`
}
Properties for defining a `CfnSubnetNetworkAclAssociation`.
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"
cfnSubnetNetworkAclAssociationProps := &CfnSubnetNetworkAclAssociationProps{
NetworkAclId: jsii.String("networkAclId"),
SubnetId: jsii.String("subnetId"),
}
type CfnSubnetProps ¶
type CfnSubnetProps struct {
// The ID of the VPC the subnet is in.
//
// If you update this property, you must also update the `CidrBlock` property.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-vpcid
//
VpcId *string `field:"required" json:"vpcId" yaml:"vpcId"`
// Indicates whether a network interface created in this subnet receives an IPv6 address. The default value is `false` .
//
// If you specify `AssignIpv6AddressOnCreation` , you must also specify an IPv6 CIDR block.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-assignipv6addressoncreation
//
AssignIpv6AddressOnCreation interface{} `field:"optional" json:"assignIpv6AddressOnCreation" yaml:"assignIpv6AddressOnCreation"`
// The Availability Zone of the subnet.
//
// If you update this property, you must also update the `CidrBlock` property.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-availabilityzone
//
AvailabilityZone *string `field:"optional" json:"availabilityZone" yaml:"availabilityZone"`
// The AZ ID of the subnet.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-availabilityzoneid
//
AvailabilityZoneId *string `field:"optional" json:"availabilityZoneId" yaml:"availabilityZoneId"`
// The IPv4 CIDR block assigned to the subnet.
//
// If you update this property, we create a new subnet, and then delete the existing one.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-cidrblock
//
CidrBlock *string `field:"optional" json:"cidrBlock" yaml:"cidrBlock"`
// Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations.
//
// > You must first configure a NAT gateway in a public subnet (separate from the subnet containing the IPv6-only workloads). For example, the subnet containing the NAT gateway should have a `0.0.0.0/0` route pointing to the internet gateway. For more information, see [Configure DNS64 and NAT64](https://docs.aws.amazon.com/vpc/latest/userguide/nat-gateway-nat64-dns64.html#nat-gateway-nat64-dns64-walkthrough) in the *Amazon Virtual Private Cloud User Guide* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-enabledns64
//
EnableDns64 interface{} `field:"optional" json:"enableDns64" yaml:"enableDns64"`
// Indicates the device position for local network interfaces in this subnet.
//
// For example, `1` indicates local network interfaces in this subnet are the secondary network interface (eth1).
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-enablelniatdeviceindex
//
EnableLniAtDeviceIndex *float64 `field:"optional" json:"enableLniAtDeviceIndex" yaml:"enableLniAtDeviceIndex"`
// An IPv4 IPAM pool ID for the subnet.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-ipv4ipampoolid
//
Ipv4IpamPoolId *string `field:"optional" json:"ipv4IpamPoolId" yaml:"ipv4IpamPoolId"`
// An IPv4 netmask length for the subnet.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-ipv4netmasklength
//
Ipv4NetmaskLength *float64 `field:"optional" json:"ipv4NetmaskLength" yaml:"ipv4NetmaskLength"`
// The IPv6 CIDR block.
//
// If you specify `AssignIpv6AddressOnCreation` , you must also specify an IPv6 CIDR block.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-ipv6cidrblock
//
Ipv6CidrBlock *string `field:"optional" json:"ipv6CidrBlock" yaml:"ipv6CidrBlock"`
// An IPv6 IPAM pool ID for the subnet.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-ipv6ipampoolid
//
Ipv6IpamPoolId *string `field:"optional" json:"ipv6IpamPoolId" yaml:"ipv6IpamPoolId"`
// Indicates whether this is an IPv6 only subnet.
//
// For more information, see [Subnet basics](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html#subnet-basics) in the *Amazon Virtual Private Cloud User Guide* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-ipv6native
//
Ipv6Native interface{} `field:"optional" json:"ipv6Native" yaml:"ipv6Native"`
// An IPv6 netmask length for the subnet.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-ipv6netmasklength
//
Ipv6NetmaskLength *float64 `field:"optional" json:"ipv6NetmaskLength" yaml:"ipv6NetmaskLength"`
// Indicates whether instances launched in this subnet receive a public IPv4 address. The default value is `false` .
//
// AWS charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the *Public IPv4 Address* tab on the [VPC pricing page](https://docs.aws.amazon.com/vpc/pricing/) .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-mappubliciponlaunch
//
MapPublicIpOnLaunch interface{} `field:"optional" json:"mapPublicIpOnLaunch" yaml:"mapPublicIpOnLaunch"`
// The Amazon Resource Name (ARN) of the Outpost.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-outpostarn
//
OutpostArn *string `field:"optional" json:"outpostArn" yaml:"outpostArn"`
// The hostname type for EC2 instances launched into this subnet and how DNS A and AAAA record queries to the instances should be handled.
//
// For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *Amazon Elastic Compute Cloud User Guide* .
//
// Available options:
//
// - EnableResourceNameDnsAAAARecord (true | false)
// - EnableResourceNameDnsARecord (true | false)
// - HostnameType (ip-name | resource-name).
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-privatednsnameoptionsonlaunch
//
PrivateDnsNameOptionsOnLaunch interface{} `field:"optional" json:"privateDnsNameOptionsOnLaunch" yaml:"privateDnsNameOptionsOnLaunch"`
// Any tags assigned to the subnet.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnSubnet`.
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"
var privateDnsNameOptionsOnLaunch interface{}
cfnSubnetProps := &CfnSubnetProps{
VpcId: jsii.String("vpcId"),
// the properties below are optional
AssignIpv6AddressOnCreation: jsii.Boolean(false),
AvailabilityZone: jsii.String("availabilityZone"),
AvailabilityZoneId: jsii.String("availabilityZoneId"),
CidrBlock: jsii.String("cidrBlock"),
EnableDns64: jsii.Boolean(false),
EnableLniAtDeviceIndex: jsii.Number(123),
Ipv4IpamPoolId: jsii.String("ipv4IpamPoolId"),
Ipv4NetmaskLength: jsii.Number(123),
Ipv6CidrBlock: jsii.String("ipv6CidrBlock"),
Ipv6IpamPoolId: jsii.String("ipv6IpamPoolId"),
Ipv6Native: jsii.Boolean(false),
Ipv6NetmaskLength: jsii.Number(123),
MapPublicIpOnLaunch: jsii.Boolean(false),
OutpostArn: jsii.String("outpostArn"),
PrivateDnsNameOptionsOnLaunch: privateDnsNameOptionsOnLaunch,
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html
type CfnSubnetRouteTableAssociation ¶
type CfnSubnetRouteTableAssociation interface {
awscdk.CfnResource
awscdk.IInspectable
// The ID of the subnet route table association.
AttrId() *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 ID of the route table.
RouteTableId() *string
SetRouteTableId(val *string)
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// The ID of the subnet.
SubnetId() *string
SetSubnetId(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{})
}
Associates a subnet with a route table.
The subnet and route table must be in the same VPC. This association causes traffic originating from the subnet to be routed according to the routes in the route table. A route table can be associated with multiple subnets. To create a route table, see [AWS::EC2::RouteTable](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routetable.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"
cfnSubnetRouteTableAssociation := awscdk.Aws_ec2.NewCfnSubnetRouteTableAssociation(this, jsii.String("MyCfnSubnetRouteTableAssociation"), &CfnSubnetRouteTableAssociationProps{
RouteTableId: jsii.String("routeTableId"),
SubnetId: jsii.String("subnetId"),
})
func NewCfnSubnetRouteTableAssociation ¶
func NewCfnSubnetRouteTableAssociation(scope constructs.Construct, id *string, props *CfnSubnetRouteTableAssociationProps) CfnSubnetRouteTableAssociation
type CfnSubnetRouteTableAssociationProps ¶
type CfnSubnetRouteTableAssociationProps struct {
// The ID of the route table.
//
// The physical ID changes when the route table ID is changed.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetroutetableassociation.html#cfn-ec2-subnetroutetableassociation-routetableid
//
RouteTableId *string `field:"required" json:"routeTableId" yaml:"routeTableId"`
// The ID of the subnet.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetroutetableassociation.html#cfn-ec2-subnetroutetableassociation-subnetid
//
SubnetId *string `field:"required" json:"subnetId" yaml:"subnetId"`
}
Properties for defining a `CfnSubnetRouteTableAssociation`.
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"
cfnSubnetRouteTableAssociationProps := &CfnSubnetRouteTableAssociationProps{
RouteTableId: jsii.String("routeTableId"),
SubnetId: jsii.String("subnetId"),
}
type CfnSubnet_PrivateDnsNameOptionsOnLaunchProperty ¶ added in v2.13.0
type CfnSubnet_PrivateDnsNameOptionsOnLaunchProperty struct {
// Indicates whether to respond to DNS queries for instance hostname with DNS AAAA records.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-subnet-privatednsnameoptionsonlaunch.html#cfn-ec2-subnet-privatednsnameoptionsonlaunch-enableresourcenamednsaaaarecord
//
EnableResourceNameDnsAaaaRecord interface{} `field:"optional" json:"enableResourceNameDnsAaaaRecord" yaml:"enableResourceNameDnsAaaaRecord"`
// Indicates whether to respond to DNS queries for instance hostnames with DNS A records.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-subnet-privatednsnameoptionsonlaunch.html#cfn-ec2-subnet-privatednsnameoptionsonlaunch-enableresourcenamednsarecord
//
EnableResourceNameDnsARecord interface{} `field:"optional" json:"enableResourceNameDnsARecord" yaml:"enableResourceNameDnsARecord"`
// The type of hostname for EC2 instances.
//
// For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance IPv4 address or the instance ID.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-subnet-privatednsnameoptionsonlaunch.html#cfn-ec2-subnet-privatednsnameoptionsonlaunch-hostnametype
//
HostnameType *string `field:"optional" json:"hostnameType" yaml:"hostnameType"`
}
Describes the options for instance hostnames.
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"
privateDnsNameOptionsOnLaunchProperty := &PrivateDnsNameOptionsOnLaunchProperty{
EnableResourceNameDnsAaaaRecord: jsii.Boolean(false),
EnableResourceNameDnsARecord: jsii.Boolean(false),
HostnameType: jsii.String("hostnameType"),
}
type CfnTrafficMirrorFilter ¶
type CfnTrafficMirrorFilter interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggable
AttrId() *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 description of the Traffic Mirror filter.
Description() *string
SetDescription(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 network service traffic that is associated with the Traffic Mirror filter.
NetworkServices() *[]*string
SetNetworkServices(val *[]*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
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
// The tags to assign to a Traffic Mirror filter.
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{})
}
Specifies a Traffic Mirror filter.
A Traffic Mirror filter is a set of rules that defines the traffic to mirror.
By default, no traffic is mirrored. To mirror traffic, use [AWS::EC2::TrafficMirrorFilterRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html) to add Traffic Mirror rules to the filter. The rules you add define what traffic gets mirrored.
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"
cfnTrafficMirrorFilter := awscdk.Aws_ec2.NewCfnTrafficMirrorFilter(this, jsii.String("MyCfnTrafficMirrorFilter"), &CfnTrafficMirrorFilterProps{
Description: jsii.String("description"),
NetworkServices: []*string{
jsii.String("networkServices"),
},
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
func NewCfnTrafficMirrorFilter ¶
func NewCfnTrafficMirrorFilter(scope constructs.Construct, id *string, props *CfnTrafficMirrorFilterProps) CfnTrafficMirrorFilter
type CfnTrafficMirrorFilterProps ¶
type CfnTrafficMirrorFilterProps struct {
// The description of the Traffic Mirror filter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilter.html#cfn-ec2-trafficmirrorfilter-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// The network service traffic that is associated with the Traffic Mirror filter.
//
// Valid values are `amazon-dns` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilter.html#cfn-ec2-trafficmirrorfilter-networkservices
//
NetworkServices *[]*string `field:"optional" json:"networkServices" yaml:"networkServices"`
// The tags to assign to a Traffic Mirror filter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilter.html#cfn-ec2-trafficmirrorfilter-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnTrafficMirrorFilter`.
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"
cfnTrafficMirrorFilterProps := &CfnTrafficMirrorFilterProps{
Description: jsii.String("description"),
NetworkServices: []*string{
jsii.String("networkServices"),
},
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
type CfnTrafficMirrorFilterRule ¶
type CfnTrafficMirrorFilterRule interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggableV2
AttrId() *string
// Tag Manager which manages the tags for this resource.
CdkTagManager() awscdk.TagManager
// 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 description of the Traffic Mirror rule.
Description() *string
SetDescription(val *string)
// The destination CIDR block to assign to the Traffic Mirror rule.
DestinationCidrBlock() *string
SetDestinationCidrBlock(val *string)
// The destination port range.
DestinationPortRange() interface{}
SetDestinationPortRange(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 protocol, for example UDP, to assign to the Traffic Mirror rule.
Protocol() *float64
SetProtocol(val *float64)
// 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 action to take on the filtered traffic.
RuleAction() *string
SetRuleAction(val *string)
// The number of the Traffic Mirror rule.
RuleNumber() *float64
SetRuleNumber(val *float64)
// The source CIDR block to assign to the Traffic Mirror rule.
SourceCidrBlock() *string
SetSourceCidrBlock(val *string)
// The source port range.
SourcePortRange() interface{}
SetSourcePortRange(val interface{})
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Tags on Traffic Mirroring filter rules.
Tags() *[]*awscdk.CfnTag
SetTags(val *[]*awscdk.CfnTag)
// The type of traffic.
TrafficDirection() *string
SetTrafficDirection(val *string)
// The ID of the filter that this rule is associated with.
TrafficMirrorFilterId() *string
SetTrafficMirrorFilterId(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{})
}
Creates a Traffic Mirror filter rule.
A Traffic Mirror rule defines the Traffic Mirror source traffic to mirror.
You need the Traffic Mirror filter ID when you create the rule.
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"
cfnTrafficMirrorFilterRule := awscdk.Aws_ec2.NewCfnTrafficMirrorFilterRule(this, jsii.String("MyCfnTrafficMirrorFilterRule"), &CfnTrafficMirrorFilterRuleProps{
DestinationCidrBlock: jsii.String("destinationCidrBlock"),
RuleAction: jsii.String("ruleAction"),
RuleNumber: jsii.Number(123),
SourceCidrBlock: jsii.String("sourceCidrBlock"),
TrafficDirection: jsii.String("trafficDirection"),
TrafficMirrorFilterId: jsii.String("trafficMirrorFilterId"),
// the properties below are optional
Description: jsii.String("description"),
DestinationPortRange: &TrafficMirrorPortRangeProperty{
FromPort: jsii.Number(123),
ToPort: jsii.Number(123),
},
Protocol: jsii.Number(123),
SourcePortRange: &TrafficMirrorPortRangeProperty{
FromPort: jsii.Number(123),
ToPort: jsii.Number(123),
},
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
func NewCfnTrafficMirrorFilterRule ¶
func NewCfnTrafficMirrorFilterRule(scope constructs.Construct, id *string, props *CfnTrafficMirrorFilterRuleProps) CfnTrafficMirrorFilterRule
type CfnTrafficMirrorFilterRuleProps ¶
type CfnTrafficMirrorFilterRuleProps struct {
// The destination CIDR block to assign to the Traffic Mirror rule.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html#cfn-ec2-trafficmirrorfilterrule-destinationcidrblock
//
DestinationCidrBlock *string `field:"required" json:"destinationCidrBlock" yaml:"destinationCidrBlock"`
// The action to take on the filtered traffic.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html#cfn-ec2-trafficmirrorfilterrule-ruleaction
//
RuleAction *string `field:"required" json:"ruleAction" yaml:"ruleAction"`
// The number of the Traffic Mirror rule.
//
// This number must be unique for each Traffic Mirror rule in a given direction. The rules are processed in ascending order by rule number.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html#cfn-ec2-trafficmirrorfilterrule-rulenumber
//
RuleNumber *float64 `field:"required" json:"ruleNumber" yaml:"ruleNumber"`
// The source CIDR block to assign to the Traffic Mirror rule.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html#cfn-ec2-trafficmirrorfilterrule-sourcecidrblock
//
SourceCidrBlock *string `field:"required" json:"sourceCidrBlock" yaml:"sourceCidrBlock"`
// The type of traffic.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html#cfn-ec2-trafficmirrorfilterrule-trafficdirection
//
TrafficDirection *string `field:"required" json:"trafficDirection" yaml:"trafficDirection"`
// The ID of the filter that this rule is associated with.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html#cfn-ec2-trafficmirrorfilterrule-trafficmirrorfilterid
//
TrafficMirrorFilterId *string `field:"required" json:"trafficMirrorFilterId" yaml:"trafficMirrorFilterId"`
// The description of the Traffic Mirror rule.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html#cfn-ec2-trafficmirrorfilterrule-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// The destination port range.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html#cfn-ec2-trafficmirrorfilterrule-destinationportrange
//
DestinationPortRange interface{} `field:"optional" json:"destinationPortRange" yaml:"destinationPortRange"`
// The protocol, for example UDP, to assign to the Traffic Mirror rule.
//
// For information about the protocol value, see [Protocol Numbers](https://docs.aws.amazon.com/https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml) on the Internet Assigned Numbers Authority (IANA) website.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html#cfn-ec2-trafficmirrorfilterrule-protocol
//
Protocol *float64 `field:"optional" json:"protocol" yaml:"protocol"`
// The source port range.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html#cfn-ec2-trafficmirrorfilterrule-sourceportrange
//
SourcePortRange interface{} `field:"optional" json:"sourcePortRange" yaml:"sourcePortRange"`
// Tags on Traffic Mirroring filter rules.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html#cfn-ec2-trafficmirrorfilterrule-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnTrafficMirrorFilterRule`.
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"
cfnTrafficMirrorFilterRuleProps := &CfnTrafficMirrorFilterRuleProps{
DestinationCidrBlock: jsii.String("destinationCidrBlock"),
RuleAction: jsii.String("ruleAction"),
RuleNumber: jsii.Number(123),
SourceCidrBlock: jsii.String("sourceCidrBlock"),
TrafficDirection: jsii.String("trafficDirection"),
TrafficMirrorFilterId: jsii.String("trafficMirrorFilterId"),
// the properties below are optional
Description: jsii.String("description"),
DestinationPortRange: &TrafficMirrorPortRangeProperty{
FromPort: jsii.Number(123),
ToPort: jsii.Number(123),
},
Protocol: jsii.Number(123),
SourcePortRange: &TrafficMirrorPortRangeProperty{
FromPort: jsii.Number(123),
ToPort: jsii.Number(123),
},
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
type CfnTrafficMirrorFilterRule_TrafficMirrorPortRangeProperty ¶
type CfnTrafficMirrorFilterRule_TrafficMirrorPortRangeProperty struct {
// The start of the Traffic Mirror port range.
//
// This applies to the TCP and UDP protocols.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-trafficmirrorfilterrule-trafficmirrorportrange.html#cfn-ec2-trafficmirrorfilterrule-trafficmirrorportrange-fromport
//
FromPort *float64 `field:"required" json:"fromPort" yaml:"fromPort"`
// The end of the Traffic Mirror port range.
//
// This applies to the TCP and UDP protocols.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-trafficmirrorfilterrule-trafficmirrorportrange.html#cfn-ec2-trafficmirrorfilterrule-trafficmirrorportrange-toport
//
ToPort *float64 `field:"required" json:"toPort" yaml:"toPort"`
}
Describes the Traffic Mirror port range.
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"
trafficMirrorPortRangeProperty := &TrafficMirrorPortRangeProperty{
FromPort: jsii.Number(123),
ToPort: jsii.Number(123),
}
type CfnTrafficMirrorSession ¶
type CfnTrafficMirrorSession interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggable
AttrId() *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 description of the Traffic Mirror session.
Description() *string
SetDescription(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 ID of the source network interface.
NetworkInterfaceId() *string
SetNetworkInterfaceId(val *string)
// The tree node.
Node() constructs.Node
// The number of bytes in each packet to mirror.
PacketLength() *float64
SetPacketLength(val *float64)
// 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 session number determines the order in which sessions are evaluated when an interface is used by multiple sessions.
SessionNumber() *float64
SetSessionNumber(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
// The tags to assign to a Traffic Mirror session.
TagsRaw() *[]*awscdk.CfnTag
SetTagsRaw(val *[]*awscdk.CfnTag)
// The ID of the Traffic Mirror filter.
TrafficMirrorFilterId() *string
SetTrafficMirrorFilterId(val *string)
// The ID of the Traffic Mirror target.
TrafficMirrorTargetId() *string
SetTrafficMirrorTargetId(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{}
// The VXLAN ID for the Traffic Mirror session.
VirtualNetworkId() *float64
SetVirtualNetworkId(val *float64)
// 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{})
}
Creates a Traffic Mirror session.
A Traffic Mirror session actively copies packets from a Traffic Mirror source to a Traffic Mirror target. Create a filter, and then assign it to the session to define a subset of the traffic to mirror, for example all TCP traffic.
The Traffic Mirror source and the Traffic Mirror target (monitoring appliances) can be in the same VPC, or in a different VPC connected via VPC peering or a transit gateway.
By default, no traffic is mirrored. Use [AWS::EC2::TrafficMirrorFilterRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorfilterrule.html) to specify filter rules that specify the traffic to mirror.
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"
cfnTrafficMirrorSession := awscdk.Aws_ec2.NewCfnTrafficMirrorSession(this, jsii.String("MyCfnTrafficMirrorSession"), &CfnTrafficMirrorSessionProps{
NetworkInterfaceId: jsii.String("networkInterfaceId"),
SessionNumber: jsii.Number(123),
TrafficMirrorFilterId: jsii.String("trafficMirrorFilterId"),
TrafficMirrorTargetId: jsii.String("trafficMirrorTargetId"),
// the properties below are optional
Description: jsii.String("description"),
PacketLength: jsii.Number(123),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
VirtualNetworkId: jsii.Number(123),
})
func NewCfnTrafficMirrorSession ¶
func NewCfnTrafficMirrorSession(scope constructs.Construct, id *string, props *CfnTrafficMirrorSessionProps) CfnTrafficMirrorSession
type CfnTrafficMirrorSessionProps ¶
type CfnTrafficMirrorSessionProps struct {
// The ID of the source network interface.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#cfn-ec2-trafficmirrorsession-networkinterfaceid
//
NetworkInterfaceId *string `field:"required" json:"networkInterfaceId" yaml:"networkInterfaceId"`
// The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions.
//
// The first session with a matching filter is the one that mirrors the packets.
//
// Valid values are 1-32766.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#cfn-ec2-trafficmirrorsession-sessionnumber
//
SessionNumber *float64 `field:"required" json:"sessionNumber" yaml:"sessionNumber"`
// The ID of the Traffic Mirror filter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#cfn-ec2-trafficmirrorsession-trafficmirrorfilterid
//
TrafficMirrorFilterId *string `field:"required" json:"trafficMirrorFilterId" yaml:"trafficMirrorFilterId"`
// The ID of the Traffic Mirror target.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#cfn-ec2-trafficmirrorsession-trafficmirrortargetid
//
TrafficMirrorTargetId *string `field:"required" json:"trafficMirrorTargetId" yaml:"trafficMirrorTargetId"`
// The description of the Traffic Mirror session.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#cfn-ec2-trafficmirrorsession-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// The number of bytes in each packet to mirror.
//
// These are bytes after the VXLAN header. Do not specify this parameter when you want to mirror the entire packet. To mirror a subset of the packet, set this to the length (in bytes) that you want to mirror. For example, if you set this value to 100, then the first 100 bytes that meet the filter criteria are copied to the target.
//
// If you do not want to mirror the entire packet, use the `PacketLength` parameter to specify the number of bytes in each packet to mirror.
//
// For sessions with Network Load Balancer (NLB) Traffic Mirror targets the default `PacketLength` will be set to 8500. Valid values are 1-8500. Setting a `PacketLength` greater than 8500 will result in an error response.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#cfn-ec2-trafficmirrorsession-packetlength
//
PacketLength *float64 `field:"optional" json:"packetLength" yaml:"packetLength"`
// The tags to assign to a Traffic Mirror session.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#cfn-ec2-trafficmirrorsession-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
// The VXLAN ID for the Traffic Mirror session.
//
// For more information about the VXLAN protocol, see [RFC 7348](https://docs.aws.amazon.com/https://datatracker.ietf.org/doc/html/rfc7348) . If you do not specify a `VirtualNetworkId` , an account-wide unique ID is chosen at random.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#cfn-ec2-trafficmirrorsession-virtualnetworkid
//
VirtualNetworkId *float64 `field:"optional" json:"virtualNetworkId" yaml:"virtualNetworkId"`
}
Properties for defining a `CfnTrafficMirrorSession`.
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"
cfnTrafficMirrorSessionProps := &CfnTrafficMirrorSessionProps{
NetworkInterfaceId: jsii.String("networkInterfaceId"),
SessionNumber: jsii.Number(123),
TrafficMirrorFilterId: jsii.String("trafficMirrorFilterId"),
TrafficMirrorTargetId: jsii.String("trafficMirrorTargetId"),
// the properties below are optional
Description: jsii.String("description"),
PacketLength: jsii.Number(123),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
VirtualNetworkId: jsii.Number(123),
}
type CfnTrafficMirrorTarget ¶
type CfnTrafficMirrorTarget interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggable
AttrId() *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 description of the Traffic Mirror target.
Description() *string
SetDescription(val *string)
// The ID of the Gateway Load Balancer endpoint.
GatewayLoadBalancerEndpointId() *string
SetGatewayLoadBalancerEndpointId(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 network interface ID that is associated with the target.
NetworkInterfaceId() *string
SetNetworkInterfaceId(val *string)
// The Amazon Resource Name (ARN) of the Network Load Balancer that is associated with the target.
NetworkLoadBalancerArn() *string
SetNetworkLoadBalancerArn(val *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
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
// The tags to assign to the Traffic Mirror target.
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{})
}
Specifies a target for your Traffic Mirror session.
A Traffic Mirror target is the destination for mirrored traffic. The Traffic Mirror source and the Traffic Mirror target (monitoring appliances) can be in the same VPC, or in different VPCs connected via VPC peering or a transit gateway.
A Traffic Mirror target can be a network interface, a Network Load Balancer, or a Gateway Load Balancer endpoint.
To use the target in a Traffic Mirror session, use [AWS::EC2::TrafficMirrorSession](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.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"
cfnTrafficMirrorTarget := awscdk.Aws_ec2.NewCfnTrafficMirrorTarget(this, jsii.String("MyCfnTrafficMirrorTarget"), &CfnTrafficMirrorTargetProps{
Description: jsii.String("description"),
GatewayLoadBalancerEndpointId: jsii.String("gatewayLoadBalancerEndpointId"),
NetworkInterfaceId: jsii.String("networkInterfaceId"),
NetworkLoadBalancerArn: jsii.String("networkLoadBalancerArn"),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
func NewCfnTrafficMirrorTarget ¶
func NewCfnTrafficMirrorTarget(scope constructs.Construct, id *string, props *CfnTrafficMirrorTargetProps) CfnTrafficMirrorTarget
type CfnTrafficMirrorTargetProps ¶
type CfnTrafficMirrorTargetProps struct {
// The description of the Traffic Mirror target.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrortarget.html#cfn-ec2-trafficmirrortarget-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// The ID of the Gateway Load Balancer endpoint.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrortarget.html#cfn-ec2-trafficmirrortarget-gatewayloadbalancerendpointid
//
GatewayLoadBalancerEndpointId *string `field:"optional" json:"gatewayLoadBalancerEndpointId" yaml:"gatewayLoadBalancerEndpointId"`
// The network interface ID that is associated with the target.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrortarget.html#cfn-ec2-trafficmirrortarget-networkinterfaceid
//
NetworkInterfaceId *string `field:"optional" json:"networkInterfaceId" yaml:"networkInterfaceId"`
// The Amazon Resource Name (ARN) of the Network Load Balancer that is associated with the target.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrortarget.html#cfn-ec2-trafficmirrortarget-networkloadbalancerarn
//
NetworkLoadBalancerArn *string `field:"optional" json:"networkLoadBalancerArn" yaml:"networkLoadBalancerArn"`
// The tags to assign to the Traffic Mirror target.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrortarget.html#cfn-ec2-trafficmirrortarget-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnTrafficMirrorTarget`.
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"
cfnTrafficMirrorTargetProps := &CfnTrafficMirrorTargetProps{
Description: jsii.String("description"),
GatewayLoadBalancerEndpointId: jsii.String("gatewayLoadBalancerEndpointId"),
NetworkInterfaceId: jsii.String("networkInterfaceId"),
NetworkLoadBalancerArn: jsii.String("networkLoadBalancerArn"),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
type CfnTransitGateway ¶
type CfnTransitGateway interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggable
// A private Autonomous System Number (ASN) for the Amazon side of a BGP session.
AmazonSideAsn() *float64
SetAmazonSideAsn(val *float64)
// The ID of the default association route table.
AssociationDefaultRouteTableId() *string
SetAssociationDefaultRouteTableId(val *string)
// The ID of the transit gateway.
AttrId() *string
AttrTransitGatewayArn() *string
// Enable or disable automatic acceptance of attachment requests.
// 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
// Enable or disable automatic association with the default association route table.
DefaultRouteTableAssociation() *string
SetDefaultRouteTableAssociation(val *string)
// Enable or disable automatic propagation of routes to the default propagation route table.
DefaultRouteTablePropagation() *string
SetDefaultRouteTablePropagation(val *string)
// The description of the transit gateway.
Description() *string
SetDescription(val *string)
// Enable or disable DNS support.
DnsSupport() *string
SetDnsSupport(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
// Indicates whether multicast is enabled on the transit gateway.
MulticastSupport() *string
SetMulticastSupport(val *string)
// The tree node.
Node() constructs.Node
// The ID of the default propagation route table.
PropagationDefaultRouteTableId() *string
SetPropagationDefaultRouteTableId(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
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
// The tags for the transit gateway.
TagsRaw() *[]*awscdk.CfnTag
SetTagsRaw(val *[]*awscdk.CfnTag)
// The transit gateway CIDR blocks.
TransitGatewayCidrBlocks() *[]*string
SetTransitGatewayCidrBlocks(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{}
// Enable or disable Equal Cost Multipath Protocol support.
VpnEcmpSupport() *string
SetVpnEcmpSupport(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{})
}
Specifies a transit gateway.
You can use a transit gateway to interconnect your virtual private clouds (VPC) and on-premises networks. After the transit gateway enters the `available` state, you can attach your VPCs and VPN connections to the transit gateway.
To attach your VPCs, use [AWS::EC2::TransitGatewayAttachment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayattachment.html) .
To attach a VPN connection, use [AWS::EC2::CustomerGateway](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customer-gateway.html) to create a customer gateway and specify the ID of the customer gateway and the ID of the transit gateway in a call to [AWS::EC2::VPNConnection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpn-connection.html) .
When you create a transit gateway, we create a default transit gateway route table and use it as the default association route table and the default propagation route table. You can use [AWS::EC2::TransitGatewayRouteTable](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroutetable.html) to create additional transit gateway route tables. If you disable automatic route propagation, we do not create a default transit gateway route table. You can use [AWS::EC2::TransitGatewayRouteTablePropagation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroutetablepropagation.html) to propagate routes from a resource attachment to a transit gateway route table. If you disable automatic associations, you can use [AWS::EC2::TransitGatewayRouteTableAssociation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroutetableassociation.html) to associate a resource attachment with a transit gateway route table.
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"
cfnTransitGateway := awscdk.Aws_ec2.NewCfnTransitGateway(this, jsii.String("MyCfnTransitGateway"), &CfnTransitGatewayProps{
AmazonSideAsn: jsii.Number(123),
AssociationDefaultRouteTableId: jsii.String("associationDefaultRouteTableId"),
AutoAcceptSharedAttachments: jsii.String("autoAcceptSharedAttachments"),
DefaultRouteTableAssociation: jsii.String("defaultRouteTableAssociation"),
DefaultRouteTablePropagation: jsii.String("defaultRouteTablePropagation"),
Description: jsii.String("description"),
DnsSupport: jsii.String("dnsSupport"),
MulticastSupport: jsii.String("multicastSupport"),
PropagationDefaultRouteTableId: jsii.String("propagationDefaultRouteTableId"),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
TransitGatewayCidrBlocks: []*string{
jsii.String("transitGatewayCidrBlocks"),
},
VpnEcmpSupport: jsii.String("vpnEcmpSupport"),
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html
func NewCfnTransitGateway ¶
func NewCfnTransitGateway(scope constructs.Construct, id *string, props *CfnTransitGatewayProps) CfnTransitGateway
type CfnTransitGatewayAttachment ¶
type CfnTransitGatewayAttachment interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggable
// The ID of the attachment.
AttrId() *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
// The VPC attachment options.
Options() interface{}
SetOptions(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
// The IDs of one or more subnets.
SubnetIds() *[]*string
SetSubnetIds(val *[]*string)
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
// The tags for the attachment.
TagsRaw() *[]*awscdk.CfnTag
SetTagsRaw(val *[]*awscdk.CfnTag)
// The ID of the transit gateway.
TransitGatewayId() *string
SetTransitGatewayId(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{}
// The ID of the VPC.
VpcId() *string
SetVpcId(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{})
}
Attaches a VPC to a transit gateway.
If you attach a VPC with a CIDR range that overlaps the CIDR range of a VPC that is already attached, the new VPC CIDR range is not propagated to the default propagation route table.
To send VPC traffic to an attached transit gateway, add a route to the VPC route table using [AWS::EC2::Route](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html) .
To update tags for a VPC attachment after creation without replacing the attachment, use [AWS::EC2::TransitGatewayVpcAttachment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayvpcattachment.html) instead.
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"
var options interface{}
cfnTransitGatewayAttachment := awscdk.Aws_ec2.NewCfnTransitGatewayAttachment(this, jsii.String("MyCfnTransitGatewayAttachment"), &CfnTransitGatewayAttachmentProps{
SubnetIds: []*string{
jsii.String("subnetIds"),
},
TransitGatewayId: jsii.String("transitGatewayId"),
VpcId: jsii.String("vpcId"),
// the properties below are optional
Options: options,
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
func NewCfnTransitGatewayAttachment ¶
func NewCfnTransitGatewayAttachment(scope constructs.Construct, id *string, props *CfnTransitGatewayAttachmentProps) CfnTransitGatewayAttachment
type CfnTransitGatewayAttachmentProps ¶
type CfnTransitGatewayAttachmentProps struct {
// The IDs of one or more subnets.
//
// You can specify only one subnet per Availability Zone. You must specify at least one subnet, but we recommend that you specify two subnets for better availability. The transit gateway uses one IP address from each specified subnet.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayattachment.html#cfn-ec2-transitgatewayattachment-subnetids
//
SubnetIds *[]*string `field:"required" json:"subnetIds" yaml:"subnetIds"`
// The ID of the transit gateway.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayattachment.html#cfn-ec2-transitgatewayattachment-transitgatewayid
//
TransitGatewayId *string `field:"required" json:"transitGatewayId" yaml:"transitGatewayId"`
// The ID of the VPC.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayattachment.html#cfn-ec2-transitgatewayattachment-vpcid
//
VpcId *string `field:"required" json:"vpcId" yaml:"vpcId"`
// The VPC attachment options.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayattachment.html#cfn-ec2-transitgatewayattachment-options
//
Options interface{} `field:"optional" json:"options" yaml:"options"`
// The tags for the attachment.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayattachment.html#cfn-ec2-transitgatewayattachment-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnTransitGatewayAttachment`.
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"
var options interface{}
cfnTransitGatewayAttachmentProps := &CfnTransitGatewayAttachmentProps{
SubnetIds: []*string{
jsii.String("subnetIds"),
},
TransitGatewayId: jsii.String("transitGatewayId"),
VpcId: jsii.String("vpcId"),
// the properties below are optional
Options: options,
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
type CfnTransitGatewayAttachment_OptionsProperty ¶ added in v2.55.0
type CfnTransitGatewayAttachment_OptionsProperty struct {
// Enable or disable appliance mode support.
//
// The default is `disable` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-transitgatewayattachment-options.html#cfn-ec2-transitgatewayattachment-options-appliancemodesupport
//
ApplianceModeSupport *string `field:"optional" json:"applianceModeSupport" yaml:"applianceModeSupport"`
// Enable or disable DNS support.
//
// The default is `disable` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-transitgatewayattachment-options.html#cfn-ec2-transitgatewayattachment-options-dnssupport
//
DnsSupport *string `field:"optional" json:"dnsSupport" yaml:"dnsSupport"`
// Enable or disable IPv6 support.
//
// The default is `disable` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-transitgatewayattachment-options.html#cfn-ec2-transitgatewayattachment-options-ipv6support
//
Ipv6Support *string `field:"optional" json:"ipv6Support" yaml:"ipv6Support"`
}
Describes the VPC attachment options.
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"
optionsProperty := &OptionsProperty{
ApplianceModeSupport: jsii.String("applianceModeSupport"),
DnsSupport: jsii.String("dnsSupport"),
Ipv6Support: jsii.String("ipv6Support"),
}
type CfnTransitGatewayConnect ¶
type CfnTransitGatewayConnect interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggable
// The creation time.
AttrCreationTime() *string
// The state of the attachment.
AttrState() *string
// The ID of the transit gateway attachment.
AttrTransitGatewayAttachmentId() *string
// The ID of the transit gateway.
AttrTransitGatewayId() *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
// The Connect attachment options.
Options() interface{}
SetOptions(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
// The tags for the attachment.
TagsRaw() *[]*awscdk.CfnTag
SetTagsRaw(val *[]*awscdk.CfnTag)
// The ID of the attachment from which the Connect attachment was created.
TransportTransitGatewayAttachmentId() *string
SetTransportTransitGatewayAttachmentId(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{})
}
Creates a Connect attachment from a specified transit gateway attachment.
A Connect attachment is a GRE-based tunnel attachment that you can use to establish a connection between a transit gateway and an appliance.
A Connect attachment uses an existing VPC or AWS Direct Connect attachment as the underlying transport mechanism.
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"
cfnTransitGatewayConnect := awscdk.Aws_ec2.NewCfnTransitGatewayConnect(this, jsii.String("MyCfnTransitGatewayConnect"), &CfnTransitGatewayConnectProps{
Options: &TransitGatewayConnectOptionsProperty{
Protocol: jsii.String("protocol"),
},
TransportTransitGatewayAttachmentId: jsii.String("transportTransitGatewayAttachmentId"),
// the properties below are optional
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
func NewCfnTransitGatewayConnect ¶
func NewCfnTransitGatewayConnect(scope constructs.Construct, id *string, props *CfnTransitGatewayConnectProps) CfnTransitGatewayConnect
type CfnTransitGatewayConnectProps ¶
type CfnTransitGatewayConnectProps struct {
// The Connect attachment options.
//
// - protocol (gre).
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayconnect.html#cfn-ec2-transitgatewayconnect-options
//
Options interface{} `field:"required" json:"options" yaml:"options"`
// The ID of the attachment from which the Connect attachment was created.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayconnect.html#cfn-ec2-transitgatewayconnect-transporttransitgatewayattachmentid
//
TransportTransitGatewayAttachmentId *string `field:"required" json:"transportTransitGatewayAttachmentId" yaml:"transportTransitGatewayAttachmentId"`
// The tags for the attachment.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayconnect.html#cfn-ec2-transitgatewayconnect-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnTransitGatewayConnect`.
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"
cfnTransitGatewayConnectProps := &CfnTransitGatewayConnectProps{
Options: &TransitGatewayConnectOptionsProperty{
Protocol: jsii.String("protocol"),
},
TransportTransitGatewayAttachmentId: jsii.String("transportTransitGatewayAttachmentId"),
// the properties below are optional
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
type CfnTransitGatewayConnect_TransitGatewayConnectOptionsProperty ¶
type CfnTransitGatewayConnect_TransitGatewayConnectOptionsProperty struct {
// The tunnel protocol.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-transitgatewayconnect-transitgatewayconnectoptions.html#cfn-ec2-transitgatewayconnect-transitgatewayconnectoptions-protocol
//
Protocol *string `field:"optional" json:"protocol" yaml:"protocol"`
}
Describes the Connect attachment options.
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"
transitGatewayConnectOptionsProperty := &TransitGatewayConnectOptionsProperty{
Protocol: jsii.String("protocol"),
}
type CfnTransitGatewayMulticastDomain ¶
type CfnTransitGatewayMulticastDomain interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggable
// The time the multicast domain was created.
AttrCreationTime() *string
// The state of the multicast domain.
AttrState() *string
// The Amazon Resource Name (ARN) of the multicast domain.
AttrTransitGatewayMulticastDomainArn() *string
// The ID of the multicast domain.
AttrTransitGatewayMulticastDomainId() *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
// The options for the transit gateway multicast domain.
Options() interface{}
SetOptions(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
// The tags for the transit gateway multicast domain.
TagsRaw() *[]*awscdk.CfnTag
SetTagsRaw(val *[]*awscdk.CfnTag)
// The ID of the transit gateway.
TransitGatewayId() *string
SetTransitGatewayId(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{})
}
Creates a multicast domain using the specified transit gateway.
The transit gateway must be in the available state before you create a domain.
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"
var options interface{}
cfnTransitGatewayMulticastDomain := awscdk.Aws_ec2.NewCfnTransitGatewayMulticastDomain(this, jsii.String("MyCfnTransitGatewayMulticastDomain"), &CfnTransitGatewayMulticastDomainProps{
TransitGatewayId: jsii.String("transitGatewayId"),
// the properties below are optional
Options: options,
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
func NewCfnTransitGatewayMulticastDomain ¶
func NewCfnTransitGatewayMulticastDomain(scope constructs.Construct, id *string, props *CfnTransitGatewayMulticastDomainProps) CfnTransitGatewayMulticastDomain
type CfnTransitGatewayMulticastDomainAssociation ¶
type CfnTransitGatewayMulticastDomainAssociation interface {
awscdk.CfnResource
awscdk.IInspectable
// The ID of the resource.
AttrResourceId() *string
// The type of resource, for example a VPC attachment.
AttrResourceType() *string
// The state of the resource.
AttrState() *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 IDs of the subnets to associate with the transit gateway multicast domain.
SubnetId() *string
SetSubnetId(val *string)
// The ID of the transit gateway attachment.
TransitGatewayAttachmentId() *string
SetTransitGatewayAttachmentId(val *string)
// The ID of the transit gateway multicast domain.
TransitGatewayMulticastDomainId() *string
SetTransitGatewayMulticastDomainId(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{})
}
Associates the specified subnets and transit gateway attachments with the specified transit gateway multicast domain.
The transit gateway attachment must be in the available state before you can add a resource.
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"
cfnTransitGatewayMulticastDomainAssociation := awscdk.Aws_ec2.NewCfnTransitGatewayMulticastDomainAssociation(this, jsii.String("MyCfnTransitGatewayMulticastDomainAssociation"), &CfnTransitGatewayMulticastDomainAssociationProps{
SubnetId: jsii.String("subnetId"),
TransitGatewayAttachmentId: jsii.String("transitGatewayAttachmentId"),
TransitGatewayMulticastDomainId: jsii.String("transitGatewayMulticastDomainId"),
})
func NewCfnTransitGatewayMulticastDomainAssociation ¶
func NewCfnTransitGatewayMulticastDomainAssociation(scope constructs.Construct, id *string, props *CfnTransitGatewayMulticastDomainAssociationProps) CfnTransitGatewayMulticastDomainAssociation
type CfnTransitGatewayMulticastDomainAssociationProps ¶
type CfnTransitGatewayMulticastDomainAssociationProps struct {
// The IDs of the subnets to associate with the transit gateway multicast domain.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastdomainassociation.html#cfn-ec2-transitgatewaymulticastdomainassociation-subnetid
//
SubnetId *string `field:"required" json:"subnetId" yaml:"subnetId"`
// The ID of the transit gateway attachment.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastdomainassociation.html#cfn-ec2-transitgatewaymulticastdomainassociation-transitgatewayattachmentid
//
TransitGatewayAttachmentId *string `field:"required" json:"transitGatewayAttachmentId" yaml:"transitGatewayAttachmentId"`
// The ID of the transit gateway multicast domain.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastdomainassociation.html#cfn-ec2-transitgatewaymulticastdomainassociation-transitgatewaymulticastdomainid
//
TransitGatewayMulticastDomainId *string `field:"required" json:"transitGatewayMulticastDomainId" yaml:"transitGatewayMulticastDomainId"`
}
Properties for defining a `CfnTransitGatewayMulticastDomainAssociation`.
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"
cfnTransitGatewayMulticastDomainAssociationProps := &CfnTransitGatewayMulticastDomainAssociationProps{
SubnetId: jsii.String("subnetId"),
TransitGatewayAttachmentId: jsii.String("transitGatewayAttachmentId"),
TransitGatewayMulticastDomainId: jsii.String("transitGatewayMulticastDomainId"),
}
type CfnTransitGatewayMulticastDomainProps ¶
type CfnTransitGatewayMulticastDomainProps struct {
// The ID of the transit gateway.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastdomain.html#cfn-ec2-transitgatewaymulticastdomain-transitgatewayid
//
TransitGatewayId *string `field:"required" json:"transitGatewayId" yaml:"transitGatewayId"`
// The options for the transit gateway multicast domain.
//
// - AutoAcceptSharedAssociations (enable | disable)
// - Igmpv2Support (enable | disable)
// - StaticSourcesSupport (enable | disable).
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastdomain.html#cfn-ec2-transitgatewaymulticastdomain-options
//
Options interface{} `field:"optional" json:"options" yaml:"options"`
// The tags for the transit gateway multicast domain.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastdomain.html#cfn-ec2-transitgatewaymulticastdomain-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnTransitGatewayMulticastDomain`.
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"
var options interface{}
cfnTransitGatewayMulticastDomainProps := &CfnTransitGatewayMulticastDomainProps{
TransitGatewayId: jsii.String("transitGatewayId"),
// the properties below are optional
Options: options,
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
type CfnTransitGatewayMulticastDomain_OptionsProperty ¶ added in v2.55.0
type CfnTransitGatewayMulticastDomain_OptionsProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-transitgatewaymulticastdomain-options.html#cfn-ec2-transitgatewaymulticastdomain-options-autoacceptsharedassociations
//
AutoAcceptSharedAssociations *string `field:"optional" json:"autoAcceptSharedAssociations" yaml:"autoAcceptSharedAssociations"`
// Specify whether to enable Internet Group Management Protocol (IGMP) version 2 for the transit gateway multicast domain.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-transitgatewaymulticastdomain-options.html#cfn-ec2-transitgatewaymulticastdomain-options-igmpv2support
//
Igmpv2Support *string `field:"optional" json:"igmpv2Support" yaml:"igmpv2Support"`
// Specify whether to enable support for statically configuring multicast group sources for a domain.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-transitgatewaymulticastdomain-options.html#cfn-ec2-transitgatewaymulticastdomain-options-staticsourcessupport
//
StaticSourcesSupport *string `field:"optional" json:"staticSourcesSupport" yaml:"staticSourcesSupport"`
}
The options for the transit gateway multicast domain.
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"
optionsProperty := &OptionsProperty{
AutoAcceptSharedAssociations: jsii.String("autoAcceptSharedAssociations"),
Igmpv2Support: jsii.String("igmpv2Support"),
StaticSourcesSupport: jsii.String("staticSourcesSupport"),
}
type CfnTransitGatewayMulticastGroupMember ¶
type CfnTransitGatewayMulticastGroupMember interface {
awscdk.CfnResource
awscdk.IInspectable
// Information about the registered transit gateway multicast domain group members.
AttrGroupMember() awscdk.IResolvable
// Indicates that the resource is a transit gateway multicast domain group member.
AttrGroupSource() awscdk.IResolvable
// The type of group member, for example static.
AttrMemberType() *string
// The ID of the resource.
AttrResourceId() *string
// The type of resource, for example a VPC attachment.
AttrResourceType() *string
AttrSourceType() *string
// The ID of the subnet.
AttrSubnetId() *string
// The ID of the transit gateway attachment.
AttrTransitGatewayAttachmentId() *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 IP address assigned to the transit gateway multicast group.
GroupIpAddress() *string
SetGroupIpAddress(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 group members' network interface IDs to register with the transit gateway multicast group.
NetworkInterfaceId() *string
SetNetworkInterfaceId(val *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 ID of the transit gateway multicast domain.
TransitGatewayMulticastDomainId() *string
SetTransitGatewayMulticastDomainId(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{})
}
Registers members (network interfaces) with the transit gateway multicast group.
A member is a network interface associated with a supported EC2 instance that receives multicast traffic. For information about supported instances, see [Multicast Consideration](https://docs.aws.amazon.com/vpc/latest/tgw/transit-gateway-limits.html#multicast-limits) in *Amazon VPC Transit Gateways* .
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"
cfnTransitGatewayMulticastGroupMember := awscdk.Aws_ec2.NewCfnTransitGatewayMulticastGroupMember(this, jsii.String("MyCfnTransitGatewayMulticastGroupMember"), &CfnTransitGatewayMulticastGroupMemberProps{
GroupIpAddress: jsii.String("groupIpAddress"),
NetworkInterfaceId: jsii.String("networkInterfaceId"),
TransitGatewayMulticastDomainId: jsii.String("transitGatewayMulticastDomainId"),
})
func NewCfnTransitGatewayMulticastGroupMember ¶
func NewCfnTransitGatewayMulticastGroupMember(scope constructs.Construct, id *string, props *CfnTransitGatewayMulticastGroupMemberProps) CfnTransitGatewayMulticastGroupMember
type CfnTransitGatewayMulticastGroupMemberProps ¶
type CfnTransitGatewayMulticastGroupMemberProps struct {
// The IP address assigned to the transit gateway multicast group.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastgroupmember.html#cfn-ec2-transitgatewaymulticastgroupmember-groupipaddress
//
GroupIpAddress *string `field:"required" json:"groupIpAddress" yaml:"groupIpAddress"`
// The group members' network interface IDs to register with the transit gateway multicast group.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastgroupmember.html#cfn-ec2-transitgatewaymulticastgroupmember-networkinterfaceid
//
NetworkInterfaceId *string `field:"required" json:"networkInterfaceId" yaml:"networkInterfaceId"`
// The ID of the transit gateway multicast domain.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastgroupmember.html#cfn-ec2-transitgatewaymulticastgroupmember-transitgatewaymulticastdomainid
//
TransitGatewayMulticastDomainId *string `field:"required" json:"transitGatewayMulticastDomainId" yaml:"transitGatewayMulticastDomainId"`
}
Properties for defining a `CfnTransitGatewayMulticastGroupMember`.
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"
cfnTransitGatewayMulticastGroupMemberProps := &CfnTransitGatewayMulticastGroupMemberProps{
GroupIpAddress: jsii.String("groupIpAddress"),
NetworkInterfaceId: jsii.String("networkInterfaceId"),
TransitGatewayMulticastDomainId: jsii.String("transitGatewayMulticastDomainId"),
}
type CfnTransitGatewayMulticastGroupSource ¶
type CfnTransitGatewayMulticastGroupSource interface {
awscdk.CfnResource
awscdk.IInspectable
// Information about the registered transit gateway multicast domain group members.
AttrGroupMember() awscdk.IResolvable
// Indicates that the resource is a transit gateway group member.
AttrGroupSource() awscdk.IResolvable
AttrMemberType() *string
// The ID of the resource.
AttrResourceId() *string
// The type of resource, for example a VPC attachment.
AttrResourceType() *string
// The type of source.
AttrSourceType() *string
// The ID of the subnet.
AttrSubnetId() *string
// The ID of the transit gateway attachment.
AttrTransitGatewayAttachmentId() *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 IP address assigned to the transit gateway multicast group.
GroupIpAddress() *string
SetGroupIpAddress(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 group sources' network interface IDs to register with the transit gateway multicast group.
NetworkInterfaceId() *string
SetNetworkInterfaceId(val *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 ID of the transit gateway multicast domain.
TransitGatewayMulticastDomainId() *string
SetTransitGatewayMulticastDomainId(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{})
}
Registers sources (network interfaces) with the specified transit gateway multicast domain.
A multicast source is a network interface attached to a supported instance that sends multicast traffic. For information about supported instances, see [Multicast Considerations](https://docs.aws.amazon.com/vpc/latest/tgw/transit-gateway-limits.html#multicast-limits) in *Amazon VPC Transit Gateways* .
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"
cfnTransitGatewayMulticastGroupSource := awscdk.Aws_ec2.NewCfnTransitGatewayMulticastGroupSource(this, jsii.String("MyCfnTransitGatewayMulticastGroupSource"), &CfnTransitGatewayMulticastGroupSourceProps{
GroupIpAddress: jsii.String("groupIpAddress"),
NetworkInterfaceId: jsii.String("networkInterfaceId"),
TransitGatewayMulticastDomainId: jsii.String("transitGatewayMulticastDomainId"),
})
func NewCfnTransitGatewayMulticastGroupSource ¶
func NewCfnTransitGatewayMulticastGroupSource(scope constructs.Construct, id *string, props *CfnTransitGatewayMulticastGroupSourceProps) CfnTransitGatewayMulticastGroupSource
type CfnTransitGatewayMulticastGroupSourceProps ¶
type CfnTransitGatewayMulticastGroupSourceProps struct {
// The IP address assigned to the transit gateway multicast group.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastgroupsource.html#cfn-ec2-transitgatewaymulticastgroupsource-groupipaddress
//
GroupIpAddress *string `field:"required" json:"groupIpAddress" yaml:"groupIpAddress"`
// The group sources' network interface IDs to register with the transit gateway multicast group.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastgroupsource.html#cfn-ec2-transitgatewaymulticastgroupsource-networkinterfaceid
//
NetworkInterfaceId *string `field:"required" json:"networkInterfaceId" yaml:"networkInterfaceId"`
// The ID of the transit gateway multicast domain.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastgroupsource.html#cfn-ec2-transitgatewaymulticastgroupsource-transitgatewaymulticastdomainid
//
TransitGatewayMulticastDomainId *string `field:"required" json:"transitGatewayMulticastDomainId" yaml:"transitGatewayMulticastDomainId"`
}
Properties for defining a `CfnTransitGatewayMulticastGroupSource`.
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"
cfnTransitGatewayMulticastGroupSourceProps := &CfnTransitGatewayMulticastGroupSourceProps{
GroupIpAddress: jsii.String("groupIpAddress"),
NetworkInterfaceId: jsii.String("networkInterfaceId"),
TransitGatewayMulticastDomainId: jsii.String("transitGatewayMulticastDomainId"),
}
type CfnTransitGatewayPeeringAttachment ¶
type CfnTransitGatewayPeeringAttachment interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggable
// The time the transit gateway peering attachment was created.
AttrCreationTime() *string
// The state of the transit gateway peering attachment.
//
// Note that the `initiating` state has been deprecated.
AttrState() *string
AttrStatus() awscdk.IResolvable
AttrStatusCode() *string
AttrStatusMessage() *string
// The ID of the transit gateway peering attachment.
AttrTransitGatewayAttachmentId() *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
// The ID of the AWS account that owns the transit gateway.
PeerAccountId() *string
SetPeerAccountId(val *string)
// The Region of the transit gateway.
PeerRegion() *string
SetPeerRegion(val *string)
// The ID of the transit gateway.
PeerTransitGatewayId() *string
SetPeerTransitGatewayId(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
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
// The tags for the transit gateway peering attachment.
TagsRaw() *[]*awscdk.CfnTag
SetTagsRaw(val *[]*awscdk.CfnTag)
// The ID of the transit gateway peering attachment.
TransitGatewayId() *string
SetTransitGatewayId(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{})
}
Requests a transit gateway peering attachment between the specified transit gateway (requester) and a peer transit gateway (accepter).
The peer transit gateway can be in your account or a different AWS account .
After you create the peering attachment, the owner of the accepter transit gateway must accept the attachment request.
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"
cfnTransitGatewayPeeringAttachment := awscdk.Aws_ec2.NewCfnTransitGatewayPeeringAttachment(this, jsii.String("MyCfnTransitGatewayPeeringAttachment"), &CfnTransitGatewayPeeringAttachmentProps{
PeerAccountId: jsii.String("peerAccountId"),
PeerRegion: jsii.String("peerRegion"),
PeerTransitGatewayId: jsii.String("peerTransitGatewayId"),
TransitGatewayId: jsii.String("transitGatewayId"),
// the properties below are optional
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
func NewCfnTransitGatewayPeeringAttachment ¶
func NewCfnTransitGatewayPeeringAttachment(scope constructs.Construct, id *string, props *CfnTransitGatewayPeeringAttachmentProps) CfnTransitGatewayPeeringAttachment
type CfnTransitGatewayPeeringAttachmentProps ¶
type CfnTransitGatewayPeeringAttachmentProps struct {
// The ID of the AWS account that owns the transit gateway.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaypeeringattachment.html#cfn-ec2-transitgatewaypeeringattachment-peeraccountid
//
PeerAccountId *string `field:"required" json:"peerAccountId" yaml:"peerAccountId"`
// The Region of the transit gateway.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaypeeringattachment.html#cfn-ec2-transitgatewaypeeringattachment-peerregion
//
PeerRegion *string `field:"required" json:"peerRegion" yaml:"peerRegion"`
// The ID of the transit gateway.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaypeeringattachment.html#cfn-ec2-transitgatewaypeeringattachment-peertransitgatewayid
//
PeerTransitGatewayId *string `field:"required" json:"peerTransitGatewayId" yaml:"peerTransitGatewayId"`
// The ID of the transit gateway peering attachment.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaypeeringattachment.html#cfn-ec2-transitgatewaypeeringattachment-transitgatewayid
//
TransitGatewayId *string `field:"required" json:"transitGatewayId" yaml:"transitGatewayId"`
// The tags for the transit gateway peering attachment.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaypeeringattachment.html#cfn-ec2-transitgatewaypeeringattachment-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnTransitGatewayPeeringAttachment`.
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"
cfnTransitGatewayPeeringAttachmentProps := &CfnTransitGatewayPeeringAttachmentProps{
PeerAccountId: jsii.String("peerAccountId"),
PeerRegion: jsii.String("peerRegion"),
PeerTransitGatewayId: jsii.String("peerTransitGatewayId"),
TransitGatewayId: jsii.String("transitGatewayId"),
// the properties below are optional
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
type CfnTransitGatewayPeeringAttachment_PeeringAttachmentStatusProperty ¶ added in v2.55.0
type CfnTransitGatewayPeeringAttachment_PeeringAttachmentStatusProperty struct {
// The status code.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-transitgatewaypeeringattachment-peeringattachmentstatus.html#cfn-ec2-transitgatewaypeeringattachment-peeringattachmentstatus-code
//
Code *string `field:"optional" json:"code" yaml:"code"`
// The status message, if applicable.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-transitgatewaypeeringattachment-peeringattachmentstatus.html#cfn-ec2-transitgatewaypeeringattachment-peeringattachmentstatus-message
//
Message *string `field:"optional" json:"message" yaml:"message"`
}
The status of the transit gateway peering attachment.
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"
peeringAttachmentStatusProperty := &PeeringAttachmentStatusProperty{
Code: jsii.String("code"),
Message: jsii.String("message"),
}
type CfnTransitGatewayProps ¶
type CfnTransitGatewayProps struct {
// A private Autonomous System Number (ASN) for the Amazon side of a BGP session.
//
// The range is 64512 to 65534 for 16-bit ASNs. The default is 64512.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html#cfn-ec2-transitgateway-amazonsideasn
//
AmazonSideAsn *float64 `field:"optional" json:"amazonSideAsn" yaml:"amazonSideAsn"`
// The ID of the default association route table.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html#cfn-ec2-transitgateway-associationdefaultroutetableid
//
AssociationDefaultRouteTableId *string `field:"optional" json:"associationDefaultRouteTableId" yaml:"associationDefaultRouteTableId"`
//
// Disabled by default.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html#cfn-ec2-transitgateway-autoacceptsharedattachments
//
AutoAcceptSharedAttachments *string `field:"optional" json:"autoAcceptSharedAttachments" yaml:"autoAcceptSharedAttachments"`
// Enable or disable automatic association with the default association route table.
//
// Enabled by default.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html#cfn-ec2-transitgateway-defaultroutetableassociation
//
DefaultRouteTableAssociation *string `field:"optional" json:"defaultRouteTableAssociation" yaml:"defaultRouteTableAssociation"`
// Enable or disable automatic propagation of routes to the default propagation route table.
//
// Enabled by default.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html#cfn-ec2-transitgateway-defaultroutetablepropagation
//
DefaultRouteTablePropagation *string `field:"optional" json:"defaultRouteTablePropagation" yaml:"defaultRouteTablePropagation"`
// The description of the transit gateway.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html#cfn-ec2-transitgateway-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// Enable or disable DNS support.
//
// Enabled by default.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html#cfn-ec2-transitgateway-dnssupport
//
DnsSupport *string `field:"optional" json:"dnsSupport" yaml:"dnsSupport"`
// Indicates whether multicast is enabled on the transit gateway.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html#cfn-ec2-transitgateway-multicastsupport
//
MulticastSupport *string `field:"optional" json:"multicastSupport" yaml:"multicastSupport"`
// The ID of the default propagation route table.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html#cfn-ec2-transitgateway-propagationdefaultroutetableid
//
PropagationDefaultRouteTableId *string `field:"optional" json:"propagationDefaultRouteTableId" yaml:"propagationDefaultRouteTableId"`
// The tags for the transit gateway.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html#cfn-ec2-transitgateway-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
// The transit gateway CIDR blocks.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html#cfn-ec2-transitgateway-transitgatewaycidrblocks
//
TransitGatewayCidrBlocks *[]*string `field:"optional" json:"transitGatewayCidrBlocks" yaml:"transitGatewayCidrBlocks"`
// Enable or disable Equal Cost Multipath Protocol support.
//
// Enabled by default.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html#cfn-ec2-transitgateway-vpnecmpsupport
//
VpnEcmpSupport *string `field:"optional" json:"vpnEcmpSupport" yaml:"vpnEcmpSupport"`
}
Properties for defining a `CfnTransitGateway`.
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"
cfnTransitGatewayProps := &CfnTransitGatewayProps{
AmazonSideAsn: jsii.Number(123),
AssociationDefaultRouteTableId: jsii.String("associationDefaultRouteTableId"),
AutoAcceptSharedAttachments: jsii.String("autoAcceptSharedAttachments"),
DefaultRouteTableAssociation: jsii.String("defaultRouteTableAssociation"),
DefaultRouteTablePropagation: jsii.String("defaultRouteTablePropagation"),
Description: jsii.String("description"),
DnsSupport: jsii.String("dnsSupport"),
MulticastSupport: jsii.String("multicastSupport"),
PropagationDefaultRouteTableId: jsii.String("propagationDefaultRouteTableId"),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
TransitGatewayCidrBlocks: []*string{
jsii.String("transitGatewayCidrBlocks"),
},
VpnEcmpSupport: jsii.String("vpnEcmpSupport"),
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html
type CfnTransitGatewayRoute ¶
type CfnTransitGatewayRoute interface {
awscdk.CfnResource
awscdk.IInspectable
// Indicates whether to drop traffic that matches this route.
Blackhole() interface{}
SetBlackhole(val interface{})
// 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 CIDR block used for destination matches.
DestinationCidrBlock() *string
SetDestinationCidrBlock(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
// The ID of the attachment.
TransitGatewayAttachmentId() *string
SetTransitGatewayAttachmentId(val *string)
// The ID of the transit gateway route table.
TransitGatewayRouteTableId() *string
SetTransitGatewayRouteTableId(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{})
}
Specifies a static route for a transit gateway route table.
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"
cfnTransitGatewayRoute := awscdk.Aws_ec2.NewCfnTransitGatewayRoute(this, jsii.String("MyCfnTransitGatewayRoute"), &CfnTransitGatewayRouteProps{
DestinationCidrBlock: jsii.String("destinationCidrBlock"),
TransitGatewayRouteTableId: jsii.String("transitGatewayRouteTableId"),
// the properties below are optional
Blackhole: jsii.Boolean(false),
TransitGatewayAttachmentId: jsii.String("transitGatewayAttachmentId"),
})
func NewCfnTransitGatewayRoute ¶
func NewCfnTransitGatewayRoute(scope constructs.Construct, id *string, props *CfnTransitGatewayRouteProps) CfnTransitGatewayRoute
type CfnTransitGatewayRouteProps ¶
type CfnTransitGatewayRouteProps struct {
// The CIDR block used for destination matches.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroute.html#cfn-ec2-transitgatewayroute-destinationcidrblock
//
DestinationCidrBlock *string `field:"required" json:"destinationCidrBlock" yaml:"destinationCidrBlock"`
// The ID of the transit gateway route table.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroute.html#cfn-ec2-transitgatewayroute-transitgatewayroutetableid
//
TransitGatewayRouteTableId *string `field:"required" json:"transitGatewayRouteTableId" yaml:"transitGatewayRouteTableId"`
// Indicates whether to drop traffic that matches this route.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroute.html#cfn-ec2-transitgatewayroute-blackhole
//
Blackhole interface{} `field:"optional" json:"blackhole" yaml:"blackhole"`
// The ID of the attachment.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroute.html#cfn-ec2-transitgatewayroute-transitgatewayattachmentid
//
TransitGatewayAttachmentId *string `field:"optional" json:"transitGatewayAttachmentId" yaml:"transitGatewayAttachmentId"`
}
Properties for defining a `CfnTransitGatewayRoute`.
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"
cfnTransitGatewayRouteProps := &CfnTransitGatewayRouteProps{
DestinationCidrBlock: jsii.String("destinationCidrBlock"),
TransitGatewayRouteTableId: jsii.String("transitGatewayRouteTableId"),
// the properties below are optional
Blackhole: jsii.Boolean(false),
TransitGatewayAttachmentId: jsii.String("transitGatewayAttachmentId"),
}
type CfnTransitGatewayRouteTable ¶
type CfnTransitGatewayRouteTable interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggable
// The ID of the transit gateway route table.
AttrTransitGatewayRouteTableId() *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
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
// Any tags assigned to the route table.
TagsRaw() *[]*awscdk.CfnTag
SetTagsRaw(val *[]*awscdk.CfnTag)
// The ID of the transit gateway.
TransitGatewayId() *string
SetTransitGatewayId(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{})
}
Specifies a route table for a transit gateway.
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"
cfnTransitGatewayRouteTable := awscdk.Aws_ec2.NewCfnTransitGatewayRouteTable(this, jsii.String("MyCfnTransitGatewayRouteTable"), &CfnTransitGatewayRouteTableProps{
TransitGatewayId: jsii.String("transitGatewayId"),
// the properties below are optional
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
func NewCfnTransitGatewayRouteTable ¶
func NewCfnTransitGatewayRouteTable(scope constructs.Construct, id *string, props *CfnTransitGatewayRouteTableProps) CfnTransitGatewayRouteTable
type CfnTransitGatewayRouteTableAssociation ¶
type CfnTransitGatewayRouteTableAssociation interface {
awscdk.CfnResource
awscdk.IInspectable
// 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 ID of the attachment.
TransitGatewayAttachmentId() *string
SetTransitGatewayAttachmentId(val *string)
// The ID of the route table for the transit gateway.
TransitGatewayRouteTableId() *string
SetTransitGatewayRouteTableId(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{})
}
Associates the specified attachment with the specified transit gateway route table.
You can associate one route table with an attachment.
Before you can update the route table associated with an attachment, you must disassociate the transit gateway route table that is currently associated with the attachment. First update the stack to remove the associated transit gateway route table, and then update the stack with the ID of the new transit gateway route table to associate.
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"
cfnTransitGatewayRouteTableAssociation := awscdk.Aws_ec2.NewCfnTransitGatewayRouteTableAssociation(this, jsii.String("MyCfnTransitGatewayRouteTableAssociation"), &CfnTransitGatewayRouteTableAssociationProps{
TransitGatewayAttachmentId: jsii.String("transitGatewayAttachmentId"),
TransitGatewayRouteTableId: jsii.String("transitGatewayRouteTableId"),
})
func NewCfnTransitGatewayRouteTableAssociation ¶
func NewCfnTransitGatewayRouteTableAssociation(scope constructs.Construct, id *string, props *CfnTransitGatewayRouteTableAssociationProps) CfnTransitGatewayRouteTableAssociation
type CfnTransitGatewayRouteTableAssociationProps ¶
type CfnTransitGatewayRouteTableAssociationProps struct {
// The ID of the attachment.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroutetableassociation.html#cfn-ec2-transitgatewayroutetableassociation-transitgatewayattachmentid
//
TransitGatewayAttachmentId *string `field:"required" json:"transitGatewayAttachmentId" yaml:"transitGatewayAttachmentId"`
// The ID of the route table for the transit gateway.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroutetableassociation.html#cfn-ec2-transitgatewayroutetableassociation-transitgatewayroutetableid
//
TransitGatewayRouteTableId *string `field:"required" json:"transitGatewayRouteTableId" yaml:"transitGatewayRouteTableId"`
}
Properties for defining a `CfnTransitGatewayRouteTableAssociation`.
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"
cfnTransitGatewayRouteTableAssociationProps := &CfnTransitGatewayRouteTableAssociationProps{
TransitGatewayAttachmentId: jsii.String("transitGatewayAttachmentId"),
TransitGatewayRouteTableId: jsii.String("transitGatewayRouteTableId"),
}
type CfnTransitGatewayRouteTablePropagation ¶
type CfnTransitGatewayRouteTablePropagation interface {
awscdk.CfnResource
awscdk.IInspectable
// 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 ID of the attachment.
TransitGatewayAttachmentId() *string
SetTransitGatewayAttachmentId(val *string)
// The ID of the propagation route table.
TransitGatewayRouteTableId() *string
SetTransitGatewayRouteTableId(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{})
}
Enables the specified attachment to propagate routes to the specified propagation route table.
For more information about enabling transit gateway route propagation, see [EnableTransitGatewayRouteTablePropagation](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_EnableTransitGatewayRouteTablePropagation.html) in the *Amazon EC2 API Reference* .
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"
cfnTransitGatewayRouteTablePropagation := awscdk.Aws_ec2.NewCfnTransitGatewayRouteTablePropagation(this, jsii.String("MyCfnTransitGatewayRouteTablePropagation"), &CfnTransitGatewayRouteTablePropagationProps{
TransitGatewayAttachmentId: jsii.String("transitGatewayAttachmentId"),
TransitGatewayRouteTableId: jsii.String("transitGatewayRouteTableId"),
})
func NewCfnTransitGatewayRouteTablePropagation ¶
func NewCfnTransitGatewayRouteTablePropagation(scope constructs.Construct, id *string, props *CfnTransitGatewayRouteTablePropagationProps) CfnTransitGatewayRouteTablePropagation
type CfnTransitGatewayRouteTablePropagationProps ¶
type CfnTransitGatewayRouteTablePropagationProps struct {
// The ID of the attachment.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroutetablepropagation.html#cfn-ec2-transitgatewayroutetablepropagation-transitgatewayattachmentid
//
TransitGatewayAttachmentId *string `field:"required" json:"transitGatewayAttachmentId" yaml:"transitGatewayAttachmentId"`
// The ID of the propagation route table.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroutetablepropagation.html#cfn-ec2-transitgatewayroutetablepropagation-transitgatewayroutetableid
//
TransitGatewayRouteTableId *string `field:"required" json:"transitGatewayRouteTableId" yaml:"transitGatewayRouteTableId"`
}
Properties for defining a `CfnTransitGatewayRouteTablePropagation`.
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"
cfnTransitGatewayRouteTablePropagationProps := &CfnTransitGatewayRouteTablePropagationProps{
TransitGatewayAttachmentId: jsii.String("transitGatewayAttachmentId"),
TransitGatewayRouteTableId: jsii.String("transitGatewayRouteTableId"),
}
type CfnTransitGatewayRouteTableProps ¶
type CfnTransitGatewayRouteTableProps struct {
// The ID of the transit gateway.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroutetable.html#cfn-ec2-transitgatewayroutetable-transitgatewayid
//
TransitGatewayId *string `field:"required" json:"transitGatewayId" yaml:"transitGatewayId"`
// Any tags assigned to the route table.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroutetable.html#cfn-ec2-transitgatewayroutetable-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnTransitGatewayRouteTable`.
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"
cfnTransitGatewayRouteTableProps := &CfnTransitGatewayRouteTableProps{
TransitGatewayId: jsii.String("transitGatewayId"),
// the properties below are optional
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
type CfnTransitGatewayVpcAttachment ¶
type CfnTransitGatewayVpcAttachment interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggable
// The IDs of one or more subnets to add.
AddSubnetIds() *[]*string
SetAddSubnetIds(val *[]*string)
// The ID of the attachment.
AttrId() *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
// The VPC attachment options.
Options() interface{}
SetOptions(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 IDs of one or more subnets to remove.
RemoveSubnetIds() *[]*string
SetRemoveSubnetIds(val *[]*string)
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// The IDs of the subnets.
SubnetIds() *[]*string
SetSubnetIds(val *[]*string)
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
// The tags for the VPC attachment.
TagsRaw() *[]*awscdk.CfnTag
SetTagsRaw(val *[]*awscdk.CfnTag)
// The ID of the transit gateway.
TransitGatewayId() *string
SetTransitGatewayId(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{}
// The ID of the VPC.
VpcId() *string
SetVpcId(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{})
}
Specifies a VPC attachment.
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"
var options interface{}
cfnTransitGatewayVpcAttachment := awscdk.Aws_ec2.NewCfnTransitGatewayVpcAttachment(this, jsii.String("MyCfnTransitGatewayVpcAttachment"), &CfnTransitGatewayVpcAttachmentProps{
SubnetIds: []*string{
jsii.String("subnetIds"),
},
TransitGatewayId: jsii.String("transitGatewayId"),
VpcId: jsii.String("vpcId"),
// the properties below are optional
AddSubnetIds: []*string{
jsii.String("addSubnetIds"),
},
Options: options,
RemoveSubnetIds: []*string{
jsii.String("removeSubnetIds"),
},
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
func NewCfnTransitGatewayVpcAttachment ¶
func NewCfnTransitGatewayVpcAttachment(scope constructs.Construct, id *string, props *CfnTransitGatewayVpcAttachmentProps) CfnTransitGatewayVpcAttachment
type CfnTransitGatewayVpcAttachmentProps ¶
type CfnTransitGatewayVpcAttachmentProps struct {
// The IDs of the subnets.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayvpcattachment.html#cfn-ec2-transitgatewayvpcattachment-subnetids
//
SubnetIds *[]*string `field:"required" json:"subnetIds" yaml:"subnetIds"`
// The ID of the transit gateway.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayvpcattachment.html#cfn-ec2-transitgatewayvpcattachment-transitgatewayid
//
TransitGatewayId *string `field:"required" json:"transitGatewayId" yaml:"transitGatewayId"`
// The ID of the VPC.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayvpcattachment.html#cfn-ec2-transitgatewayvpcattachment-vpcid
//
VpcId *string `field:"required" json:"vpcId" yaml:"vpcId"`
// The IDs of one or more subnets to add.
//
// You can specify at most one subnet per Availability Zone.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayvpcattachment.html#cfn-ec2-transitgatewayvpcattachment-addsubnetids
//
AddSubnetIds *[]*string `field:"optional" json:"addSubnetIds" yaml:"addSubnetIds"`
// The VPC attachment options.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayvpcattachment.html#cfn-ec2-transitgatewayvpcattachment-options
//
Options interface{} `field:"optional" json:"options" yaml:"options"`
// The IDs of one or more subnets to remove.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayvpcattachment.html#cfn-ec2-transitgatewayvpcattachment-removesubnetids
//
RemoveSubnetIds *[]*string `field:"optional" json:"removeSubnetIds" yaml:"removeSubnetIds"`
// The tags for the VPC attachment.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayvpcattachment.html#cfn-ec2-transitgatewayvpcattachment-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnTransitGatewayVpcAttachment`.
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"
var options interface{}
cfnTransitGatewayVpcAttachmentProps := &CfnTransitGatewayVpcAttachmentProps{
SubnetIds: []*string{
jsii.String("subnetIds"),
},
TransitGatewayId: jsii.String("transitGatewayId"),
VpcId: jsii.String("vpcId"),
// the properties below are optional
AddSubnetIds: []*string{
jsii.String("addSubnetIds"),
},
Options: options,
RemoveSubnetIds: []*string{
jsii.String("removeSubnetIds"),
},
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
type CfnTransitGatewayVpcAttachment_OptionsProperty ¶ added in v2.55.0
type CfnTransitGatewayVpcAttachment_OptionsProperty struct {
// Enable or disable appliance mode support.
//
// The default is `disable` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-transitgatewayvpcattachment-options.html#cfn-ec2-transitgatewayvpcattachment-options-appliancemodesupport
//
ApplianceModeSupport *string `field:"optional" json:"applianceModeSupport" yaml:"applianceModeSupport"`
// Enable or disable DNS support.
//
// The default is `disable` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-transitgatewayvpcattachment-options.html#cfn-ec2-transitgatewayvpcattachment-options-dnssupport
//
DnsSupport *string `field:"optional" json:"dnsSupport" yaml:"dnsSupport"`
// Enable or disable IPv6 support.
//
// The default is `disable` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-transitgatewayvpcattachment-options.html#cfn-ec2-transitgatewayvpcattachment-options-ipv6support
//
Ipv6Support *string `field:"optional" json:"ipv6Support" yaml:"ipv6Support"`
}
Describes the VPC attachment options.
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"
optionsProperty := &OptionsProperty{
ApplianceModeSupport: jsii.String("applianceModeSupport"),
DnsSupport: jsii.String("dnsSupport"),
Ipv6Support: jsii.String("ipv6Support"),
}
type CfnVPC ¶
type CfnVPC interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggable
// The primary IPv4 CIDR block for the VPC.
//
// For example, 10.0.0.0/16.
AttrCidrBlock() *string
// The association IDs of the IPv4 CIDR blocks for the VPC.
//
// For example, [ vpc-cidr-assoc-0280ab6b ].
AttrCidrBlockAssociations() *[]*string
// The ID of the default network ACL for the VPC.
//
// For example, acl-814dafe3.
AttrDefaultNetworkAcl() *string
// The ID of the default security group for the VPC.
//
// For example, sg-b178e0d3.
AttrDefaultSecurityGroup() *string
// The IPv6 CIDR blocks for the VPC.
//
// For example, [ 2001:db8:1234:1a00::/56 ].
AttrIpv6CidrBlocks() *[]*string
// The ID of the VPC.
AttrVpcId() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// The IPv4 network range for the VPC, in CIDR notation.
CidrBlock() *string
SetCidrBlock(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
// Indicates whether the instances launched in the VPC get DNS hostnames.
EnableDnsHostnames() interface{}
SetEnableDnsHostnames(val interface{})
// Indicates whether the DNS resolution is supported for the VPC.
EnableDnsSupport() interface{}
SetEnableDnsSupport(val interface{})
// The allowed tenancy of instances launched into the VPC.
InstanceTenancy() *string
SetInstanceTenancy(val *string)
// The ID of an IPv4 IPAM pool you want to use for allocating this VPC's CIDR.
Ipv4IpamPoolId() *string
SetIpv4IpamPoolId(val *string)
// The netmask length of the IPv4 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool.
Ipv4NetmaskLength() *float64
SetIpv4NetmaskLength(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 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
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
// The tags for the VPC.
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{})
}
Specifies a virtual private cloud (VPC).
To add an IPv6 CIDR block to the VPC, see [AWS::EC2::VPCCidrBlock](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html) .
For more information, see [Virtual private clouds (VPC)](https://docs.aws.amazon.com/vpc/latest/userguide/configure-your-vpc.html) in the *Amazon VPC User Guide* .
Example:
var cfnTemplate cfnInclude
// using from*Attributes()
var privateCfnSubnet1 cfnSubnet
var privateCfnSubnet2 cfnSubnet
// using from*Name()
cfnBucket := cfnTemplate.GetResource(jsii.String("Bucket")).(cfnBucket)
bucket := s3.Bucket_FromBucketName(this, jsii.String("L2Bucket"), cfnBucket.ref)
// using from*Arn()
cfnKey := cfnTemplate.GetResource(jsii.String("Key")).(cfnKey)
key := kms.Key_FromKeyArn(this, jsii.String("L2Key"), cfnKey.AttrArn)
cfnVpc := cfnTemplate.GetResource(jsii.String("Vpc")).(cfnVPC)
vpc := ec2.Vpc_FromVpcAttributes(this, jsii.String("L2Vpc"), &VpcAttributes{
VpcId: cfnVpc.ref,
AvailabilityZones: core.Fn_GetAzs(),
PrivateSubnetIds: []*string{
privateCfnSubnet1.ref,
privateCfnSubnet2.ref,
},
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html
func NewCfnVPC ¶
func NewCfnVPC(scope constructs.Construct, id *string, props *CfnVPCProps) CfnVPC
type CfnVPCCidrBlock ¶
type CfnVPCCidrBlock interface {
awscdk.CfnResource
awscdk.IInspectable
// Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC.
AmazonProvidedIpv6CidrBlock() interface{}
SetAmazonProvidedIpv6CidrBlock(val interface{})
// The Id of the VPC associated CIDR Block.
AttrId() *string
// The source that allocated the IP address space.
//
// `byoip` or `amazon` indicates public IP address space allocated by Amazon or space that you have allocated with Bring your own IP (BYOIP). `none` indicates private space.
AttrIpSource() *string
// Public IPv6 addresses are those advertised on the internet from AWS .
//
// Private IP addresses are not and cannot be advertised on the internet from AWS .
AttrIpv6AddressAttribute() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// An IPv4 CIDR block to associate with the VPC.
CidrBlock() *string
SetCidrBlock(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
// Associate a CIDR allocated from an IPv4 IPAM pool to a VPC.
Ipv4IpamPoolId() *string
SetIpv4IpamPoolId(val *string)
// The netmask length of the IPv4 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool.
Ipv4NetmaskLength() *float64
SetIpv4NetmaskLength(val *float64)
// An IPv6 CIDR block from the IPv6 address pool.
//
// You must also specify `Ipv6Pool` in the request.
Ipv6CidrBlock() *string
SetIpv6CidrBlock(val *string)
// Associates a CIDR allocated from an IPv6 IPAM pool to a VPC.
Ipv6IpamPoolId() *string
SetIpv6IpamPoolId(val *string)
// The netmask length of the IPv6 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool.
Ipv6NetmaskLength() *float64
SetIpv6NetmaskLength(val *float64)
// The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block.
Ipv6Pool() *string
SetIpv6Pool(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{}
// The ID of the VPC.
VpcId() *string
SetVpcId(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{})
}
Associates a CIDR block with your VPC.
You can optionally request an IPv6 CIDR block for the VPC. You can request an Amazon-provided IPv6 CIDR block from Amazon's pool of IPv6 addresses, or an IPv6 CIDR block from an IPv6 address pool that you provisioned through bring your own IP addresses (BYOIP).
For more information, see [VPC CIDR blocks](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-cidr-blocks.html) in the *Amazon VPC User Guide* .
Example:
var vpc vpc
func associateSubnetWithV6Cidr(vpc *vpc, count *f64, subnet iSubnet) {
cfnSubnet := *subnet.Node.defaultChild.(cfnSubnet)
cfnSubnet.Ipv6CidrBlock = awscdk.Fn_Select(count, awscdk.Fn_Cidr(awscdk.Fn_Select(jsii.Number(0), vpc.VpcIpv6CidrBlocks), jsii.Number(256), (jsii.Number(128 - 64)).toString()))
cfnSubnet.AssignIpv6AddressOnCreation = true
}
// make an ipv6 cidr
ipv6cidr := ec2.NewCfnVPCCidrBlock(this, jsii.String("CIDR6"), &CfnVPCCidrBlockProps{
VpcId: vpc.VpcId,
AmazonProvidedIpv6CidrBlock: jsii.Boolean(true),
})
// connect the ipv6 cidr to all vpc subnets
subnetcount := 0
subnets := vpc.PublicSubnets.concat(vpc.PrivateSubnets)
for _, subnet := range subnets {
// Wait for the ipv6 cidr to complete
subnet.Node.AddDependency(ipv6cidr)
associateSubnetWithV6Cidr(vpc, subnetcount, subnet)
subnetcount = subnetcount + 1
}
cluster := eks.NewCluster(this, jsii.String("hello-eks"), &ClusterProps{
Version: eks.KubernetesVersion_V1_30(),
Vpc: vpc,
IpFamily: eks.IpFamily_IP_V6,
VpcSubnets: []subnetSelection{
&subnetSelection{
Subnets: vpc.*PublicSubnets,
},
},
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html
func NewCfnVPCCidrBlock ¶
func NewCfnVPCCidrBlock(scope constructs.Construct, id *string, props *CfnVPCCidrBlockProps) CfnVPCCidrBlock
type CfnVPCCidrBlockProps ¶
type CfnVPCCidrBlockProps struct {
// The ID of the VPC.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html#cfn-ec2-vpccidrblock-vpcid
//
VpcId *string `field:"required" json:"vpcId" yaml:"vpcId"`
// Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC.
//
// You cannot specify the range of IPv6 addresses or the size of the CIDR block.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html#cfn-ec2-vpccidrblock-amazonprovidedipv6cidrblock
//
AmazonProvidedIpv6CidrBlock interface{} `field:"optional" json:"amazonProvidedIpv6CidrBlock" yaml:"amazonProvidedIpv6CidrBlock"`
// An IPv4 CIDR block to associate with the VPC.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html#cfn-ec2-vpccidrblock-cidrblock
//
CidrBlock *string `field:"optional" json:"cidrBlock" yaml:"cidrBlock"`
// Associate a CIDR allocated from an IPv4 IPAM pool to a VPC.
//
// For more information about Amazon VPC IP Address Manager (IPAM), see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html#cfn-ec2-vpccidrblock-ipv4ipampoolid
//
Ipv4IpamPoolId *string `field:"optional" json:"ipv4IpamPoolId" yaml:"ipv4IpamPoolId"`
// The netmask length of the IPv4 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool.
//
// For more information about IPAM, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html#cfn-ec2-vpccidrblock-ipv4netmasklength
//
Ipv4NetmaskLength *float64 `field:"optional" json:"ipv4NetmaskLength" yaml:"ipv4NetmaskLength"`
// An IPv6 CIDR block from the IPv6 address pool. You must also specify `Ipv6Pool` in the request.
//
// To let Amazon choose the IPv6 CIDR block for you, omit this parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html#cfn-ec2-vpccidrblock-ipv6cidrblock
//
Ipv6CidrBlock *string `field:"optional" json:"ipv6CidrBlock" yaml:"ipv6CidrBlock"`
// Associates a CIDR allocated from an IPv6 IPAM pool to a VPC.
//
// For more information about Amazon VPC IP Address Manager (IPAM), see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html#cfn-ec2-vpccidrblock-ipv6ipampoolid
//
Ipv6IpamPoolId *string `field:"optional" json:"ipv6IpamPoolId" yaml:"ipv6IpamPoolId"`
// The netmask length of the IPv6 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool.
//
// For more information about IPAM, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html#cfn-ec2-vpccidrblock-ipv6netmasklength
//
Ipv6NetmaskLength *float64 `field:"optional" json:"ipv6NetmaskLength" yaml:"ipv6NetmaskLength"`
// The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html#cfn-ec2-vpccidrblock-ipv6pool
//
Ipv6Pool *string `field:"optional" json:"ipv6Pool" yaml:"ipv6Pool"`
}
Properties for defining a `CfnVPCCidrBlock`.
Example:
var vpc vpc
func associateSubnetWithV6Cidr(vpc *vpc, count *f64, subnet iSubnet) {
cfnSubnet := *subnet.Node.defaultChild.(cfnSubnet)
cfnSubnet.Ipv6CidrBlock = awscdk.Fn_Select(count, awscdk.Fn_Cidr(awscdk.Fn_Select(jsii.Number(0), vpc.VpcIpv6CidrBlocks), jsii.Number(256), (jsii.Number(128 - 64)).toString()))
cfnSubnet.AssignIpv6AddressOnCreation = true
}
// make an ipv6 cidr
ipv6cidr := ec2.NewCfnVPCCidrBlock(this, jsii.String("CIDR6"), &CfnVPCCidrBlockProps{
VpcId: vpc.VpcId,
AmazonProvidedIpv6CidrBlock: jsii.Boolean(true),
})
// connect the ipv6 cidr to all vpc subnets
subnetcount := 0
subnets := vpc.PublicSubnets.concat(vpc.PrivateSubnets)
for _, subnet := range subnets {
// Wait for the ipv6 cidr to complete
subnet.Node.AddDependency(ipv6cidr)
associateSubnetWithV6Cidr(vpc, subnetcount, subnet)
subnetcount = subnetcount + 1
}
cluster := eks.NewCluster(this, jsii.String("hello-eks"), &ClusterProps{
Version: eks.KubernetesVersion_V1_30(),
Vpc: vpc,
IpFamily: eks.IpFamily_IP_V6,
VpcSubnets: []subnetSelection{
&subnetSelection{
Subnets: vpc.*PublicSubnets,
},
},
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html
type CfnVPCDHCPOptionsAssociation ¶
type CfnVPCDHCPOptionsAssociation interface {
awscdk.CfnResource
awscdk.IInspectable
// 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 ID of the DHCP options set, or `default` to associate no DHCP options with the VPC.
DhcpOptionsId() *string
SetDhcpOptionsId(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{}
// The ID of the VPC.
VpcId() *string
SetVpcId(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{})
}
Associates a set of DHCP options with a VPC, or associates no DHCP options with the VPC.
After you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. You don't need to restart or relaunch the instances. They automatically pick up the changes within a few hours, depending on how frequently the instance renews its DHCP lease. You can explicitly renew the lease using the operating system on 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"
cfnVPCDHCPOptionsAssociation := awscdk.Aws_ec2.NewCfnVPCDHCPOptionsAssociation(this, jsii.String("MyCfnVPCDHCPOptionsAssociation"), &CfnVPCDHCPOptionsAssociationProps{
DhcpOptionsId: jsii.String("dhcpOptionsId"),
VpcId: jsii.String("vpcId"),
})
func NewCfnVPCDHCPOptionsAssociation ¶
func NewCfnVPCDHCPOptionsAssociation(scope constructs.Construct, id *string, props *CfnVPCDHCPOptionsAssociationProps) CfnVPCDHCPOptionsAssociation
type CfnVPCDHCPOptionsAssociationProps ¶
type CfnVPCDHCPOptionsAssociationProps struct {
// The ID of the DHCP options set, or `default` to associate no DHCP options with the VPC.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcdhcpoptionsassociation.html#cfn-ec2-vpcdhcpoptionsassociation-dhcpoptionsid
//
DhcpOptionsId *string `field:"required" json:"dhcpOptionsId" yaml:"dhcpOptionsId"`
// The ID of the VPC.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcdhcpoptionsassociation.html#cfn-ec2-vpcdhcpoptionsassociation-vpcid
//
VpcId *string `field:"required" json:"vpcId" yaml:"vpcId"`
}
Properties for defining a `CfnVPCDHCPOptionsAssociation`.
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"
cfnVPCDHCPOptionsAssociationProps := &CfnVPCDHCPOptionsAssociationProps{
DhcpOptionsId: jsii.String("dhcpOptionsId"),
VpcId: jsii.String("vpcId"),
}
type CfnVPCEndpoint ¶
type CfnVPCEndpoint interface {
awscdk.CfnResource
awscdk.IInspectable
// The date and time the VPC endpoint was created.
//
// For example: `Fri Sep 28 23:34:36 UTC 2018.`
AttrCreationTimestamp() *string
// (Interface endpoints) The DNS entries for the endpoint.
//
// Each entry is a combination of the hosted zone ID and the DNS name. The entries are ordered as follows: regional public DNS, zonal public DNS, private DNS, and wildcard DNS. This order is not enforced for AWS Marketplace services.
//
// The following is an example. In the first entry, the hosted zone ID is Z1HUB23UULQXV and the DNS name is vpce-01abc23456de78f9g-12abccd3.ec2.us-east-1.vpce.amazonaws.com.
//
// ["Z1HUB23UULQXV:vpce-01abc23456de78f9g-12abccd3.ec2.us-east-1.vpce.amazonaws.com", "Z1HUB23UULQXV:vpce-01abc23456de78f9g-12abccd3-us-east-1a.ec2.us-east-1.vpce.amazonaws.com", "Z1C12344VYDITB0:ec2.us-east-1.amazonaws.com"]
//
// If you update the `PrivateDnsEnabled` or `SubnetIds` properties, the DNS entries in the list will change.
AttrDnsEntries() *[]*string
// The ID of the VPC endpoint.
AttrId() *string
// (Interface endpoints) The network interface IDs.
//
// If you update the `PrivateDnsEnabled` or `SubnetIds` properties, the items in this list might change.
AttrNetworkInterfaceIds() *[]*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
// An endpoint policy, which controls access to the service from the VPC.
PolicyDocument() interface{}
SetPolicyDocument(val interface{})
// Indicate whether to associate a private hosted zone with the specified VPC.
PrivateDnsEnabled() interface{}
SetPrivateDnsEnabled(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 IDs of the route tables.
RouteTableIds() *[]*string
SetRouteTableIds(val *[]*string)
// The IDs of the security groups to associate with the endpoint network interfaces.
SecurityGroupIds() *[]*string
SetSecurityGroupIds(val *[]*string)
// The name of the endpoint 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
// The IDs of the subnets in which to create endpoint network interfaces.
SubnetIds() *[]*string
SetSubnetIds(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{}
// The type of endpoint.
VpcEndpointType() *string
SetVpcEndpointType(val *string)
// The ID of the VPC.
VpcId() *string
SetVpcId(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{})
}
Specifies a VPC endpoint.
A VPC endpoint provides a private connection between your VPC and an endpoint service. You can use an endpoint service provided by AWS , an AWS Marketplace Partner, or another AWS accounts in your organization. For more information, see the [AWS PrivateLink User Guide](https://docs.aws.amazon.com/vpc/latest/privatelink/) .
An endpoint of type `Interface` establishes connections between the subnets in your VPC and an AWS service , your own service, or a service hosted by another AWS account . With an interface VPC endpoint, you specify the subnets in which to create the endpoint and the security groups to associate with the endpoint network interfaces.
An endpoint of type `gateway` serves as a target for a route in your route table for traffic destined for Amazon S3 or DynamoDB . You can specify an endpoint policy for the endpoint, which controls access to the service from your VPC. You can also specify the VPC route tables that use the endpoint. For more information about connectivity to Amazon S3 , see [Why can't I connect to an S3 bucket using a gateway VPC endpoint?](https://docs.aws.amazon.com/premiumsupport/knowledge-center/connect-s3-vpc-endpoint)
An endpoint of type `GatewayLoadBalancer` provides private connectivity between your VPC and virtual appliances from a service provider.
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"
var policyDocument interface{}
cfnVPCEndpoint := awscdk.Aws_ec2.NewCfnVPCEndpoint(this, jsii.String("MyCfnVPCEndpoint"), &CfnVPCEndpointProps{
ServiceName: jsii.String("serviceName"),
VpcId: jsii.String("vpcId"),
// the properties below are optional
PolicyDocument: policyDocument,
PrivateDnsEnabled: jsii.Boolean(false),
RouteTableIds: []*string{
jsii.String("routeTableIds"),
},
SecurityGroupIds: []*string{
jsii.String("securityGroupIds"),
},
SubnetIds: []*string{
jsii.String("subnetIds"),
},
VpcEndpointType: jsii.String("vpcEndpointType"),
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html
func NewCfnVPCEndpoint ¶
func NewCfnVPCEndpoint(scope constructs.Construct, id *string, props *CfnVPCEndpointProps) CfnVPCEndpoint
type CfnVPCEndpointConnectionNotification ¶
type CfnVPCEndpointConnectionNotification interface {
awscdk.CfnResource
awscdk.IInspectable
// The ID of the notification.
AttrVpcEndpointConnectionNotificationId() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// The endpoint events for which to receive notifications.
ConnectionEvents() *[]*string
SetConnectionEvents(val *[]*string)
// The ARN of the SNS topic for the notifications.
ConnectionNotificationArn() *string
SetConnectionNotificationArn(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 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 ID of the endpoint service.
ServiceId() *string
SetServiceId(val *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{}
// The ID of the endpoint.
VpcEndpointId() *string
SetVpcEndpointId(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{})
}
Specifies a connection notification for a VPC endpoint or VPC endpoint service.
A connection notification notifies you of specific endpoint events. You must create an SNS topic to receive notifications. For more information, see [Create a Topic](https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html) in the *Amazon Simple Notification Service Developer Guide* .
You can create a connection notification for interface endpoints only.
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"
cfnVPCEndpointConnectionNotification := awscdk.Aws_ec2.NewCfnVPCEndpointConnectionNotification(this, jsii.String("MyCfnVPCEndpointConnectionNotification"), &CfnVPCEndpointConnectionNotificationProps{
ConnectionEvents: []*string{
jsii.String("connectionEvents"),
},
ConnectionNotificationArn: jsii.String("connectionNotificationArn"),
// the properties below are optional
ServiceId: jsii.String("serviceId"),
VpcEndpointId: jsii.String("vpcEndpointId"),
})
func NewCfnVPCEndpointConnectionNotification ¶
func NewCfnVPCEndpointConnectionNotification(scope constructs.Construct, id *string, props *CfnVPCEndpointConnectionNotificationProps) CfnVPCEndpointConnectionNotification
type CfnVPCEndpointConnectionNotificationProps ¶
type CfnVPCEndpointConnectionNotificationProps struct {
// The endpoint events for which to receive notifications.
//
// Valid values are `Accept` , `Connect` , `Delete` , and `Reject` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointconnectionnotification.html#cfn-ec2-vpcendpointconnectionnotification-connectionevents
//
ConnectionEvents *[]*string `field:"required" json:"connectionEvents" yaml:"connectionEvents"`
// The ARN of the SNS topic for the notifications.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointconnectionnotification.html#cfn-ec2-vpcendpointconnectionnotification-connectionnotificationarn
//
ConnectionNotificationArn *string `field:"required" json:"connectionNotificationArn" yaml:"connectionNotificationArn"`
// The ID of the endpoint service.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointconnectionnotification.html#cfn-ec2-vpcendpointconnectionnotification-serviceid
//
ServiceId *string `field:"optional" json:"serviceId" yaml:"serviceId"`
// The ID of the endpoint.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointconnectionnotification.html#cfn-ec2-vpcendpointconnectionnotification-vpcendpointid
//
VpcEndpointId *string `field:"optional" json:"vpcEndpointId" yaml:"vpcEndpointId"`
}
Properties for defining a `CfnVPCEndpointConnectionNotification`.
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"
cfnVPCEndpointConnectionNotificationProps := &CfnVPCEndpointConnectionNotificationProps{
ConnectionEvents: []*string{
jsii.String("connectionEvents"),
},
ConnectionNotificationArn: jsii.String("connectionNotificationArn"),
// the properties below are optional
ServiceId: jsii.String("serviceId"),
VpcEndpointId: jsii.String("vpcEndpointId"),
}
type CfnVPCEndpointProps ¶
type CfnVPCEndpointProps struct {
// The name of the endpoint service.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-servicename
//
ServiceName *string `field:"required" json:"serviceName" yaml:"serviceName"`
// The ID of the VPC.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-vpcid
//
VpcId *string `field:"required" json:"vpcId" yaml:"vpcId"`
// An endpoint policy, which controls access to the service from the VPC.
//
// The default endpoint policy allows full access to the service. Endpoint policies are supported only for gateway and interface endpoints.
//
// For CloudFormation templates in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation converts YAML policies to JSON format before calling the API to create or modify the VPC endpoint.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-policydocument
//
PolicyDocument interface{} `field:"optional" json:"policyDocument" yaml:"policyDocument"`
// Indicate whether to associate a private hosted zone with the specified VPC.
//
// The private hosted zone contains a record set for the default public DNS name for the service for the Region (for example, `kinesis.us-east-1.amazonaws.com` ), which resolves to the private IP addresses of the endpoint network interfaces in the VPC. This enables you to make requests to the default public DNS name for the service instead of the public DNS names that are automatically generated by the VPC endpoint service.
//
// To use a private hosted zone, you must set the following VPC attributes to `true` : `enableDnsHostnames` and `enableDnsSupport` .
//
// This property is supported only for interface endpoints.
//
// Default: `false`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-privatednsenabled
//
PrivateDnsEnabled interface{} `field:"optional" json:"privateDnsEnabled" yaml:"privateDnsEnabled"`
// The IDs of the route tables.
//
// Routing is supported only for gateway endpoints.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-routetableids
//
RouteTableIds *[]*string `field:"optional" json:"routeTableIds" yaml:"routeTableIds"`
// The IDs of the security groups to associate with the endpoint network interfaces.
//
// If this parameter is not specified, we use the default security group for the VPC. Security groups are supported only for interface endpoints.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-securitygroupids
//
SecurityGroupIds *[]*string `field:"optional" json:"securityGroupIds" yaml:"securityGroupIds"`
// The IDs of the subnets in which to create endpoint network interfaces.
//
// You must specify this property for an interface endpoint or a Gateway Load Balancer endpoint. You can't specify this property for a gateway endpoint. For a Gateway Load Balancer endpoint, you can specify only one subnet.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-subnetids
//
SubnetIds *[]*string `field:"optional" json:"subnetIds" yaml:"subnetIds"`
// The type of endpoint.
//
// Default: Gateway.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-vpcendpointtype
//
VpcEndpointType *string `field:"optional" json:"vpcEndpointType" yaml:"vpcEndpointType"`
}
Properties for defining a `CfnVPCEndpoint`.
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"
var policyDocument interface{}
cfnVPCEndpointProps := &CfnVPCEndpointProps{
ServiceName: jsii.String("serviceName"),
VpcId: jsii.String("vpcId"),
// the properties below are optional
PolicyDocument: policyDocument,
PrivateDnsEnabled: jsii.Boolean(false),
RouteTableIds: []*string{
jsii.String("routeTableIds"),
},
SecurityGroupIds: []*string{
jsii.String("securityGroupIds"),
},
SubnetIds: []*string{
jsii.String("subnetIds"),
},
VpcEndpointType: jsii.String("vpcEndpointType"),
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html
type CfnVPCEndpointService ¶
type CfnVPCEndpointService interface {
awscdk.CfnResource
awscdk.IInspectable
// Indicates whether requests from service consumers to create an endpoint to your service must be accepted.
AcceptanceRequired() interface{}
SetAcceptanceRequired(val interface{})
// The ID of the endpoint service.
AttrServiceId() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// Indicates whether to enable the built-in Contributor Insights rules provided by AWS PrivateLink .
ContributorInsightsEnabled() interface{}
SetContributorInsightsEnabled(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
// The Amazon Resource Names (ARNs) of the Gateway Load Balancers.
GatewayLoadBalancerArns() *[]*string
SetGatewayLoadBalancerArns(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 Amazon Resource Names (ARNs) of the Network Load Balancers.
NetworkLoadBalancerArns() *[]*string
SetNetworkLoadBalancerArns(val *[]*string)
// The tree node.
Node() constructs.Node
// The entity that is responsible for the endpoint costs.
PayerResponsibility() *string
SetPayerResponsibility(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
// 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{})
}
Creates a VPC endpoint service configuration to which service consumers ( AWS accounts, users, and IAM roles) can connect.
To create an endpoint service configuration, you must first create one of the following for your service:
- A [Network Load Balancer](https://docs.aws.amazon.com/elasticloadbalancing/latest/network/introduction.html) . Service consumers connect to your service using an interface endpoint. - A [Gateway Load Balancer](https://docs.aws.amazon.com/elasticloadbalancing/latest/gateway/introduction.html) . Service consumers connect to your service using a Gateway Load Balancer endpoint.
For more information, see the [AWS PrivateLink User Guide](https://docs.aws.amazon.com/vpc/latest/privatelink/) .
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"
cfnVPCEndpointService := awscdk.Aws_ec2.NewCfnVPCEndpointService(this, jsii.String("MyCfnVPCEndpointService"), &CfnVPCEndpointServiceProps{
AcceptanceRequired: jsii.Boolean(false),
ContributorInsightsEnabled: jsii.Boolean(false),
GatewayLoadBalancerArns: []*string{
jsii.String("gatewayLoadBalancerArns"),
},
NetworkLoadBalancerArns: []*string{
jsii.String("networkLoadBalancerArns"),
},
PayerResponsibility: jsii.String("payerResponsibility"),
})
func NewCfnVPCEndpointService ¶
func NewCfnVPCEndpointService(scope constructs.Construct, id *string, props *CfnVPCEndpointServiceProps) CfnVPCEndpointService
type CfnVPCEndpointServicePermissions ¶
type CfnVPCEndpointServicePermissions interface {
awscdk.CfnResource
awscdk.IInspectable
// The Amazon Resource Names (ARN) of one or more principals (for example, users, IAM roles, and AWS accounts ).
AllowedPrincipals() *[]*string
SetAllowedPrincipals(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
// 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 ID of the service.
ServiceId() *string
SetServiceId(val *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{})
}
Grant or revoke permissions for service consumers (users, IAM roles, and AWS accounts) to connect to a VPC endpoint service.
If you grant permissions to all principals, the service is public. Any users who know the name of a public service can send a request to attach an endpoint. If the service does not require manual approval, attachments are automatically approved.
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"
cfnVPCEndpointServicePermissions := awscdk.Aws_ec2.NewCfnVPCEndpointServicePermissions(this, jsii.String("MyCfnVPCEndpointServicePermissions"), &CfnVPCEndpointServicePermissionsProps{
ServiceId: jsii.String("serviceId"),
// the properties below are optional
AllowedPrincipals: []*string{
jsii.String("allowedPrincipals"),
},
})
func NewCfnVPCEndpointServicePermissions ¶
func NewCfnVPCEndpointServicePermissions(scope constructs.Construct, id *string, props *CfnVPCEndpointServicePermissionsProps) CfnVPCEndpointServicePermissions
type CfnVPCEndpointServicePermissionsProps ¶
type CfnVPCEndpointServicePermissionsProps struct {
// The ID of the service.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointservicepermissions.html#cfn-ec2-vpcendpointservicepermissions-serviceid
//
ServiceId *string `field:"required" json:"serviceId" yaml:"serviceId"`
// The Amazon Resource Names (ARN) of one or more principals (for example, users, IAM roles, and AWS accounts ).
//
// Permissions are granted to the principals in this list. To grant permissions to all principals, specify an asterisk (*). Permissions are revoked for principals not in this list. If the list is empty, then all permissions are revoked.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointservicepermissions.html#cfn-ec2-vpcendpointservicepermissions-allowedprincipals
//
AllowedPrincipals *[]*string `field:"optional" json:"allowedPrincipals" yaml:"allowedPrincipals"`
}
Properties for defining a `CfnVPCEndpointServicePermissions`.
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"
cfnVPCEndpointServicePermissionsProps := &CfnVPCEndpointServicePermissionsProps{
ServiceId: jsii.String("serviceId"),
// the properties below are optional
AllowedPrincipals: []*string{
jsii.String("allowedPrincipals"),
},
}
type CfnVPCEndpointServiceProps ¶
type CfnVPCEndpointServiceProps struct {
// Indicates whether requests from service consumers to create an endpoint to your service must be accepted.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointservice.html#cfn-ec2-vpcendpointservice-acceptancerequired
//
AcceptanceRequired interface{} `field:"optional" json:"acceptanceRequired" yaml:"acceptanceRequired"`
// Indicates whether to enable the built-in Contributor Insights rules provided by AWS PrivateLink .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointservice.html#cfn-ec2-vpcendpointservice-contributorinsightsenabled
//
ContributorInsightsEnabled interface{} `field:"optional" json:"contributorInsightsEnabled" yaml:"contributorInsightsEnabled"`
// The Amazon Resource Names (ARNs) of the Gateway Load Balancers.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointservice.html#cfn-ec2-vpcendpointservice-gatewayloadbalancerarns
//
GatewayLoadBalancerArns *[]*string `field:"optional" json:"gatewayLoadBalancerArns" yaml:"gatewayLoadBalancerArns"`
// The Amazon Resource Names (ARNs) of the Network Load Balancers.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointservice.html#cfn-ec2-vpcendpointservice-networkloadbalancerarns
//
NetworkLoadBalancerArns *[]*string `field:"optional" json:"networkLoadBalancerArns" yaml:"networkLoadBalancerArns"`
// The entity that is responsible for the endpoint costs.
//
// The default is the endpoint owner. If you set the payer responsibility to the service owner, you cannot set it back to the endpoint owner.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointservice.html#cfn-ec2-vpcendpointservice-payerresponsibility
//
PayerResponsibility *string `field:"optional" json:"payerResponsibility" yaml:"payerResponsibility"`
}
Properties for defining a `CfnVPCEndpointService`.
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"
cfnVPCEndpointServiceProps := &CfnVPCEndpointServiceProps{
AcceptanceRequired: jsii.Boolean(false),
ContributorInsightsEnabled: jsii.Boolean(false),
GatewayLoadBalancerArns: []*string{
jsii.String("gatewayLoadBalancerArns"),
},
NetworkLoadBalancerArns: []*string{
jsii.String("networkLoadBalancerArns"),
},
PayerResponsibility: jsii.String("payerResponsibility"),
}
type CfnVPCGatewayAttachment ¶
type CfnVPCGatewayAttachment interface {
awscdk.CfnResource
awscdk.IInspectable
// Used to identify if this resource is an Internet Gateway or Vpn Gateway Attachment.
AttrAttachmentType() *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 ID of the internet gateway.
InternetGatewayId() *string
SetInternetGatewayId(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{}
// The ID of the VPC.
VpcId() *string
SetVpcId(val *string)
// The ID of the virtual private gateway.
VpnGatewayId() *string
SetVpnGatewayId(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{})
}
Attaches an internet gateway, or a virtual private gateway to a VPC, enabling connectivity between the internet and the VPC.
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"
cfnVPCGatewayAttachment := awscdk.Aws_ec2.NewCfnVPCGatewayAttachment(this, jsii.String("MyCfnVPCGatewayAttachment"), &CfnVPCGatewayAttachmentProps{
VpcId: jsii.String("vpcId"),
// the properties below are optional
InternetGatewayId: jsii.String("internetGatewayId"),
VpnGatewayId: jsii.String("vpnGatewayId"),
})
func NewCfnVPCGatewayAttachment ¶
func NewCfnVPCGatewayAttachment(scope constructs.Construct, id *string, props *CfnVPCGatewayAttachmentProps) CfnVPCGatewayAttachment
type CfnVPCGatewayAttachmentProps ¶
type CfnVPCGatewayAttachmentProps struct {
// The ID of the VPC.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcgatewayattachment.html#cfn-ec2-vpcgatewayattachment-vpcid
//
VpcId *string `field:"required" json:"vpcId" yaml:"vpcId"`
// The ID of the internet gateway.
//
// You must specify either `InternetGatewayId` or `VpnGatewayId` , but not both.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcgatewayattachment.html#cfn-ec2-vpcgatewayattachment-internetgatewayid
//
InternetGatewayId *string `field:"optional" json:"internetGatewayId" yaml:"internetGatewayId"`
// The ID of the virtual private gateway.
//
// You must specify either `InternetGatewayId` or `VpnGatewayId` , but not both.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcgatewayattachment.html#cfn-ec2-vpcgatewayattachment-vpngatewayid
//
VpnGatewayId *string `field:"optional" json:"vpnGatewayId" yaml:"vpnGatewayId"`
}
Properties for defining a `CfnVPCGatewayAttachment`.
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"
cfnVPCGatewayAttachmentProps := &CfnVPCGatewayAttachmentProps{
VpcId: jsii.String("vpcId"),
// the properties below are optional
InternetGatewayId: jsii.String("internetGatewayId"),
VpnGatewayId: jsii.String("vpnGatewayId"),
}
type CfnVPCPeeringConnection ¶
type CfnVPCPeeringConnection interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggable
// The ID of the peering connection.
AttrId() *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
// The AWS account ID of the owner of the accepter VPC.
PeerOwnerId() *string
SetPeerOwnerId(val *string)
// The Region code for the accepter VPC, if the accepter VPC is located in a Region other than the Region in which you make the request.
PeerRegion() *string
SetPeerRegion(val *string)
// The Amazon Resource Name (ARN) of the VPC peer role for the peering connection in another AWS account.
PeerRoleArn() *string
SetPeerRoleArn(val *string)
// The ID of the VPC with which you are creating the VPC peering connection.
PeerVpcId() *string
SetPeerVpcId(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
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
// Any tags assigned to the 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 ID of the VPC.
VpcId() *string
SetVpcId(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{})
}
Requests a VPC peering connection between two VPCs: a requester VPC that you own and an accepter VPC with which to create the connection.
The accepter VPC can belong to a different AWS account and can be in a different Region than the requester VPC.
The requester VPC and accepter VPC cannot have overlapping CIDR blocks. If you create a VPC peering connection request between VPCs with overlapping CIDR blocks, the VPC peering connection has a status of `failed` .
If the VPCs belong to different accounts, the acceptor account must have a role that allows the requester account to accept the VPC peering connection. For more information, see [Walkthough: Peer with a VPC in another AWS account](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/peer-with-vpc-in-another-account.html) .
If the requester and acceptor VPCs are in the same account, the peering request is accepted without a peering role.
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"
cfnVPCPeeringConnection := awscdk.Aws_ec2.NewCfnVPCPeeringConnection(this, jsii.String("MyCfnVPCPeeringConnection"), &CfnVPCPeeringConnectionProps{
PeerVpcId: jsii.String("peerVpcId"),
VpcId: jsii.String("vpcId"),
// the properties below are optional
PeerOwnerId: jsii.String("peerOwnerId"),
PeerRegion: jsii.String("peerRegion"),
PeerRoleArn: jsii.String("peerRoleArn"),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
func NewCfnVPCPeeringConnection ¶
func NewCfnVPCPeeringConnection(scope constructs.Construct, id *string, props *CfnVPCPeeringConnectionProps) CfnVPCPeeringConnection
type CfnVPCPeeringConnectionProps ¶
type CfnVPCPeeringConnectionProps struct {
// The ID of the VPC with which you are creating the VPC peering connection.
//
// You must specify this parameter in the request.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcpeeringconnection.html#cfn-ec2-vpcpeeringconnection-peervpcid
//
PeerVpcId *string `field:"required" json:"peerVpcId" yaml:"peerVpcId"`
// The ID of the VPC.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcpeeringconnection.html#cfn-ec2-vpcpeeringconnection-vpcid
//
VpcId *string `field:"required" json:"vpcId" yaml:"vpcId"`
// The AWS account ID of the owner of the accepter VPC.
//
// Default: Your AWS account ID.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcpeeringconnection.html#cfn-ec2-vpcpeeringconnection-peerownerid
//
PeerOwnerId *string `field:"optional" json:"peerOwnerId" yaml:"peerOwnerId"`
// The Region code for the accepter VPC, if the accepter VPC is located in a Region other than the Region in which you make the request.
//
// Default: The Region in which you make the request.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcpeeringconnection.html#cfn-ec2-vpcpeeringconnection-peerregion
//
PeerRegion *string `field:"optional" json:"peerRegion" yaml:"peerRegion"`
// The Amazon Resource Name (ARN) of the VPC peer role for the peering connection in another AWS account.
//
// This is required when you are peering a VPC in a different AWS account.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcpeeringconnection.html#cfn-ec2-vpcpeeringconnection-peerrolearn
//
PeerRoleArn *string `field:"optional" json:"peerRoleArn" yaml:"peerRoleArn"`
// Any tags assigned to the resource.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcpeeringconnection.html#cfn-ec2-vpcpeeringconnection-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnVPCPeeringConnection`.
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"
cfnVPCPeeringConnectionProps := &CfnVPCPeeringConnectionProps{
PeerVpcId: jsii.String("peerVpcId"),
VpcId: jsii.String("vpcId"),
// the properties below are optional
PeerOwnerId: jsii.String("peerOwnerId"),
PeerRegion: jsii.String("peerRegion"),
PeerRoleArn: jsii.String("peerRoleArn"),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
type CfnVPCProps ¶
type CfnVPCProps struct {
// The IPv4 network range for the VPC, in CIDR notation.
//
// For example, `10.0.0.0/16` . We modify the specified CIDR block to its canonical form; for example, if you specify `100.68.0.18/18` , we modify it to `100.68.0.0/18` .
//
// You must specify either `CidrBlock` or `Ipv4IpamPoolId` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html#cfn-ec2-vpc-cidrblock
//
CidrBlock *string `field:"optional" json:"cidrBlock" yaml:"cidrBlock"`
// Indicates whether the instances launched in the VPC get DNS hostnames.
//
// If enabled, instances in the VPC get DNS hostnames; otherwise, they do not. Disabled by default for nondefault VPCs. For more information, see [DNS attributes in your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html#vpc-dns-support) .
//
// You can only enable DNS hostnames if you've enabled DNS support.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html#cfn-ec2-vpc-enablednshostnames
//
EnableDnsHostnames interface{} `field:"optional" json:"enableDnsHostnames" yaml:"enableDnsHostnames"`
// Indicates whether the DNS resolution is supported for the VPC.
//
// If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range "plus two" succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled. Enabled by default. For more information, see [DNS attributes in your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html#vpc-dns-support) .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html#cfn-ec2-vpc-enablednssupport
//
EnableDnsSupport interface{} `field:"optional" json:"enableDnsSupport" yaml:"enableDnsSupport"`
// The allowed tenancy of instances launched into the VPC.
//
// - `default` : An instance launched into the VPC runs on shared hardware by default, unless you explicitly specify a different tenancy during instance launch.
// - `dedicated` : An instance launched into the VPC runs on dedicated hardware by default, unless you explicitly specify a tenancy of `host` during instance launch. You cannot specify a tenancy of `default` during instance launch.
//
// Updating `InstanceTenancy` requires no replacement only if you are updating its value from `dedicated` to `default` . Updating `InstanceTenancy` from `default` to `dedicated` requires replacement.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html#cfn-ec2-vpc-instancetenancy
//
InstanceTenancy *string `field:"optional" json:"instanceTenancy" yaml:"instanceTenancy"`
// The ID of an IPv4 IPAM pool you want to use for allocating this VPC's CIDR.
//
// For more information, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide* .
//
// You must specify either `CidrBlock` or `Ipv4IpamPoolId` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html#cfn-ec2-vpc-ipv4ipampoolid
//
Ipv4IpamPoolId *string `field:"optional" json:"ipv4IpamPoolId" yaml:"ipv4IpamPoolId"`
// The netmask length of the IPv4 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool.
//
// For more information about IPAM, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html#cfn-ec2-vpc-ipv4netmasklength
//
Ipv4NetmaskLength *float64 `field:"optional" json:"ipv4NetmaskLength" yaml:"ipv4NetmaskLength"`
// The tags for the VPC.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html#cfn-ec2-vpc-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnVPC`.
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"
cfnVPCProps := &CfnVPCProps{
CidrBlock: jsii.String("cidrBlock"),
EnableDnsHostnames: jsii.Boolean(false),
EnableDnsSupport: jsii.Boolean(false),
InstanceTenancy: jsii.String("instanceTenancy"),
Ipv4IpamPoolId: jsii.String("ipv4IpamPoolId"),
Ipv4NetmaskLength: jsii.Number(123),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html
type CfnVPNConnection ¶
type CfnVPNConnection interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggable
// The ID of the VPN connection.
AttrVpnConnectionId() *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 ID of the customer gateway at your end of the VPN connection.
CustomerGatewayId() *string
SetCustomerGatewayId(val *string)
// Indicate whether to enable acceleration for the VPN connection.
EnableAcceleration() interface{}
SetEnableAcceleration(val interface{})
// The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.
LocalIpv4NetworkCidr() *string
SetLocalIpv4NetworkCidr(val *string)
// The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.
LocalIpv6NetworkCidr() *string
SetLocalIpv6NetworkCidr(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
// The type of IPv4 address assigned to the outside interface of the customer gateway device.
OutsideIpAddressType() *string
SetOutsideIpAddressType(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 IPv4 CIDR on the AWS side of the VPN connection.
RemoteIpv4NetworkCidr() *string
SetRemoteIpv4NetworkCidr(val *string)
// The IPv6 CIDR on the AWS side of the VPN connection.
RemoteIpv6NetworkCidr() *string
SetRemoteIpv6NetworkCidr(val *string)
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Indicates whether the VPN connection uses static routes only.
StaticRoutesOnly() interface{}
SetStaticRoutesOnly(val interface{})
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
// Any tags assigned to the VPN connection.
TagsRaw() *[]*awscdk.CfnTag
SetTagsRaw(val *[]*awscdk.CfnTag)
// The ID of the transit gateway associated with the VPN connection.
TransitGatewayId() *string
SetTransitGatewayId(val *string)
// The transit gateway attachment ID to use for the VPN tunnel.
TransportTransitGatewayAttachmentId() *string
SetTransportTransitGatewayAttachmentId(val *string)
// Indicate whether the VPN tunnels process IPv4 or IPv6 traffic.
TunnelInsideIpVersion() *string
SetTunnelInsideIpVersion(val *string)
// The type of VPN connection.
Type() *string
SetType(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{}
// The ID of the virtual private gateway at the AWS side of the VPN connection.
VpnGatewayId() *string
SetVpnGatewayId(val *string)
// The tunnel options for the VPN connection.
VpnTunnelOptionsSpecifications() interface{}
SetVpnTunnelOptionsSpecifications(val 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{})
}
Specifies a VPN connection between a virtual private gateway and a VPN customer gateway or a transit gateway and a VPN customer gateway.
To specify a VPN connection between a transit gateway and customer gateway, use the `TransitGatewayId` and `CustomerGatewayId` properties.
To specify a VPN connection between a virtual private gateway and customer gateway, use the `VpnGatewayId` and `CustomerGatewayId` properties.
For more information, see [AWS Site-to-Site VPN](https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html) in the *AWS Site-to-Site VPN User 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"
cfnVPNConnection := awscdk.Aws_ec2.NewCfnVPNConnection(this, jsii.String("MyCfnVPNConnection"), &CfnVPNConnectionProps{
CustomerGatewayId: jsii.String("customerGatewayId"),
Type: jsii.String("type"),
// the properties below are optional
EnableAcceleration: jsii.Boolean(false),
LocalIpv4NetworkCidr: jsii.String("localIpv4NetworkCidr"),
LocalIpv6NetworkCidr: jsii.String("localIpv6NetworkCidr"),
OutsideIpAddressType: jsii.String("outsideIpAddressType"),
RemoteIpv4NetworkCidr: jsii.String("remoteIpv4NetworkCidr"),
RemoteIpv6NetworkCidr: jsii.String("remoteIpv6NetworkCidr"),
StaticRoutesOnly: jsii.Boolean(false),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
TransitGatewayId: jsii.String("transitGatewayId"),
TransportTransitGatewayAttachmentId: jsii.String("transportTransitGatewayAttachmentId"),
TunnelInsideIpVersion: jsii.String("tunnelInsideIpVersion"),
VpnGatewayId: jsii.String("vpnGatewayId"),
VpnTunnelOptionsSpecifications: []interface{}{
&VpnTunnelOptionsSpecificationProperty{
PreSharedKey: jsii.String("preSharedKey"),
TunnelInsideCidr: jsii.String("tunnelInsideCidr"),
},
},
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html
func NewCfnVPNConnection ¶
func NewCfnVPNConnection(scope constructs.Construct, id *string, props *CfnVPNConnectionProps) CfnVPNConnection
type CfnVPNConnectionProps ¶
type CfnVPNConnectionProps struct {
// The ID of the customer gateway at your end of the VPN connection.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-customergatewayid
//
CustomerGatewayId *string `field:"required" json:"customerGatewayId" yaml:"customerGatewayId"`
// The type of VPN connection.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-type
//
Type *string `field:"required" json:"type" yaml:"type"`
// Indicate whether to enable acceleration for the VPN connection.
//
// Default: `false`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-enableacceleration
//
EnableAcceleration interface{} `field:"optional" json:"enableAcceleration" yaml:"enableAcceleration"`
// The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.
//
// Default: `0.0.0.0/0`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-localipv4networkcidr
//
LocalIpv4NetworkCidr *string `field:"optional" json:"localIpv4NetworkCidr" yaml:"localIpv4NetworkCidr"`
// The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.
//
// Default: `::/0`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-localipv6networkcidr
//
LocalIpv6NetworkCidr *string `field:"optional" json:"localIpv6NetworkCidr" yaml:"localIpv6NetworkCidr"`
// The type of IPv4 address assigned to the outside interface of the customer gateway device.
//
// Valid values: `PrivateIpv4` | `PublicIpv4`
//
// Default: `PublicIpv4`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-outsideipaddresstype
//
OutsideIpAddressType *string `field:"optional" json:"outsideIpAddressType" yaml:"outsideIpAddressType"`
// The IPv4 CIDR on the AWS side of the VPN connection.
//
// Default: `0.0.0.0/0`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-remoteipv4networkcidr
//
RemoteIpv4NetworkCidr *string `field:"optional" json:"remoteIpv4NetworkCidr" yaml:"remoteIpv4NetworkCidr"`
// The IPv6 CIDR on the AWS side of the VPN connection.
//
// Default: `::/0`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-remoteipv6networkcidr
//
RemoteIpv6NetworkCidr *string `field:"optional" json:"remoteIpv6NetworkCidr" yaml:"remoteIpv6NetworkCidr"`
// Indicates whether the VPN connection uses static routes only.
//
// Static routes must be used for devices that don't support BGP.
//
// If you are creating a VPN connection for a device that does not support Border Gateway Protocol (BGP), you must specify `true` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-staticroutesonly
//
StaticRoutesOnly interface{} `field:"optional" json:"staticRoutesOnly" yaml:"staticRoutesOnly"`
// Any tags assigned to the VPN connection.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
// The ID of the transit gateway associated with the VPN connection.
//
// You must specify either `TransitGatewayId` or `VpnGatewayId` , but not both.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-transitgatewayid
//
TransitGatewayId *string `field:"optional" json:"transitGatewayId" yaml:"transitGatewayId"`
// The transit gateway attachment ID to use for the VPN tunnel.
//
// Required if `OutsideIpAddressType` is set to `PrivateIpv4` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-transporttransitgatewayattachmentid
//
TransportTransitGatewayAttachmentId *string `field:"optional" json:"transportTransitGatewayAttachmentId" yaml:"transportTransitGatewayAttachmentId"`
// Indicate whether the VPN tunnels process IPv4 or IPv6 traffic.
//
// Default: `ipv4`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-tunnelinsideipversion
//
TunnelInsideIpVersion *string `field:"optional" json:"tunnelInsideIpVersion" yaml:"tunnelInsideIpVersion"`
// The ID of the virtual private gateway at the AWS side of the VPN connection.
//
// You must specify either `TransitGatewayId` or `VpnGatewayId` , but not both.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-vpngatewayid
//
VpnGatewayId *string `field:"optional" json:"vpnGatewayId" yaml:"vpnGatewayId"`
// The tunnel options for the VPN connection.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-vpntunneloptionsspecifications
//
VpnTunnelOptionsSpecifications interface{} `field:"optional" json:"vpnTunnelOptionsSpecifications" yaml:"vpnTunnelOptionsSpecifications"`
}
Properties for defining a `CfnVPNConnection`.
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"
cfnVPNConnectionProps := &CfnVPNConnectionProps{
CustomerGatewayId: jsii.String("customerGatewayId"),
Type: jsii.String("type"),
// the properties below are optional
EnableAcceleration: jsii.Boolean(false),
LocalIpv4NetworkCidr: jsii.String("localIpv4NetworkCidr"),
LocalIpv6NetworkCidr: jsii.String("localIpv6NetworkCidr"),
OutsideIpAddressType: jsii.String("outsideIpAddressType"),
RemoteIpv4NetworkCidr: jsii.String("remoteIpv4NetworkCidr"),
RemoteIpv6NetworkCidr: jsii.String("remoteIpv6NetworkCidr"),
StaticRoutesOnly: jsii.Boolean(false),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
TransitGatewayId: jsii.String("transitGatewayId"),
TransportTransitGatewayAttachmentId: jsii.String("transportTransitGatewayAttachmentId"),
TunnelInsideIpVersion: jsii.String("tunnelInsideIpVersion"),
VpnGatewayId: jsii.String("vpnGatewayId"),
VpnTunnelOptionsSpecifications: []interface{}{
&VpnTunnelOptionsSpecificationProperty{
PreSharedKey: jsii.String("preSharedKey"),
TunnelInsideCidr: jsii.String("tunnelInsideCidr"),
},
},
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html
type CfnVPNConnectionRoute ¶
type CfnVPNConnectionRoute interface {
awscdk.CfnResource
awscdk.IInspectable
// 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 CIDR block associated with the local subnet of the customer network.
DestinationCidrBlock() *string
SetDestinationCidrBlock(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{}
// The ID of the VPN connection.
VpnConnectionId() *string
SetVpnConnectionId(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{})
}
Specifies a static route for a VPN connection between an existing virtual private gateway and a VPN customer gateway.
The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.
For more information, see [AWS Site-to-Site VPN](https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html) in the *AWS Site-to-Site VPN User 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"
cfnVPNConnectionRoute := awscdk.Aws_ec2.NewCfnVPNConnectionRoute(this, jsii.String("MyCfnVPNConnectionRoute"), &CfnVPNConnectionRouteProps{
DestinationCidrBlock: jsii.String("destinationCidrBlock"),
VpnConnectionId: jsii.String("vpnConnectionId"),
})
func NewCfnVPNConnectionRoute ¶
func NewCfnVPNConnectionRoute(scope constructs.Construct, id *string, props *CfnVPNConnectionRouteProps) CfnVPNConnectionRoute
type CfnVPNConnectionRouteProps ¶
type CfnVPNConnectionRouteProps struct {
// The CIDR block associated with the local subnet of the customer network.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnectionroute.html#cfn-ec2-vpnconnectionroute-destinationcidrblock
//
DestinationCidrBlock *string `field:"required" json:"destinationCidrBlock" yaml:"destinationCidrBlock"`
// The ID of the VPN connection.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnectionroute.html#cfn-ec2-vpnconnectionroute-vpnconnectionid
//
VpnConnectionId *string `field:"required" json:"vpnConnectionId" yaml:"vpnConnectionId"`
}
Properties for defining a `CfnVPNConnectionRoute`.
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"
cfnVPNConnectionRouteProps := &CfnVPNConnectionRouteProps{
DestinationCidrBlock: jsii.String("destinationCidrBlock"),
VpnConnectionId: jsii.String("vpnConnectionId"),
}
type CfnVPNConnection_VpnTunnelOptionsSpecificationProperty ¶
type CfnVPNConnection_VpnTunnelOptionsSpecificationProperty struct {
//
// Constraints: Allowed characters are alphanumeric characters, periods (.), and underscores (_). Must be between 8 and 64 characters in length and cannot start with zero (0).
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpnconnection-vpntunneloptionsspecification.html#cfn-ec2-vpnconnection-vpntunneloptionsspecification-presharedkey
//
PreSharedKey *string `field:"optional" json:"preSharedKey" yaml:"preSharedKey"`
// The range of inside IP addresses for the tunnel.
//
// Any specified CIDR blocks must be unique across all VPN connections that use the same virtual private gateway.
//
// Constraints: A size /30 CIDR block from the `169.254.0.0/16` range. The following CIDR blocks are reserved and cannot be used:
//
// - `169.254.0.0/30`
// - `169.254.1.0/30`
// - `169.254.2.0/30`
// - `169.254.3.0/30`
// - `169.254.4.0/30`
// - `169.254.5.0/30`
// - `169.254.169.252/30`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpnconnection-vpntunneloptionsspecification.html#cfn-ec2-vpnconnection-vpntunneloptionsspecification-tunnelinsidecidr
//
TunnelInsideCidr *string `field:"optional" json:"tunnelInsideCidr" yaml:"tunnelInsideCidr"`
}
The tunnel options for a single VPN tunnel.
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"
vpnTunnelOptionsSpecificationProperty := &VpnTunnelOptionsSpecificationProperty{
PreSharedKey: jsii.String("preSharedKey"),
TunnelInsideCidr: jsii.String("tunnelInsideCidr"),
}
type CfnVPNGateway ¶
type CfnVPNGateway interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggable
// The private Autonomous System Number (ASN) for the Amazon side of a BGP session.
AmazonSideAsn() *float64
SetAmazonSideAsn(val *float64)
// The ID of the VPN gateway.
AttrVpnGatewayId() *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
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
// Any tags assigned to the virtual private gateway.
TagsRaw() *[]*awscdk.CfnTag
SetTagsRaw(val *[]*awscdk.CfnTag)
// The type of VPN connection the virtual private gateway supports.
Type() *string
SetType(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{})
}
Specifies a virtual private gateway.
A virtual private gateway is the endpoint on the VPC side of your VPN connection. You can create a virtual private gateway before creating the VPC itself.
For more information, see [AWS Site-to-Site VPN](https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html) in the *AWS Site-to-Site VPN User 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"
cfnVPNGateway := awscdk.Aws_ec2.NewCfnVPNGateway(this, jsii.String("MyCfnVPNGateway"), &CfnVPNGatewayProps{
Type: jsii.String("type"),
// the properties below are optional
AmazonSideAsn: jsii.Number(123),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpngateway.html
func NewCfnVPNGateway ¶
func NewCfnVPNGateway(scope constructs.Construct, id *string, props *CfnVPNGatewayProps) CfnVPNGateway
type CfnVPNGatewayProps ¶
type CfnVPNGatewayProps struct {
// The type of VPN connection the virtual private gateway supports.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpngateway.html#cfn-ec2-vpngateway-type
//
Type *string `field:"required" json:"type" yaml:"type"`
// The private Autonomous System Number (ASN) for the Amazon side of a BGP session.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpngateway.html#cfn-ec2-vpngateway-amazonsideasn
//
AmazonSideAsn *float64 `field:"optional" json:"amazonSideAsn" yaml:"amazonSideAsn"`
// Any tags assigned to the virtual private gateway.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpngateway.html#cfn-ec2-vpngateway-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnVPNGateway`.
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"
cfnVPNGatewayProps := &CfnVPNGatewayProps{
Type: jsii.String("type"),
// the properties below are optional
AmazonSideAsn: jsii.Number(123),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpngateway.html
type CfnVPNGatewayRoutePropagation ¶
type CfnVPNGatewayRoutePropagation interface {
awscdk.CfnResource
awscdk.IInspectable
// The ID of the VPN gateway.
AttrId() *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 ID of the route table.
RouteTableIds() *[]*string
SetRouteTableIds(val *[]*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{}
// The ID of the virtual private gateway that is attached to a VPC.
VpnGatewayId() *string
SetVpnGatewayId(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{})
}
Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC.
If you reference a VPN gateway that is in the same template as your VPN gateway route propagation, you must explicitly declare a dependency on the VPN gateway attachment. The `AWS::EC2::VPNGatewayRoutePropagation` resource cannot use the VPN gateway until it has successfully attached to the VPC. Add a [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) in the `AWS::EC2::VPNGatewayRoutePropagation` resource to explicitly declare a dependency on the VPN gateway attachment.
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"
cfnVPNGatewayRoutePropagation := awscdk.Aws_ec2.NewCfnVPNGatewayRoutePropagation(this, jsii.String("MyCfnVPNGatewayRoutePropagation"), &CfnVPNGatewayRoutePropagationProps{
RouteTableIds: []*string{
jsii.String("routeTableIds"),
},
VpnGatewayId: jsii.String("vpnGatewayId"),
})
func NewCfnVPNGatewayRoutePropagation ¶
func NewCfnVPNGatewayRoutePropagation(scope constructs.Construct, id *string, props *CfnVPNGatewayRoutePropagationProps) CfnVPNGatewayRoutePropagation
type CfnVPNGatewayRoutePropagationProps ¶
type CfnVPNGatewayRoutePropagationProps struct {
// The ID of the route table.
//
// The routing table must be associated with the same VPC that the virtual private gateway is attached to.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpngatewayroutepropagation.html#cfn-ec2-vpngatewayroutepropagation-routetableids
//
RouteTableIds *[]*string `field:"required" json:"routeTableIds" yaml:"routeTableIds"`
// The ID of the virtual private gateway that is attached to a VPC.
//
// The virtual private gateway must be attached to the same VPC that the routing tables are associated with.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpngatewayroutepropagation.html#cfn-ec2-vpngatewayroutepropagation-vpngatewayid
//
VpnGatewayId *string `field:"required" json:"vpnGatewayId" yaml:"vpnGatewayId"`
}
Properties for defining a `CfnVPNGatewayRoutePropagation`.
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"
cfnVPNGatewayRoutePropagationProps := &CfnVPNGatewayRoutePropagationProps{
RouteTableIds: []*string{
jsii.String("routeTableIds"),
},
VpnGatewayId: jsii.String("vpnGatewayId"),
}
type CfnVerifiedAccessEndpoint ¶ added in v2.80.0
type CfnVerifiedAccessEndpoint interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggable
// The DNS name for users to reach your application.
ApplicationDomain() *string
SetApplicationDomain(val *string)
// The type of attachment used to provide connectivity between the AWS Verified Access endpoint and the application.
AttachmentType() *string
SetAttachmentType(val *string)
// The creation time.
AttrCreationTime() *string
// Use this to construct the redirect URI to add to your OIDC provider's allow list.
AttrDeviceValidationDomain() *string
// The DNS name generated for the endpoint.
AttrEndpointDomain() *string
// The last updated time.
AttrLastUpdatedTime() *string
// The endpoint status.
AttrStatus() *string
// The ID of the Verified Access endpoint.
AttrVerifiedAccessEndpointId() *string
// The instance identifier.
AttrVerifiedAccessInstanceId() *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 description for the AWS Verified Access endpoint.
Description() *string
SetDescription(val *string)
// The ARN of a public TLS/SSL certificate imported into or created with ACM.
DomainCertificateArn() *string
SetDomainCertificateArn(val *string)
// A custom identifier that is prepended to the DNS name that is generated for the endpoint.
EndpointDomainPrefix() *string
SetEndpointDomainPrefix(val *string)
// The type of AWS Verified Access endpoint.
EndpointType() *string
SetEndpointType(val *string)
// The load balancer details if creating the AWS Verified Access endpoint as `load-balancer` type.
LoadBalancerOptions() interface{}
SetLoadBalancerOptions(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 options for network-interface type endpoint.
NetworkInterfaceOptions() interface{}
SetNetworkInterfaceOptions(val interface{})
// The tree node.
Node() constructs.Node
// The Verified Access policy document.
PolicyDocument() *string
SetPolicyDocument(val *string)
// The status of the Verified Access policy.
PolicyEnabled() interface{}
SetPolicyEnabled(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 IDs of the security groups for the endpoint.
SecurityGroupIds() *[]*string
SetSecurityGroupIds(val *[]*string)
// The options for additional server side encryption.
SseSpecification() interface{}
SetSseSpecification(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
// The tags.
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 ID of the AWS Verified Access group.
VerifiedAccessGroupId() *string
SetVerifiedAccessGroupId(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{})
}
An AWS Verified Access endpoint specifies the application that AWS Verified Access provides access to.
It must be attached to an AWS Verified Access group. An AWS Verified Access endpoint must also have an attached access policy before you attached it to a group.
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"
cfnVerifiedAccessEndpoint := awscdk.Aws_ec2.NewCfnVerifiedAccessEndpoint(this, jsii.String("MyCfnVerifiedAccessEndpoint"), &CfnVerifiedAccessEndpointProps{
ApplicationDomain: jsii.String("applicationDomain"),
AttachmentType: jsii.String("attachmentType"),
DomainCertificateArn: jsii.String("domainCertificateArn"),
EndpointDomainPrefix: jsii.String("endpointDomainPrefix"),
EndpointType: jsii.String("endpointType"),
VerifiedAccessGroupId: jsii.String("verifiedAccessGroupId"),
// the properties below are optional
Description: jsii.String("description"),
LoadBalancerOptions: &LoadBalancerOptionsProperty{
LoadBalancerArn: jsii.String("loadBalancerArn"),
Port: jsii.Number(123),
Protocol: jsii.String("protocol"),
SubnetIds: []*string{
jsii.String("subnetIds"),
},
},
NetworkInterfaceOptions: &NetworkInterfaceOptionsProperty{
NetworkInterfaceId: jsii.String("networkInterfaceId"),
Port: jsii.Number(123),
Protocol: jsii.String("protocol"),
},
PolicyDocument: jsii.String("policyDocument"),
PolicyEnabled: jsii.Boolean(false),
SecurityGroupIds: []*string{
jsii.String("securityGroupIds"),
},
SseSpecification: &SseSpecificationProperty{
CustomerManagedKeyEnabled: jsii.Boolean(false),
KmsKeyArn: jsii.String("kmsKeyArn"),
},
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
func NewCfnVerifiedAccessEndpoint ¶ added in v2.80.0
func NewCfnVerifiedAccessEndpoint(scope constructs.Construct, id *string, props *CfnVerifiedAccessEndpointProps) CfnVerifiedAccessEndpoint
type CfnVerifiedAccessEndpointProps ¶ added in v2.80.0
type CfnVerifiedAccessEndpointProps struct {
// The DNS name for users to reach your application.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html#cfn-ec2-verifiedaccessendpoint-applicationdomain
//
ApplicationDomain *string `field:"required" json:"applicationDomain" yaml:"applicationDomain"`
// The type of attachment used to provide connectivity between the AWS Verified Access endpoint and the application.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html#cfn-ec2-verifiedaccessendpoint-attachmenttype
//
AttachmentType *string `field:"required" json:"attachmentType" yaml:"attachmentType"`
// The ARN of a public TLS/SSL certificate imported into or created with ACM.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html#cfn-ec2-verifiedaccessendpoint-domaincertificatearn
//
DomainCertificateArn *string `field:"required" json:"domainCertificateArn" yaml:"domainCertificateArn"`
// A custom identifier that is prepended to the DNS name that is generated for the endpoint.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html#cfn-ec2-verifiedaccessendpoint-endpointdomainprefix
//
EndpointDomainPrefix *string `field:"required" json:"endpointDomainPrefix" yaml:"endpointDomainPrefix"`
// The type of AWS Verified Access endpoint.
//
// Incoming application requests will be sent to an IP address, load balancer or a network interface depending on the endpoint type specified.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html#cfn-ec2-verifiedaccessendpoint-endpointtype
//
EndpointType *string `field:"required" json:"endpointType" yaml:"endpointType"`
// The ID of the AWS Verified Access group.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html#cfn-ec2-verifiedaccessendpoint-verifiedaccessgroupid
//
VerifiedAccessGroupId *string `field:"required" json:"verifiedAccessGroupId" yaml:"verifiedAccessGroupId"`
// A description for the AWS Verified Access endpoint.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html#cfn-ec2-verifiedaccessendpoint-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// The load balancer details if creating the AWS Verified Access endpoint as `load-balancer` type.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html#cfn-ec2-verifiedaccessendpoint-loadbalanceroptions
//
LoadBalancerOptions interface{} `field:"optional" json:"loadBalancerOptions" yaml:"loadBalancerOptions"`
// The options for network-interface type endpoint.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html#cfn-ec2-verifiedaccessendpoint-networkinterfaceoptions
//
NetworkInterfaceOptions interface{} `field:"optional" json:"networkInterfaceOptions" yaml:"networkInterfaceOptions"`
// The Verified Access policy document.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html#cfn-ec2-verifiedaccessendpoint-policydocument
//
PolicyDocument *string `field:"optional" json:"policyDocument" yaml:"policyDocument"`
// The status of the Verified Access policy.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html#cfn-ec2-verifiedaccessendpoint-policyenabled
//
PolicyEnabled interface{} `field:"optional" json:"policyEnabled" yaml:"policyEnabled"`
// The IDs of the security groups for the endpoint.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html#cfn-ec2-verifiedaccessendpoint-securitygroupids
//
SecurityGroupIds *[]*string `field:"optional" json:"securityGroupIds" yaml:"securityGroupIds"`
// The options for additional server side encryption.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html#cfn-ec2-verifiedaccessendpoint-ssespecification
//
SseSpecification interface{} `field:"optional" json:"sseSpecification" yaml:"sseSpecification"`
// The tags.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html#cfn-ec2-verifiedaccessendpoint-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnVerifiedAccessEndpoint`.
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"
cfnVerifiedAccessEndpointProps := &CfnVerifiedAccessEndpointProps{
ApplicationDomain: jsii.String("applicationDomain"),
AttachmentType: jsii.String("attachmentType"),
DomainCertificateArn: jsii.String("domainCertificateArn"),
EndpointDomainPrefix: jsii.String("endpointDomainPrefix"),
EndpointType: jsii.String("endpointType"),
VerifiedAccessGroupId: jsii.String("verifiedAccessGroupId"),
// the properties below are optional
Description: jsii.String("description"),
LoadBalancerOptions: &LoadBalancerOptionsProperty{
LoadBalancerArn: jsii.String("loadBalancerArn"),
Port: jsii.Number(123),
Protocol: jsii.String("protocol"),
SubnetIds: []*string{
jsii.String("subnetIds"),
},
},
NetworkInterfaceOptions: &NetworkInterfaceOptionsProperty{
NetworkInterfaceId: jsii.String("networkInterfaceId"),
Port: jsii.Number(123),
Protocol: jsii.String("protocol"),
},
PolicyDocument: jsii.String("policyDocument"),
PolicyEnabled: jsii.Boolean(false),
SecurityGroupIds: []*string{
jsii.String("securityGroupIds"),
},
SseSpecification: &SseSpecificationProperty{
CustomerManagedKeyEnabled: jsii.Boolean(false),
KmsKeyArn: jsii.String("kmsKeyArn"),
},
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
type CfnVerifiedAccessEndpoint_LoadBalancerOptionsProperty ¶ added in v2.80.0
type CfnVerifiedAccessEndpoint_LoadBalancerOptionsProperty struct {
// The ARN of the load balancer.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-loadbalanceroptions.html#cfn-ec2-verifiedaccessendpoint-loadbalanceroptions-loadbalancerarn
//
LoadBalancerArn *string `field:"optional" json:"loadBalancerArn" yaml:"loadBalancerArn"`
// The IP port number.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-loadbalanceroptions.html#cfn-ec2-verifiedaccessendpoint-loadbalanceroptions-port
//
Port *float64 `field:"optional" json:"port" yaml:"port"`
// The IP protocol.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-loadbalanceroptions.html#cfn-ec2-verifiedaccessendpoint-loadbalanceroptions-protocol
//
Protocol *string `field:"optional" json:"protocol" yaml:"protocol"`
// The IDs of the subnets.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-loadbalanceroptions.html#cfn-ec2-verifiedaccessendpoint-loadbalanceroptions-subnetids
//
SubnetIds *[]*string `field:"optional" json:"subnetIds" yaml:"subnetIds"`
}
Describes the load balancer options when creating an AWS Verified Access endpoint using the `load-balancer` type.
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"
loadBalancerOptionsProperty := &LoadBalancerOptionsProperty{
LoadBalancerArn: jsii.String("loadBalancerArn"),
Port: jsii.Number(123),
Protocol: jsii.String("protocol"),
SubnetIds: []*string{
jsii.String("subnetIds"),
},
}
type CfnVerifiedAccessEndpoint_NetworkInterfaceOptionsProperty ¶ added in v2.80.0
type CfnVerifiedAccessEndpoint_NetworkInterfaceOptionsProperty struct {
// The ID of the network interface.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-networkinterfaceoptions.html#cfn-ec2-verifiedaccessendpoint-networkinterfaceoptions-networkinterfaceid
//
NetworkInterfaceId *string `field:"optional" json:"networkInterfaceId" yaml:"networkInterfaceId"`
// The IP port number.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-networkinterfaceoptions.html#cfn-ec2-verifiedaccessendpoint-networkinterfaceoptions-port
//
Port *float64 `field:"optional" json:"port" yaml:"port"`
// The IP protocol.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-networkinterfaceoptions.html#cfn-ec2-verifiedaccessendpoint-networkinterfaceoptions-protocol
//
Protocol *string `field:"optional" json:"protocol" yaml:"protocol"`
}
Describes the network interface options when creating an AWS Verified Access endpoint using the `network-interface` type.
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"
networkInterfaceOptionsProperty := &NetworkInterfaceOptionsProperty{
NetworkInterfaceId: jsii.String("networkInterfaceId"),
Port: jsii.Number(123),
Protocol: jsii.String("protocol"),
}
type CfnVerifiedAccessEndpoint_SseSpecificationProperty ¶ added in v2.103.0
type CfnVerifiedAccessEndpoint_SseSpecificationProperty struct {
// Enable or disable the use of customer managed KMS keys for server side encryption.
//
// Valid values: `True` | `False`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-ssespecification.html#cfn-ec2-verifiedaccessendpoint-ssespecification-customermanagedkeyenabled
//
CustomerManagedKeyEnabled interface{} `field:"optional" json:"customerManagedKeyEnabled" yaml:"customerManagedKeyEnabled"`
// The ARN of the KMS key.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-ssespecification.html#cfn-ec2-verifiedaccessendpoint-ssespecification-kmskeyarn
//
KmsKeyArn *string `field:"optional" json:"kmsKeyArn" yaml:"kmsKeyArn"`
}
AWS Verified Access provides server side encryption by default to data at rest using AWS -owned KMS keys.
You also have the option of using customer managed KMS keys, which can be specified using the options below.
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"
sseSpecificationProperty := &SseSpecificationProperty{
CustomerManagedKeyEnabled: jsii.Boolean(false),
KmsKeyArn: jsii.String("kmsKeyArn"),
}
type CfnVerifiedAccessGroup ¶ added in v2.80.0
type CfnVerifiedAccessGroup interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggable
// The creation time.
AttrCreationTime() *string
// The last updated time.
AttrLastUpdatedTime() *string
// The ID of the AWS account that owns the group.
AttrOwner() *string
// The ARN of the Verified Access group.
AttrVerifiedAccessGroupArn() *string
// The ID of the Verified Access group.
AttrVerifiedAccessGroupId() *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 description for the AWS Verified Access group.
Description() *string
SetDescription(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
// The Verified Access policy document.
PolicyDocument() *string
SetPolicyDocument(val *string)
// The status of the Verified Access policy.
PolicyEnabled() interface{}
SetPolicyEnabled(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 options for additional server side encryption.
SseSpecification() interface{}
SetSseSpecification(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
// The tags.
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 ID of the AWS Verified Access instance.
VerifiedAccessInstanceId() *string
SetVerifiedAccessInstanceId(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{})
}
An AWS Verified Access group is a collection of AWS Verified Access endpoints who's associated applications have similar security requirements.
Each instance within a Verified Access group shares an Verified Access policy. For example, you can group all Verified Access instances associated with "sales" applications together and use one common Verified Access policy.
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"
cfnVerifiedAccessGroup := awscdk.Aws_ec2.NewCfnVerifiedAccessGroup(this, jsii.String("MyCfnVerifiedAccessGroup"), &CfnVerifiedAccessGroupProps{
VerifiedAccessInstanceId: jsii.String("verifiedAccessInstanceId"),
// the properties below are optional
Description: jsii.String("description"),
PolicyDocument: jsii.String("policyDocument"),
PolicyEnabled: jsii.Boolean(false),
SseSpecification: &SseSpecificationProperty{
CustomerManagedKeyEnabled: jsii.Boolean(false),
KmsKeyArn: jsii.String("kmsKeyArn"),
},
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
func NewCfnVerifiedAccessGroup ¶ added in v2.80.0
func NewCfnVerifiedAccessGroup(scope constructs.Construct, id *string, props *CfnVerifiedAccessGroupProps) CfnVerifiedAccessGroup
type CfnVerifiedAccessGroupProps ¶ added in v2.80.0
type CfnVerifiedAccessGroupProps struct {
// The ID of the AWS Verified Access instance.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessgroup.html#cfn-ec2-verifiedaccessgroup-verifiedaccessinstanceid
//
VerifiedAccessInstanceId *string `field:"required" json:"verifiedAccessInstanceId" yaml:"verifiedAccessInstanceId"`
// A description for the AWS Verified Access group.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessgroup.html#cfn-ec2-verifiedaccessgroup-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// The Verified Access policy document.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessgroup.html#cfn-ec2-verifiedaccessgroup-policydocument
//
PolicyDocument *string `field:"optional" json:"policyDocument" yaml:"policyDocument"`
// The status of the Verified Access policy.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessgroup.html#cfn-ec2-verifiedaccessgroup-policyenabled
//
PolicyEnabled interface{} `field:"optional" json:"policyEnabled" yaml:"policyEnabled"`
// The options for additional server side encryption.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessgroup.html#cfn-ec2-verifiedaccessgroup-ssespecification
//
SseSpecification interface{} `field:"optional" json:"sseSpecification" yaml:"sseSpecification"`
// The tags.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessgroup.html#cfn-ec2-verifiedaccessgroup-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnVerifiedAccessGroup`.
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"
cfnVerifiedAccessGroupProps := &CfnVerifiedAccessGroupProps{
VerifiedAccessInstanceId: jsii.String("verifiedAccessInstanceId"),
// the properties below are optional
Description: jsii.String("description"),
PolicyDocument: jsii.String("policyDocument"),
PolicyEnabled: jsii.Boolean(false),
SseSpecification: &SseSpecificationProperty{
CustomerManagedKeyEnabled: jsii.Boolean(false),
KmsKeyArn: jsii.String("kmsKeyArn"),
},
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
type CfnVerifiedAccessGroup_SseSpecificationProperty ¶ added in v2.103.0
type CfnVerifiedAccessGroup_SseSpecificationProperty struct {
// Enable or disable the use of customer managed KMS keys for server side encryption.
//
// Valid values: `True` | `False`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessgroup-ssespecification.html#cfn-ec2-verifiedaccessgroup-ssespecification-customermanagedkeyenabled
//
CustomerManagedKeyEnabled interface{} `field:"optional" json:"customerManagedKeyEnabled" yaml:"customerManagedKeyEnabled"`
// The ARN of the KMS key.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessgroup-ssespecification.html#cfn-ec2-verifiedaccessgroup-ssespecification-kmskeyarn
//
KmsKeyArn *string `field:"optional" json:"kmsKeyArn" yaml:"kmsKeyArn"`
}
AWS Verified Access provides server side encryption by default to data at rest using AWS -owned KMS keys.
You also have the option of using customer managed KMS keys, which can be specified using the options below.
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"
sseSpecificationProperty := &SseSpecificationProperty{
CustomerManagedKeyEnabled: jsii.Boolean(false),
KmsKeyArn: jsii.String("kmsKeyArn"),
}
type CfnVerifiedAccessInstance ¶ added in v2.79.0
type CfnVerifiedAccessInstance interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggable
// The creation time.
AttrCreationTime() *string
// The last updated time.
AttrLastUpdatedTime() *string
// The ID of the Verified Access instance.
AttrVerifiedAccessInstanceId() *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 description for the AWS Verified Access instance.
Description() *string
SetDescription(val *string)
// Indicates whether support for Federal Information Processing Standards (FIPS) is enabled on the instance.
FipsEnabled() interface{}
SetFipsEnabled(val interface{})
// The logging configuration for the Verified Access instances.
LoggingConfigurations() interface{}
SetLoggingConfigurations(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 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
// The tags.
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 IDs of the AWS Verified Access trust providers.
VerifiedAccessTrustProviderIds() *[]*string
SetVerifiedAccessTrustProviderIds(val *[]*string)
// The IDs of the AWS Verified Access trust providers.
VerifiedAccessTrustProviders() interface{}
SetVerifiedAccessTrustProviders(val 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{})
}
An AWS Verified Access instance is a regional entity that evaluates application requests and grants access only when your security requirements are met.
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"
cfnVerifiedAccessInstance := awscdk.Aws_ec2.NewCfnVerifiedAccessInstance(this, jsii.String("MyCfnVerifiedAccessInstance"), &CfnVerifiedAccessInstanceProps{
Description: jsii.String("description"),
FipsEnabled: jsii.Boolean(false),
LoggingConfigurations: &VerifiedAccessLogsProperty{
CloudWatchLogs: &CloudWatchLogsProperty{
Enabled: jsii.Boolean(false),
LogGroup: jsii.String("logGroup"),
},
IncludeTrustContext: jsii.Boolean(false),
KinesisDataFirehose: &KinesisDataFirehoseProperty{
DeliveryStream: jsii.String("deliveryStream"),
Enabled: jsii.Boolean(false),
},
LogVersion: jsii.String("logVersion"),
S3: &S3Property{
BucketName: jsii.String("bucketName"),
BucketOwner: jsii.String("bucketOwner"),
Enabled: jsii.Boolean(false),
Prefix: jsii.String("prefix"),
},
},
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
VerifiedAccessTrustProviderIds: []*string{
jsii.String("verifiedAccessTrustProviderIds"),
},
VerifiedAccessTrustProviders: []interface{}{
&VerifiedAccessTrustProviderProperty{
Description: jsii.String("description"),
DeviceTrustProviderType: jsii.String("deviceTrustProviderType"),
TrustProviderType: jsii.String("trustProviderType"),
UserTrustProviderType: jsii.String("userTrustProviderType"),
VerifiedAccessTrustProviderId: jsii.String("verifiedAccessTrustProviderId"),
},
},
})
func NewCfnVerifiedAccessInstance ¶ added in v2.79.0
func NewCfnVerifiedAccessInstance(scope constructs.Construct, id *string, props *CfnVerifiedAccessInstanceProps) CfnVerifiedAccessInstance
type CfnVerifiedAccessInstanceProps ¶ added in v2.79.0
type CfnVerifiedAccessInstanceProps struct {
// A description for the AWS Verified Access instance.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessinstance.html#cfn-ec2-verifiedaccessinstance-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// Indicates whether support for Federal Information Processing Standards (FIPS) is enabled on the instance.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessinstance.html#cfn-ec2-verifiedaccessinstance-fipsenabled
//
FipsEnabled interface{} `field:"optional" json:"fipsEnabled" yaml:"fipsEnabled"`
// The logging configuration for the Verified Access instances.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessinstance.html#cfn-ec2-verifiedaccessinstance-loggingconfigurations
//
LoggingConfigurations interface{} `field:"optional" json:"loggingConfigurations" yaml:"loggingConfigurations"`
// The tags.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessinstance.html#cfn-ec2-verifiedaccessinstance-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
// The IDs of the AWS Verified Access trust providers.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessinstance.html#cfn-ec2-verifiedaccessinstance-verifiedaccesstrustproviderids
//
VerifiedAccessTrustProviderIds *[]*string `field:"optional" json:"verifiedAccessTrustProviderIds" yaml:"verifiedAccessTrustProviderIds"`
// The IDs of the AWS Verified Access trust providers.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessinstance.html#cfn-ec2-verifiedaccessinstance-verifiedaccesstrustproviders
//
VerifiedAccessTrustProviders interface{} `field:"optional" json:"verifiedAccessTrustProviders" yaml:"verifiedAccessTrustProviders"`
}
Properties for defining a `CfnVerifiedAccessInstance`.
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"
cfnVerifiedAccessInstanceProps := &CfnVerifiedAccessInstanceProps{
Description: jsii.String("description"),
FipsEnabled: jsii.Boolean(false),
LoggingConfigurations: &VerifiedAccessLogsProperty{
CloudWatchLogs: &CloudWatchLogsProperty{
Enabled: jsii.Boolean(false),
LogGroup: jsii.String("logGroup"),
},
IncludeTrustContext: jsii.Boolean(false),
KinesisDataFirehose: &KinesisDataFirehoseProperty{
DeliveryStream: jsii.String("deliveryStream"),
Enabled: jsii.Boolean(false),
},
LogVersion: jsii.String("logVersion"),
S3: &S3Property{
BucketName: jsii.String("bucketName"),
BucketOwner: jsii.String("bucketOwner"),
Enabled: jsii.Boolean(false),
Prefix: jsii.String("prefix"),
},
},
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
VerifiedAccessTrustProviderIds: []*string{
jsii.String("verifiedAccessTrustProviderIds"),
},
VerifiedAccessTrustProviders: []interface{}{
&VerifiedAccessTrustProviderProperty{
Description: jsii.String("description"),
DeviceTrustProviderType: jsii.String("deviceTrustProviderType"),
TrustProviderType: jsii.String("trustProviderType"),
UserTrustProviderType: jsii.String("userTrustProviderType"),
VerifiedAccessTrustProviderId: jsii.String("verifiedAccessTrustProviderId"),
},
},
}
type CfnVerifiedAccessInstance_CloudWatchLogsProperty ¶ added in v2.79.0
type CfnVerifiedAccessInstance_CloudWatchLogsProperty struct {
// Indicates whether logging is enabled.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-cloudwatchlogs.html#cfn-ec2-verifiedaccessinstance-cloudwatchlogs-enabled
//
Enabled interface{} `field:"optional" json:"enabled" yaml:"enabled"`
// The ID of the CloudWatch Logs log group.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-cloudwatchlogs.html#cfn-ec2-verifiedaccessinstance-cloudwatchlogs-loggroup
//
LogGroup *string `field:"optional" json:"logGroup" yaml:"logGroup"`
}
Options for CloudWatch Logs as a logging destination.
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"
cloudWatchLogsProperty := &CloudWatchLogsProperty{
Enabled: jsii.Boolean(false),
LogGroup: jsii.String("logGroup"),
}
type CfnVerifiedAccessInstance_KinesisDataFirehoseProperty ¶ added in v2.79.0
type CfnVerifiedAccessInstance_KinesisDataFirehoseProperty struct {
// The ID of the delivery stream.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-kinesisdatafirehose.html#cfn-ec2-verifiedaccessinstance-kinesisdatafirehose-deliverystream
//
DeliveryStream *string `field:"optional" json:"deliveryStream" yaml:"deliveryStream"`
// Indicates whether logging is enabled.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-kinesisdatafirehose.html#cfn-ec2-verifiedaccessinstance-kinesisdatafirehose-enabled
//
Enabled interface{} `field:"optional" json:"enabled" yaml:"enabled"`
}
Options for Kinesis as a logging destination.
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"
kinesisDataFirehoseProperty := &KinesisDataFirehoseProperty{
DeliveryStream: jsii.String("deliveryStream"),
Enabled: jsii.Boolean(false),
}
type CfnVerifiedAccessInstance_S3Property ¶ added in v2.79.0
type CfnVerifiedAccessInstance_S3Property struct {
// The bucket name.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-s3.html#cfn-ec2-verifiedaccessinstance-s3-bucketname
//
BucketName *string `field:"optional" json:"bucketName" yaml:"bucketName"`
// The AWS account number that owns the bucket.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-s3.html#cfn-ec2-verifiedaccessinstance-s3-bucketowner
//
BucketOwner *string `field:"optional" json:"bucketOwner" yaml:"bucketOwner"`
// Indicates whether logging is enabled.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-s3.html#cfn-ec2-verifiedaccessinstance-s3-enabled
//
Enabled interface{} `field:"optional" json:"enabled" yaml:"enabled"`
// The bucket prefix.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-s3.html#cfn-ec2-verifiedaccessinstance-s3-prefix
//
Prefix *string `field:"optional" json:"prefix" yaml:"prefix"`
}
Options for Amazon S3 as a logging destination.
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"
s3Property := &S3Property{
BucketName: jsii.String("bucketName"),
BucketOwner: jsii.String("bucketOwner"),
Enabled: jsii.Boolean(false),
Prefix: jsii.String("prefix"),
}
type CfnVerifiedAccessInstance_VerifiedAccessLogsProperty ¶ added in v2.79.0
type CfnVerifiedAccessInstance_VerifiedAccessLogsProperty struct {
// CloudWatch Logs logging destination.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-verifiedaccesslogs.html#cfn-ec2-verifiedaccessinstance-verifiedaccesslogs-cloudwatchlogs
//
CloudWatchLogs interface{} `field:"optional" json:"cloudWatchLogs" yaml:"cloudWatchLogs"`
// Indicates whether to include trust data sent by trust providers in the logs.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-verifiedaccesslogs.html#cfn-ec2-verifiedaccessinstance-verifiedaccesslogs-includetrustcontext
//
IncludeTrustContext interface{} `field:"optional" json:"includeTrustContext" yaml:"includeTrustContext"`
// Kinesis logging destination.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-verifiedaccesslogs.html#cfn-ec2-verifiedaccessinstance-verifiedaccesslogs-kinesisdatafirehose
//
KinesisDataFirehose interface{} `field:"optional" json:"kinesisDataFirehose" yaml:"kinesisDataFirehose"`
// The logging version.
//
// Valid values: `ocsf-0.1` | `ocsf-1.0.0-rc.2`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-verifiedaccesslogs.html#cfn-ec2-verifiedaccessinstance-verifiedaccesslogs-logversion
//
LogVersion *string `field:"optional" json:"logVersion" yaml:"logVersion"`
// Amazon S3 logging options.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-verifiedaccesslogs.html#cfn-ec2-verifiedaccessinstance-verifiedaccesslogs-s3
//
S3 interface{} `field:"optional" json:"s3" yaml:"s3"`
}
Describes the options for Verified Access logs.
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"
verifiedAccessLogsProperty := &VerifiedAccessLogsProperty{
CloudWatchLogs: &CloudWatchLogsProperty{
Enabled: jsii.Boolean(false),
LogGroup: jsii.String("logGroup"),
},
IncludeTrustContext: jsii.Boolean(false),
KinesisDataFirehose: &KinesisDataFirehoseProperty{
DeliveryStream: jsii.String("deliveryStream"),
Enabled: jsii.Boolean(false),
},
LogVersion: jsii.String("logVersion"),
S3: &S3Property{
BucketName: jsii.String("bucketName"),
BucketOwner: jsii.String("bucketOwner"),
Enabled: jsii.Boolean(false),
Prefix: jsii.String("prefix"),
},
}
type CfnVerifiedAccessInstance_VerifiedAccessTrustProviderProperty ¶ added in v2.79.0
type CfnVerifiedAccessInstance_VerifiedAccessTrustProviderProperty struct {
// A description for the AWS Verified Access trust provider.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-verifiedaccesstrustprovider.html#cfn-ec2-verifiedaccessinstance-verifiedaccesstrustprovider-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// The type of device-based trust provider.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-verifiedaccesstrustprovider.html#cfn-ec2-verifiedaccessinstance-verifiedaccesstrustprovider-devicetrustprovidertype
//
DeviceTrustProviderType *string `field:"optional" json:"deviceTrustProviderType" yaml:"deviceTrustProviderType"`
// The type of Verified Access trust provider.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-verifiedaccesstrustprovider.html#cfn-ec2-verifiedaccessinstance-verifiedaccesstrustprovider-trustprovidertype
//
TrustProviderType *string `field:"optional" json:"trustProviderType" yaml:"trustProviderType"`
// The type of user-based trust provider.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-verifiedaccesstrustprovider.html#cfn-ec2-verifiedaccessinstance-verifiedaccesstrustprovider-usertrustprovidertype
//
UserTrustProviderType *string `field:"optional" json:"userTrustProviderType" yaml:"userTrustProviderType"`
// The ID of the AWS Verified Access trust provider.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessinstance-verifiedaccesstrustprovider.html#cfn-ec2-verifiedaccessinstance-verifiedaccesstrustprovider-verifiedaccesstrustproviderid
//
VerifiedAccessTrustProviderId *string `field:"optional" json:"verifiedAccessTrustProviderId" yaml:"verifiedAccessTrustProviderId"`
}
A trust provider is a third-party entity that creates, maintains, and manages identity information for users and devices.
When an application request is made, the identity information sent by the trust provider is evaluated by Verified Access before allowing or denying the application request.
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"
verifiedAccessTrustProviderProperty := &VerifiedAccessTrustProviderProperty{
Description: jsii.String("description"),
DeviceTrustProviderType: jsii.String("deviceTrustProviderType"),
TrustProviderType: jsii.String("trustProviderType"),
UserTrustProviderType: jsii.String("userTrustProviderType"),
VerifiedAccessTrustProviderId: jsii.String("verifiedAccessTrustProviderId"),
}
type CfnVerifiedAccessTrustProvider ¶ added in v2.80.0
type CfnVerifiedAccessTrustProvider interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggable
// The creation time.
AttrCreationTime() *string
// The last updated time.
AttrLastUpdatedTime() *string
// The ID of the Verified Access trust provider.
AttrVerifiedAccessTrustProviderId() *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 description for the AWS Verified Access trust provider.
Description() *string
SetDescription(val *string)
// The options for device-identity trust provider.
DeviceOptions() interface{}
SetDeviceOptions(val interface{})
// The type of device-based trust provider.
DeviceTrustProviderType() *string
SetDeviceTrustProviderType(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
// The options for an OpenID Connect-compatible user-identity trust provider.
OidcOptions() interface{}
SetOidcOptions(val interface{})
// The identifier to be used when working with policy rules.
PolicyReferenceName() *string
SetPolicyReferenceName(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 options for additional server side encryption.
SseSpecification() interface{}
SetSseSpecification(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
// The tags.
TagsRaw() *[]*awscdk.CfnTag
SetTagsRaw(val *[]*awscdk.CfnTag)
// The type of Verified Access trust provider.
TrustProviderType() *string
SetTrustProviderType(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{}
// The type of user-based trust provider.
UserTrustProviderType() *string
SetUserTrustProviderType(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{})
}
A trust provider is a third-party entity that creates, maintains, and manages identity information for users and devices.
When an application request is made, the identity information sent by the trust provider is evaluated by Verified Access before allowing or denying the application request.
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"
cfnVerifiedAccessTrustProvider := awscdk.Aws_ec2.NewCfnVerifiedAccessTrustProvider(this, jsii.String("MyCfnVerifiedAccessTrustProvider"), &CfnVerifiedAccessTrustProviderProps{
PolicyReferenceName: jsii.String("policyReferenceName"),
TrustProviderType: jsii.String("trustProviderType"),
// the properties below are optional
Description: jsii.String("description"),
DeviceOptions: &DeviceOptionsProperty{
PublicSigningKeyUrl: jsii.String("publicSigningKeyUrl"),
TenantId: jsii.String("tenantId"),
},
DeviceTrustProviderType: jsii.String("deviceTrustProviderType"),
OidcOptions: &OidcOptionsProperty{
AuthorizationEndpoint: jsii.String("authorizationEndpoint"),
ClientId: jsii.String("clientId"),
ClientSecret: jsii.String("clientSecret"),
Issuer: jsii.String("issuer"),
Scope: jsii.String("scope"),
TokenEndpoint: jsii.String("tokenEndpoint"),
UserInfoEndpoint: jsii.String("userInfoEndpoint"),
},
SseSpecification: &SseSpecificationProperty{
CustomerManagedKeyEnabled: jsii.Boolean(false),
KmsKeyArn: jsii.String("kmsKeyArn"),
},
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
UserTrustProviderType: jsii.String("userTrustProviderType"),
})
func NewCfnVerifiedAccessTrustProvider ¶ added in v2.80.0
func NewCfnVerifiedAccessTrustProvider(scope constructs.Construct, id *string, props *CfnVerifiedAccessTrustProviderProps) CfnVerifiedAccessTrustProvider
type CfnVerifiedAccessTrustProviderProps ¶ added in v2.80.0
type CfnVerifiedAccessTrustProviderProps struct {
// The identifier to be used when working with policy rules.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccesstrustprovider.html#cfn-ec2-verifiedaccesstrustprovider-policyreferencename
//
PolicyReferenceName *string `field:"required" json:"policyReferenceName" yaml:"policyReferenceName"`
// The type of Verified Access trust provider.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccesstrustprovider.html#cfn-ec2-verifiedaccesstrustprovider-trustprovidertype
//
TrustProviderType *string `field:"required" json:"trustProviderType" yaml:"trustProviderType"`
// A description for the AWS Verified Access trust provider.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccesstrustprovider.html#cfn-ec2-verifiedaccesstrustprovider-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// The options for device-identity trust provider.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccesstrustprovider.html#cfn-ec2-verifiedaccesstrustprovider-deviceoptions
//
DeviceOptions interface{} `field:"optional" json:"deviceOptions" yaml:"deviceOptions"`
// The type of device-based trust provider.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccesstrustprovider.html#cfn-ec2-verifiedaccesstrustprovider-devicetrustprovidertype
//
DeviceTrustProviderType *string `field:"optional" json:"deviceTrustProviderType" yaml:"deviceTrustProviderType"`
// The options for an OpenID Connect-compatible user-identity trust provider.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccesstrustprovider.html#cfn-ec2-verifiedaccesstrustprovider-oidcoptions
//
OidcOptions interface{} `field:"optional" json:"oidcOptions" yaml:"oidcOptions"`
// The options for additional server side encryption.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccesstrustprovider.html#cfn-ec2-verifiedaccesstrustprovider-ssespecification
//
SseSpecification interface{} `field:"optional" json:"sseSpecification" yaml:"sseSpecification"`
// The tags.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccesstrustprovider.html#cfn-ec2-verifiedaccesstrustprovider-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
// The type of user-based trust provider.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccesstrustprovider.html#cfn-ec2-verifiedaccesstrustprovider-usertrustprovidertype
//
UserTrustProviderType *string `field:"optional" json:"userTrustProviderType" yaml:"userTrustProviderType"`
}
Properties for defining a `CfnVerifiedAccessTrustProvider`.
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"
cfnVerifiedAccessTrustProviderProps := &CfnVerifiedAccessTrustProviderProps{
PolicyReferenceName: jsii.String("policyReferenceName"),
TrustProviderType: jsii.String("trustProviderType"),
// the properties below are optional
Description: jsii.String("description"),
DeviceOptions: &DeviceOptionsProperty{
PublicSigningKeyUrl: jsii.String("publicSigningKeyUrl"),
TenantId: jsii.String("tenantId"),
},
DeviceTrustProviderType: jsii.String("deviceTrustProviderType"),
OidcOptions: &OidcOptionsProperty{
AuthorizationEndpoint: jsii.String("authorizationEndpoint"),
ClientId: jsii.String("clientId"),
ClientSecret: jsii.String("clientSecret"),
Issuer: jsii.String("issuer"),
Scope: jsii.String("scope"),
TokenEndpoint: jsii.String("tokenEndpoint"),
UserInfoEndpoint: jsii.String("userInfoEndpoint"),
},
SseSpecification: &SseSpecificationProperty{
CustomerManagedKeyEnabled: jsii.Boolean(false),
KmsKeyArn: jsii.String("kmsKeyArn"),
},
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
UserTrustProviderType: jsii.String("userTrustProviderType"),
}
type CfnVerifiedAccessTrustProvider_DeviceOptionsProperty ¶ added in v2.80.0
type CfnVerifiedAccessTrustProvider_DeviceOptionsProperty struct {
// The URL AWS Verified Access will use to verify the authenticity of the device tokens.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccesstrustprovider-deviceoptions.html#cfn-ec2-verifiedaccesstrustprovider-deviceoptions-publicsigningkeyurl
//
PublicSigningKeyUrl *string `field:"optional" json:"publicSigningKeyUrl" yaml:"publicSigningKeyUrl"`
// The ID of the tenant application with the device-identity provider.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccesstrustprovider-deviceoptions.html#cfn-ec2-verifiedaccesstrustprovider-deviceoptions-tenantid
//
TenantId *string `field:"optional" json:"tenantId" yaml:"tenantId"`
}
Describes the options for an AWS Verified Access device-identity based trust provider.
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"
deviceOptionsProperty := &DeviceOptionsProperty{
PublicSigningKeyUrl: jsii.String("publicSigningKeyUrl"),
TenantId: jsii.String("tenantId"),
}
type CfnVerifiedAccessTrustProvider_OidcOptionsProperty ¶ added in v2.80.0
type CfnVerifiedAccessTrustProvider_OidcOptionsProperty struct {
// The OIDC authorization endpoint.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccesstrustprovider-oidcoptions.html#cfn-ec2-verifiedaccesstrustprovider-oidcoptions-authorizationendpoint
//
AuthorizationEndpoint *string `field:"optional" json:"authorizationEndpoint" yaml:"authorizationEndpoint"`
// The client identifier.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccesstrustprovider-oidcoptions.html#cfn-ec2-verifiedaccesstrustprovider-oidcoptions-clientid
//
ClientId *string `field:"optional" json:"clientId" yaml:"clientId"`
// The client secret.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccesstrustprovider-oidcoptions.html#cfn-ec2-verifiedaccesstrustprovider-oidcoptions-clientsecret
//
ClientSecret *string `field:"optional" json:"clientSecret" yaml:"clientSecret"`
// The OIDC issuer.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccesstrustprovider-oidcoptions.html#cfn-ec2-verifiedaccesstrustprovider-oidcoptions-issuer
//
Issuer *string `field:"optional" json:"issuer" yaml:"issuer"`
// The OpenID Connect (OIDC) scope specified.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccesstrustprovider-oidcoptions.html#cfn-ec2-verifiedaccesstrustprovider-oidcoptions-scope
//
Scope *string `field:"optional" json:"scope" yaml:"scope"`
// The OIDC token endpoint.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccesstrustprovider-oidcoptions.html#cfn-ec2-verifiedaccesstrustprovider-oidcoptions-tokenendpoint
//
TokenEndpoint *string `field:"optional" json:"tokenEndpoint" yaml:"tokenEndpoint"`
// The OIDC user info endpoint.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccesstrustprovider-oidcoptions.html#cfn-ec2-verifiedaccesstrustprovider-oidcoptions-userinfoendpoint
//
UserInfoEndpoint *string `field:"optional" json:"userInfoEndpoint" yaml:"userInfoEndpoint"`
}
Describes the options for an OpenID Connect-compatible user-identity trust provider.
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"
oidcOptionsProperty := &OidcOptionsProperty{
AuthorizationEndpoint: jsii.String("authorizationEndpoint"),
ClientId: jsii.String("clientId"),
ClientSecret: jsii.String("clientSecret"),
Issuer: jsii.String("issuer"),
Scope: jsii.String("scope"),
TokenEndpoint: jsii.String("tokenEndpoint"),
UserInfoEndpoint: jsii.String("userInfoEndpoint"),
}
type CfnVerifiedAccessTrustProvider_SseSpecificationProperty ¶ added in v2.103.0
type CfnVerifiedAccessTrustProvider_SseSpecificationProperty struct {
// Enable or disable the use of customer managed KMS keys for server side encryption.
//
// Valid values: `True` | `False`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccesstrustprovider-ssespecification.html#cfn-ec2-verifiedaccesstrustprovider-ssespecification-customermanagedkeyenabled
//
CustomerManagedKeyEnabled interface{} `field:"optional" json:"customerManagedKeyEnabled" yaml:"customerManagedKeyEnabled"`
// The ARN of the KMS key.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccesstrustprovider-ssespecification.html#cfn-ec2-verifiedaccesstrustprovider-ssespecification-kmskeyarn
//
KmsKeyArn *string `field:"optional" json:"kmsKeyArn" yaml:"kmsKeyArn"`
}
AWS Verified Access provides server side encryption by default to data at rest using AWS -owned KMS keys.
You also have the option of using customer managed KMS keys, which can be specified using the options below.
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"
sseSpecificationProperty := &SseSpecificationProperty{
CustomerManagedKeyEnabled: jsii.Boolean(false),
KmsKeyArn: jsii.String("kmsKeyArn"),
}
type CfnVolume ¶
type CfnVolume interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggable
// The ID of the volume.
AttrVolumeId() *string
// Indicates whether the volume is auto-enabled for I/O operations.
AutoEnableIo() interface{}
SetAutoEnableIo(val interface{})
// The ID of the Availability Zone in which to create the volume.
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
// Indicates whether the volume should be encrypted.
Encrypted() interface{}
SetEncrypted(val interface{})
// The number of I/O operations per second (IOPS).
Iops() *float64
SetIops(val *float64)
// The identifier of the AWS KMS key to use for Amazon EBS encryption.
KmsKeyId() *string
SetKmsKeyId(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
// Indicates whether Amazon EBS Multi-Attach is enabled.
MultiAttachEnabled() interface{}
SetMultiAttachEnabled(val interface{})
// The tree node.
Node() constructs.Node
// The Amazon Resource Name (ARN) of the Outpost.
OutpostArn() *string
SetOutpostArn(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 size of the volume, in GiBs.
Size() *float64
SetSize(val *float64)
// The snapshot from which to create the volume.
SnapshotId() *string
SetSnapshotId(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
// The tags to apply to the volume during creation.
TagsRaw() *[]*awscdk.CfnTag
SetTagsRaw(val *[]*awscdk.CfnTag)
// The throughput to provision for a volume, with a maximum of 1,000 MiB/s.
Throughput() *float64
SetThroughput(val *float64)
// 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 volume type.
//
// This parameter can be one of the following values:.
VolumeType() *string
SetVolumeType(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{})
}
Specifies an Amazon Elastic Block Store (Amazon EBS) volume.
When you use AWS CloudFormation to update an Amazon EBS volume that modifies `Iops` , `Size` , or `VolumeType` , there is a cooldown period before another operation can occur. This can cause your stack to report being in `UPDATE_IN_PROGRESS` or `UPDATE_ROLLBACK_IN_PROGRESS` for long periods of time.
Amazon EBS does not support sizing down an Amazon EBS volume. AWS CloudFormation does not attempt to modify an Amazon EBS volume to a smaller size on rollback.
Some common scenarios when you might encounter a cooldown period for Amazon EBS include:
- You successfully update an Amazon EBS volume and the update succeeds. When you attempt another update within the cooldown window, that update will be subject to a cooldown period. - You successfully update an Amazon EBS volume and the update succeeds but another change in your `update-stack` call fails. The rollback will be subject to a cooldown period.
For more information, see [Requirements for EBS volume modifications](https://docs.aws.amazon.com/ebs/latest/userguide/modify-volume-requirements.html) .
*DeletionPolicy attribute*
To control how AWS CloudFormation handles the volume when the stack is deleted, set a deletion policy for your volume. You can choose to retain the volume, to delete the volume, or to create a snapshot of the volume. For more information, see [DeletionPolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html) .
> If you set a deletion policy that creates a snapshot, all tags on the volume are included in the snapshot.
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"
cfnVolume := awscdk.Aws_ec2.NewCfnVolume(this, jsii.String("MyCfnVolume"), &CfnVolumeProps{
AvailabilityZone: jsii.String("availabilityZone"),
// the properties below are optional
AutoEnableIo: jsii.Boolean(false),
Encrypted: jsii.Boolean(false),
Iops: jsii.Number(123),
KmsKeyId: jsii.String("kmsKeyId"),
MultiAttachEnabled: jsii.Boolean(false),
OutpostArn: jsii.String("outpostArn"),
Size: jsii.Number(123),
SnapshotId: jsii.String("snapshotId"),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
Throughput: jsii.Number(123),
VolumeType: jsii.String("volumeType"),
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html
func NewCfnVolume ¶
func NewCfnVolume(scope constructs.Construct, id *string, props *CfnVolumeProps) CfnVolume
type CfnVolumeAttachment ¶
type CfnVolumeAttachment interface {
awscdk.CfnResource
awscdk.IInspectable
// 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 device name (for example, `/dev/sdh` or `xvdh` ).
Device() *string
SetDevice(val *string)
// The ID of the instance to which the volume attaches.
InstanceId() *string
SetInstanceId(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{}
// The ID of the Amazon EBS volume.
VolumeId() *string
SetVolumeId(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{})
}
Attaches an Amazon EBS volume to a running instance and exposes it to the instance with the specified device name.
Before this resource can be deleted (and therefore the volume detached), you must first unmount the volume in the instance. Failure to do so results in the volume being stuck in the busy state while it is trying to detach, which could possibly damage the file system or the data it contains.
If an Amazon EBS volume is the root device of an instance, it cannot be detached while the instance is in the "running" state. To detach the root volume, stop the instance first.
If the root volume is detached from an instance with an AWS Marketplace product code, then the product codes from that volume are no longer associated with 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"
cfnVolumeAttachment := awscdk.Aws_ec2.NewCfnVolumeAttachment(this, jsii.String("MyCfnVolumeAttachment"), &CfnVolumeAttachmentProps{
InstanceId: jsii.String("instanceId"),
VolumeId: jsii.String("volumeId"),
// the properties below are optional
Device: jsii.String("device"),
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volumeattachment.html
func NewCfnVolumeAttachment ¶
func NewCfnVolumeAttachment(scope constructs.Construct, id *string, props *CfnVolumeAttachmentProps) CfnVolumeAttachment
type CfnVolumeAttachmentProps ¶
type CfnVolumeAttachmentProps struct {
// The ID of the instance to which the volume attaches.
//
// This value can be a reference to an [`AWS::EC2::Instance`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) resource, or it can be the physical ID of an existing EC2 instance.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volumeattachment.html#cfn-ec2-volumeattachment-instanceid
//
InstanceId *string `field:"required" json:"instanceId" yaml:"instanceId"`
// The ID of the Amazon EBS volume.
//
// The volume and instance must be within the same Availability Zone. This value can be a reference to an [`AWS::EC2::Volume`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volume.html) resource, or it can be the volume ID of an existing Amazon EBS volume.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volumeattachment.html#cfn-ec2-volumeattachment-volumeid
//
VolumeId *string `field:"required" json:"volumeId" yaml:"volumeId"`
// The device name (for example, `/dev/sdh` or `xvdh` ).
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volumeattachment.html#cfn-ec2-volumeattachment-device
//
Device *string `field:"optional" json:"device" yaml:"device"`
}
Properties for defining a `CfnVolumeAttachment`.
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"
cfnVolumeAttachmentProps := &CfnVolumeAttachmentProps{
InstanceId: jsii.String("instanceId"),
VolumeId: jsii.String("volumeId"),
// the properties below are optional
Device: jsii.String("device"),
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volumeattachment.html
type CfnVolumeProps ¶
type CfnVolumeProps struct {
// The ID of the Availability Zone in which to create the volume.
//
// For example, `us-east-1a` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-availabilityzone
//
AvailabilityZone *string `field:"required" json:"availabilityZone" yaml:"availabilityZone"`
// Indicates whether the volume is auto-enabled for I/O operations.
//
// By default, Amazon EBS disables I/O to the volume from attached EC2 instances when it determines that a volume's data is potentially inconsistent. If the consistency of the volume is not a concern, and you prefer that the volume be made available immediately if it's impaired, you can configure the volume to automatically enable I/O.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-autoenableio
//
AutoEnableIo interface{} `field:"optional" json:"autoEnableIo" yaml:"autoEnableIo"`
// Indicates whether the volume should be encrypted.
//
// The effect of setting the encryption state to `true` depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see [Encryption by default](https://docs.aws.amazon.com/ebs/latest/userguide/work-with-ebs-encr.html#encryption-by-default) in the *Amazon EBS User Guide* .
//
// Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see [Supported instance types](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption-requirements.html#ebs-encryption_supported_instances) .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-encrypted
//
Encrypted interface{} `field:"optional" json:"encrypted" yaml:"encrypted"`
// The number of I/O operations per second (IOPS).
//
// For `gp3` , `io1` , and `io2` volumes, this represents the number of IOPS that are provisioned for the volume. For `gp2` volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
//
// The following are the supported values for each volume type:
//
// - `gp3` : 3,000 - 16,000 IOPS
// - `io1` : 100 - 64,000 IOPS
// - `io2` : 100 - 256,000 IOPS
//
// For `io2` volumes, you can achieve up to 256,000 IOPS on [instances built on the Nitro System](https://docs.aws.amazon.com/ec2/latest/instancetypes/ec2-nitro-instances.html) . On other instances, you can achieve performance up to 32,000 IOPS.
//
// This parameter is required for `io1` and `io2` volumes. The default for `gp3` volumes is 3,000 IOPS. This parameter is not supported for `gp2` , `st1` , `sc1` , or `standard` volumes.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-iops
//
Iops *float64 `field:"optional" json:"iops" yaml:"iops"`
// The identifier of the AWS KMS key to use for Amazon EBS encryption.
//
// If `KmsKeyId` is specified, the encrypted state must be `true` .
//
// If you omit this property and your account is enabled for encryption by default, or *Encrypted* is set to `true` , then the volume is encrypted using the default key specified for your account. If your account does not have a default key, then the volume is encrypted using the AWS managed key .
//
// Alternatively, if you want to specify a different key, you can specify one of the following:
//
// - Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
// - Key alias. Specify the alias for the key, prefixed with `alias/` . For example, for a key with the alias `my_cmk` , use `alias/my_cmk` . Or to specify the AWS managed key , use `alias/aws/ebs` .
// - Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
// - Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-kmskeyid
//
KmsKeyId *string `field:"optional" json:"kmsKeyId" yaml:"kmsKeyId"`
// Indicates whether Amazon EBS Multi-Attach is enabled.
//
// AWS CloudFormation does not currently support updating a single-attach volume to be multi-attach enabled, updating a multi-attach enabled volume to be single-attach, or updating the size or number of I/O operations per second (IOPS) of a multi-attach enabled volume.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-multiattachenabled
//
MultiAttachEnabled interface{} `field:"optional" json:"multiAttachEnabled" yaml:"multiAttachEnabled"`
// The Amazon Resource Name (ARN) of the Outpost.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-outpostarn
//
OutpostArn *string `field:"optional" json:"outpostArn" yaml:"outpostArn"`
// The size of the volume, in GiBs.
//
// You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.
//
// The following are the supported volumes sizes for each volume type:
//
// - `gp2` and `gp3` : 1 - 16,384 GiB
// - `io1` : 4 - 16,384 GiB
// - `io2` : 4 - 65,536 GiB
// - `st1` and `sc1` : 125 - 16,384 GiB
// - `standard` : 1 - 1024 GiB.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-size
//
Size *float64 `field:"optional" json:"size" yaml:"size"`
// The snapshot from which to create the volume.
//
// You must specify either a snapshot ID or a volume size.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-snapshotid
//
SnapshotId *string `field:"optional" json:"snapshotId" yaml:"snapshotId"`
// The tags to apply to the volume during creation.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
// The throughput to provision for a volume, with a maximum of 1,000 MiB/s.
//
// This parameter is valid only for `gp3` volumes. The default value is 125.
//
// Valid Range: Minimum value of 125. Maximum value of 1000.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-throughput
//
Throughput *float64 `field:"optional" json:"throughput" yaml:"throughput"`
// The volume type. This parameter can be one of the following values:.
//
// - General Purpose SSD: `gp2` | `gp3`
// - Provisioned IOPS SSD: `io1` | `io2`
// - Throughput Optimized HDD: `st1`
// - Cold HDD: `sc1`
// - Magnetic: `standard`
//
// For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volume-types.html) .
//
// Default: `gp2`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-volumetype
//
VolumeType *string `field:"optional" json:"volumeType" yaml:"volumeType"`
}
Properties for defining a `CfnVolume`.
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"
cfnVolumeProps := &CfnVolumeProps{
AvailabilityZone: jsii.String("availabilityZone"),
// the properties below are optional
AutoEnableIo: jsii.Boolean(false),
Encrypted: jsii.Boolean(false),
Iops: jsii.Number(123),
KmsKeyId: jsii.String("kmsKeyId"),
MultiAttachEnabled: jsii.Boolean(false),
OutpostArn: jsii.String("outpostArn"),
Size: jsii.Number(123),
SnapshotId: jsii.String("snapshotId"),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
Throughput: jsii.Number(123),
VolumeType: jsii.String("volumeType"),
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html
type ClientVpnAuthorizationRule ¶
type ClientVpnAuthorizationRule interface {
awscdk.Resource
// The environment this resource belongs to.
//
// For resources that are created and managed by the CDK
// (generally, those created by creating new class instances like Role, Bucket, etc.),
// this is always the same as the environment of the stack they belong to;
// however, for imported resources
// (those obtained from static methods like fromRoleArn, fromBucketName, etc.),
// that might be different than the stack they were imported into.
Env() *awscdk.ResourceEnvironment
// The tree node.
Node() constructs.Node
// Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
//
// This value will resolve to one of the following:
// - a concrete value (e.g. `"my-awesome-bucket"`)
// - `undefined`, when a name should be generated by CloudFormation
// - a concrete name generated automatically during synthesis, in
// cross-environment scenarios.
PhysicalName() *string
// The stack in which this resource is defined.
Stack() awscdk.Stack
// Apply the given removal policy to this resource.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
GeneratePhysicalName() *string
// Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`).
//
// Normally, this token will resolve to `arnAttr`, but if the resource is
// referenced across environments, `arnComponents` will be used to synthesize
// a concrete ARN with the resource's physical name. Make sure to reference
// `this.physicalName` in `arnComponents`.
GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
// Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`).
//
// Normally, this token will resolve to `nameAttr`, but if the resource is
// referenced across environments, it will be resolved to `this.physicalName`,
// which will be a concrete name.
GetResourceNameAttribute(nameAttr *string) *string
// Returns a string representation of this construct.
ToString() *string
}
A client VPN authorization rule.
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"
var clientVpnEndpoint clientVpnEndpoint
clientVpnAuthorizationRule := awscdk.Aws_ec2.NewClientVpnAuthorizationRule(this, jsii.String("MyClientVpnAuthorizationRule"), &ClientVpnAuthorizationRuleProps{
Cidr: jsii.String("cidr"),
// the properties below are optional
ClientVpnEndpoint: clientVpnEndpoint,
Description: jsii.String("description"),
GroupId: jsii.String("groupId"),
})
func NewClientVpnAuthorizationRule ¶
func NewClientVpnAuthorizationRule(scope constructs.Construct, id *string, props *ClientVpnAuthorizationRuleProps) ClientVpnAuthorizationRule
type ClientVpnAuthorizationRuleOptions ¶
type ClientVpnAuthorizationRuleOptions struct {
// The IPv4 address range, in CIDR notation, of the network for which access is being authorized.
Cidr *string `field:"required" json:"cidr" yaml:"cidr"`
// A brief description of the authorization rule.
// Default: - no description.
//
Description *string `field:"optional" json:"description" yaml:"description"`
// The ID of the group to grant access to, for example, the Active Directory group or identity provider (IdP) group.
// Default: - authorize all groups.
//
GroupId *string `field:"optional" json:"groupId" yaml:"groupId"`
}
Options for a ClientVpnAuthorizationRule.
Example:
endpoint := vpc.addClientVpnEndpoint(jsii.String("Endpoint"), &ClientVpnEndpointOptions{
Cidr: jsii.String("10.100.0.0/16"),
ServerCertificateArn: jsii.String("arn:aws:acm:us-east-1:123456789012:certificate/server-certificate-id"),
UserBasedAuthentication: ec2.ClientVpnUserBasedAuthentication_Federated(samlProvider),
AuthorizeAllUsersToVpcCidr: jsii.Boolean(false),
})
endpoint.AddAuthorizationRule(jsii.String("Rule"), &ClientVpnAuthorizationRuleOptions{
Cidr: jsii.String("10.0.10.0/32"),
GroupId: jsii.String("group-id"),
})
type ClientVpnAuthorizationRuleProps ¶
type ClientVpnAuthorizationRuleProps struct {
// The IPv4 address range, in CIDR notation, of the network for which access is being authorized.
Cidr *string `field:"required" json:"cidr" yaml:"cidr"`
// A brief description of the authorization rule.
// Default: - no description.
//
Description *string `field:"optional" json:"description" yaml:"description"`
// The ID of the group to grant access to, for example, the Active Directory group or identity provider (IdP) group.
// Default: - authorize all groups.
//
GroupId *string `field:"optional" json:"groupId" yaml:"groupId"`
// The client VPN endpoint to which to add the rule.
// Default: clientVpnEndpoint is required.
//
ClientVpnEndpoint IClientVpnEndpoint `field:"optional" json:"clientVpnEndpoint" yaml:"clientVpnEndpoint"`
}
Properties for a ClientVpnAuthorizationRule.
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"
var clientVpnEndpoint clientVpnEndpoint
clientVpnAuthorizationRuleProps := &ClientVpnAuthorizationRuleProps{
Cidr: jsii.String("cidr"),
// the properties below are optional
ClientVpnEndpoint: clientVpnEndpoint,
Description: jsii.String("description"),
GroupId: jsii.String("groupId"),
}
type ClientVpnEndpoint ¶
type ClientVpnEndpoint interface {
awscdk.Resource
IClientVpnEndpoint
// Allows specify security group connections for the endpoint.
Connections() Connections
// The endpoint ID.
EndpointId() *string
// The environment this resource belongs to.
//
// For resources that are created and managed by the CDK
// (generally, those created by creating new class instances like Role, Bucket, etc.),
// this is always the same as the environment of the stack they belong to;
// however, for imported resources
// (those obtained from static methods like fromRoleArn, fromBucketName, etc.),
// that might be different than the stack they were imported into.
Env() *awscdk.ResourceEnvironment
// The tree node.
Node() constructs.Node
// Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
//
// This value will resolve to one of the following:
// - a concrete value (e.g. `"my-awesome-bucket"`)
// - `undefined`, when a name should be generated by CloudFormation
// - a concrete name generated automatically during synthesis, in
// cross-environment scenarios.
PhysicalName() *string
// The stack in which this resource is defined.
Stack() awscdk.Stack
// Dependable that can be depended upon to force target networks associations.
TargetNetworksAssociated() constructs.IDependable
// Adds an authorization rule to this endpoint.
AddAuthorizationRule(id *string, props *ClientVpnAuthorizationRuleOptions) ClientVpnAuthorizationRule
// Adds a route to this endpoint.
AddRoute(id *string, props *ClientVpnRouteOptions) ClientVpnRoute
// Apply the given removal policy to this resource.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
GeneratePhysicalName() *string
// Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`).
//
// Normally, this token will resolve to `arnAttr`, but if the resource is
// referenced across environments, `arnComponents` will be used to synthesize
// a concrete ARN with the resource's physical name. Make sure to reference
// `this.physicalName` in `arnComponents`.
GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
// Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`).
//
// Normally, this token will resolve to `nameAttr`, but if the resource is
// referenced across environments, it will be resolved to `this.physicalName`,
// which will be a concrete name.
GetResourceNameAttribute(nameAttr *string) *string
// Returns a string representation of this construct.
ToString() *string
}
A client VPN connnection.
Example:
endpoint := vpc.addClientVpnEndpoint(jsii.String("Endpoint"), &ClientVpnEndpointOptions{
Cidr: jsii.String("10.100.0.0/16"),
ServerCertificateArn: jsii.String("arn:aws:acm:us-east-1:123456789012:certificate/server-certificate-id"),
UserBasedAuthentication: ec2.ClientVpnUserBasedAuthentication_Federated(samlProvider),
AuthorizeAllUsersToVpcCidr: jsii.Boolean(false),
})
endpoint.AddAuthorizationRule(jsii.String("Rule"), &ClientVpnAuthorizationRuleOptions{
Cidr: jsii.String("10.0.10.0/32"),
GroupId: jsii.String("group-id"),
})
func NewClientVpnEndpoint ¶
func NewClientVpnEndpoint(scope constructs.Construct, id *string, props *ClientVpnEndpointProps) ClientVpnEndpoint
type ClientVpnEndpointAttributes ¶
type ClientVpnEndpointAttributes struct {
// The endpoint ID.
EndpointId *string `field:"required" json:"endpointId" yaml:"endpointId"`
// The security groups associated with the endpoint.
SecurityGroups *[]ISecurityGroup `field:"required" json:"securityGroups" yaml:"securityGroups"`
}
Attributes when importing an existing client VPN endpoint.
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"
var securityGroup securityGroup
clientVpnEndpointAttributes := &ClientVpnEndpointAttributes{
EndpointId: jsii.String("endpointId"),
SecurityGroups: []iSecurityGroup{
securityGroup,
},
}
type ClientVpnEndpointOptions ¶
type ClientVpnEndpointOptions struct {
// The IPv4 address range, in CIDR notation, from which to assign client IP addresses.
//
// The address range cannot overlap with the local CIDR of the VPC
// in which the associated subnet is located, or the routes that you add manually.
//
// Changing the address range will replace the Client VPN endpoint.
//
// The CIDR block should be /22 or greater.
Cidr *string `field:"required" json:"cidr" yaml:"cidr"`
// The ARN of the server certificate.
ServerCertificateArn *string `field:"required" json:"serverCertificateArn" yaml:"serverCertificateArn"`
// Whether to authorize all users to the VPC CIDR.
//
// This automatically creates an authorization rule. Set this to `false` and
// use `addAuthorizationRule()` to create your own rules instead.
// Default: true.
//
AuthorizeAllUsersToVpcCidr *bool `field:"optional" json:"authorizeAllUsersToVpcCidr" yaml:"authorizeAllUsersToVpcCidr"`
// The ARN of the client certificate for mutual authentication.
//
// The certificate must be signed by a certificate authority (CA) and it must
// be provisioned in AWS Certificate Manager (ACM).
// Default: - use user-based authentication.
//
ClientCertificateArn *string `field:"optional" json:"clientCertificateArn" yaml:"clientCertificateArn"`
// The AWS Lambda function used for connection authorization.
//
// The name of the Lambda function must begin with the `AWSClientVPN-` prefix.
// Default: - no connection handler.
//
ClientConnectionHandler IClientVpnConnectionHandler `field:"optional" json:"clientConnectionHandler" yaml:"clientConnectionHandler"`
// Customizable text that will be displayed in a banner on AWS provided clients when a VPN session is established.
//
// UTF-8 encoded characters only. Maximum of 1400 characters.
// Default: - no banner is presented to the client.
//
ClientLoginBanner *string `field:"optional" json:"clientLoginBanner" yaml:"clientLoginBanner"`
// A brief description of the Client VPN endpoint.
// Default: - no description.
//
Description *string `field:"optional" json:"description" yaml:"description"`
// Information about the DNS servers to be used for DNS resolution.
//
// A Client VPN endpoint can have up to two DNS servers.
// Default: - use the DNS address configured on the device.
//
DnsServers *[]*string `field:"optional" json:"dnsServers" yaml:"dnsServers"`
// Whether to enable connections logging.
// Default: true.
//
Logging *bool `field:"optional" json:"logging" yaml:"logging"`
// A CloudWatch Logs log group for connection logging.
// Default: - a new group is created.
//
LogGroup awslogs.ILogGroup `field:"optional" json:"logGroup" yaml:"logGroup"`
// A CloudWatch Logs log stream for connection logging.
// Default: - a new stream is created.
//
LogStream awslogs.ILogStream `field:"optional" json:"logStream" yaml:"logStream"`
// The port number to assign to the Client VPN endpoint for TCP and UDP traffic.
// Default: VpnPort.HTTPS
//
Port VpnPort `field:"optional" json:"port" yaml:"port"`
// The security groups to apply to the target network.
// Default: - a new security group is created.
//
SecurityGroups *[]ISecurityGroup `field:"optional" json:"securityGroups" yaml:"securityGroups"`
// Specify whether to enable the self-service portal for the Client VPN endpoint.
// Default: true.
//
SelfServicePortal *bool `field:"optional" json:"selfServicePortal" yaml:"selfServicePortal"`
// The maximum VPN session duration time.
// Default: ClientVpnSessionTimeout.TWENTY_FOUR_HOURS
//
SessionTimeout ClientVpnSessionTimeout `field:"optional" json:"sessionTimeout" yaml:"sessionTimeout"`
// Indicates whether split-tunnel is enabled on the AWS Client VPN endpoint.
// See: https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/split-tunnel-vpn.html
//
// Default: false.
//
SplitTunnel *bool `field:"optional" json:"splitTunnel" yaml:"splitTunnel"`
// The transport protocol to be used by the VPN session.
// Default: TransportProtocol.UDP
//
TransportProtocol TransportProtocol `field:"optional" json:"transportProtocol" yaml:"transportProtocol"`
// The type of user-based authentication to use.
// See: https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/client-authentication.html
//
// Default: - use mutual authentication.
//
UserBasedAuthentication ClientVpnUserBasedAuthentication `field:"optional" json:"userBasedAuthentication" yaml:"userBasedAuthentication"`
// Subnets to associate to the client VPN endpoint.
// Default: - the VPC default strategy.
//
VpcSubnets *SubnetSelection `field:"optional" json:"vpcSubnets" yaml:"vpcSubnets"`
}
Options for a client VPN endpoint.
Example:
endpoint := vpc.addClientVpnEndpoint(jsii.String("Endpoint"), &ClientVpnEndpointOptions{
Cidr: jsii.String("10.100.0.0/16"),
ServerCertificateArn: jsii.String("arn:aws:acm:us-east-1:123456789012:certificate/server-certificate-id"),
UserBasedAuthentication: ec2.ClientVpnUserBasedAuthentication_Federated(samlProvider),
AuthorizeAllUsersToVpcCidr: jsii.Boolean(false),
})
endpoint.AddAuthorizationRule(jsii.String("Rule"), &ClientVpnAuthorizationRuleOptions{
Cidr: jsii.String("10.0.10.0/32"),
GroupId: jsii.String("group-id"),
})
type ClientVpnEndpointProps ¶
type ClientVpnEndpointProps struct {
// The IPv4 address range, in CIDR notation, from which to assign client IP addresses.
//
// The address range cannot overlap with the local CIDR of the VPC
// in which the associated subnet is located, or the routes that you add manually.
//
// Changing the address range will replace the Client VPN endpoint.
//
// The CIDR block should be /22 or greater.
Cidr *string `field:"required" json:"cidr" yaml:"cidr"`
// The ARN of the server certificate.
ServerCertificateArn *string `field:"required" json:"serverCertificateArn" yaml:"serverCertificateArn"`
// Whether to authorize all users to the VPC CIDR.
//
// This automatically creates an authorization rule. Set this to `false` and
// use `addAuthorizationRule()` to create your own rules instead.
// Default: true.
//
AuthorizeAllUsersToVpcCidr *bool `field:"optional" json:"authorizeAllUsersToVpcCidr" yaml:"authorizeAllUsersToVpcCidr"`
// The ARN of the client certificate for mutual authentication.
//
// The certificate must be signed by a certificate authority (CA) and it must
// be provisioned in AWS Certificate Manager (ACM).
// Default: - use user-based authentication.
//
ClientCertificateArn *string `field:"optional" json:"clientCertificateArn" yaml:"clientCertificateArn"`
// The AWS Lambda function used for connection authorization.
//
// The name of the Lambda function must begin with the `AWSClientVPN-` prefix.
// Default: - no connection handler.
//
ClientConnectionHandler IClientVpnConnectionHandler `field:"optional" json:"clientConnectionHandler" yaml:"clientConnectionHandler"`
// Customizable text that will be displayed in a banner on AWS provided clients when a VPN session is established.
//
// UTF-8 encoded characters only. Maximum of 1400 characters.
// Default: - no banner is presented to the client.
//
ClientLoginBanner *string `field:"optional" json:"clientLoginBanner" yaml:"clientLoginBanner"`
// A brief description of the Client VPN endpoint.
// Default: - no description.
//
Description *string `field:"optional" json:"description" yaml:"description"`
// Information about the DNS servers to be used for DNS resolution.
//
// A Client VPN endpoint can have up to two DNS servers.
// Default: - use the DNS address configured on the device.
//
DnsServers *[]*string `field:"optional" json:"dnsServers" yaml:"dnsServers"`
// Whether to enable connections logging.
// Default: true.
//
Logging *bool `field:"optional" json:"logging" yaml:"logging"`
// A CloudWatch Logs log group for connection logging.
// Default: - a new group is created.
//
LogGroup awslogs.ILogGroup `field:"optional" json:"logGroup" yaml:"logGroup"`
// A CloudWatch Logs log stream for connection logging.
// Default: - a new stream is created.
//
LogStream awslogs.ILogStream `field:"optional" json:"logStream" yaml:"logStream"`
// The port number to assign to the Client VPN endpoint for TCP and UDP traffic.
// Default: VpnPort.HTTPS
//
Port VpnPort `field:"optional" json:"port" yaml:"port"`
// The security groups to apply to the target network.
// Default: - a new security group is created.
//
SecurityGroups *[]ISecurityGroup `field:"optional" json:"securityGroups" yaml:"securityGroups"`
// Specify whether to enable the self-service portal for the Client VPN endpoint.
// Default: true.
//
SelfServicePortal *bool `field:"optional" json:"selfServicePortal" yaml:"selfServicePortal"`
// The maximum VPN session duration time.
// Default: ClientVpnSessionTimeout.TWENTY_FOUR_HOURS
//
SessionTimeout ClientVpnSessionTimeout `field:"optional" json:"sessionTimeout" yaml:"sessionTimeout"`
// Indicates whether split-tunnel is enabled on the AWS Client VPN endpoint.
// See: https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/split-tunnel-vpn.html
//
// Default: false.
//
SplitTunnel *bool `field:"optional" json:"splitTunnel" yaml:"splitTunnel"`
// The transport protocol to be used by the VPN session.
// Default: TransportProtocol.UDP
//
TransportProtocol TransportProtocol `field:"optional" json:"transportProtocol" yaml:"transportProtocol"`
// The type of user-based authentication to use.
// See: https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/client-authentication.html
//
// Default: - use mutual authentication.
//
UserBasedAuthentication ClientVpnUserBasedAuthentication `field:"optional" json:"userBasedAuthentication" yaml:"userBasedAuthentication"`
// Subnets to associate to the client VPN endpoint.
// Default: - the VPC default strategy.
//
VpcSubnets *SubnetSelection `field:"optional" json:"vpcSubnets" yaml:"vpcSubnets"`
// The VPC to connect to.
Vpc IVpc `field:"required" json:"vpc" yaml:"vpc"`
}
Properties for a client VPN endpoint.
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"
import "github.com/aws/aws-cdk-go/awscdk"
var clientVpnConnectionHandler iClientVpnConnectionHandler
var clientVpnUserBasedAuthentication clientVpnUserBasedAuthentication
var logGroup logGroup
var logStream logStream
var securityGroup securityGroup
var subnet subnet
var subnetFilter subnetFilter
var vpc vpc
clientVpnEndpointProps := &ClientVpnEndpointProps{
Cidr: jsii.String("cidr"),
ServerCertificateArn: jsii.String("serverCertificateArn"),
Vpc: vpc,
// the properties below are optional
AuthorizeAllUsersToVpcCidr: jsii.Boolean(false),
ClientCertificateArn: jsii.String("clientCertificateArn"),
ClientConnectionHandler: clientVpnConnectionHandler,
ClientLoginBanner: jsii.String("clientLoginBanner"),
Description: jsii.String("description"),
DnsServers: []*string{
jsii.String("dnsServers"),
},
Logging: jsii.Boolean(false),
LogGroup: logGroup,
LogStream: logStream,
Port: awscdk.Aws_ec2.VpnPort_HTTPS,
SecurityGroups: []iSecurityGroup{
securityGroup,
},
SelfServicePortal: jsii.Boolean(false),
SessionTimeout: awscdk.*Aws_ec2.ClientVpnSessionTimeout_EIGHT_HOURS,
SplitTunnel: jsii.Boolean(false),
TransportProtocol: awscdk.*Aws_ec2.TransportProtocol_TCP,
UserBasedAuthentication: clientVpnUserBasedAuthentication,
VpcSubnets: &SubnetSelection{
AvailabilityZones: []*string{
jsii.String("availabilityZones"),
},
OnePerAz: jsii.Boolean(false),
SubnetFilters: []*subnetFilter{
subnetFilter,
},
SubnetGroupName: jsii.String("subnetGroupName"),
Subnets: []iSubnet{
subnet,
},
SubnetType: awscdk.*Aws_ec2.SubnetType_PRIVATE_ISOLATED,
},
}
type ClientVpnRoute ¶
type ClientVpnRoute interface {
awscdk.Resource
// The environment this resource belongs to.
//
// For resources that are created and managed by the CDK
// (generally, those created by creating new class instances like Role, Bucket, etc.),
// this is always the same as the environment of the stack they belong to;
// however, for imported resources
// (those obtained from static methods like fromRoleArn, fromBucketName, etc.),
// that might be different than the stack they were imported into.
Env() *awscdk.ResourceEnvironment
// The tree node.
Node() constructs.Node
// Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
//
// This value will resolve to one of the following:
// - a concrete value (e.g. `"my-awesome-bucket"`)
// - `undefined`, when a name should be generated by CloudFormation
// - a concrete name generated automatically during synthesis, in
// cross-environment scenarios.
PhysicalName() *string
// The stack in which this resource is defined.
Stack() awscdk.Stack
// Apply the given removal policy to this resource.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
GeneratePhysicalName() *string
// Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`).
//
// Normally, this token will resolve to `arnAttr`, but if the resource is
// referenced across environments, `arnComponents` will be used to synthesize
// a concrete ARN with the resource's physical name. Make sure to reference
// `this.physicalName` in `arnComponents`.
GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
// Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`).
//
// Normally, this token will resolve to `nameAttr`, but if the resource is
// referenced across environments, it will be resolved to `this.physicalName`,
// which will be a concrete name.
GetResourceNameAttribute(nameAttr *string) *string
// Returns a string representation of this construct.
ToString() *string
}
A client VPN route.
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"
var clientVpnEndpoint clientVpnEndpoint
var clientVpnRouteTarget clientVpnRouteTarget
clientVpnRoute := awscdk.Aws_ec2.NewClientVpnRoute(this, jsii.String("MyClientVpnRoute"), &ClientVpnRouteProps{
Cidr: jsii.String("cidr"),
Target: clientVpnRouteTarget,
// the properties below are optional
ClientVpnEndpoint: clientVpnEndpoint,
Description: jsii.String("description"),
})
func NewClientVpnRoute ¶
func NewClientVpnRoute(scope constructs.Construct, id *string, props *ClientVpnRouteProps) ClientVpnRoute
type ClientVpnRouteOptions ¶
type ClientVpnRouteOptions struct {
// The IPv4 address range, in CIDR notation, of the route destination.
//
// For example:
// - To add a route for Internet access, enter 0.0.0.0/0
// - To add a route for a peered VPC, enter the peered VPC's IPv4 CIDR range
// - To add a route for an on-premises network, enter the AWS Site-to-Site VPN
// connection's IPv4 CIDR range
// - To add a route for the local network, enter the client CIDR range.
Cidr *string `field:"required" json:"cidr" yaml:"cidr"`
// The target for the route.
Target ClientVpnRouteTarget `field:"required" json:"target" yaml:"target"`
// A brief description of the authorization rule.
// Default: - no description.
//
Description *string `field:"optional" json:"description" yaml:"description"`
}
Options for a ClientVpnRoute.
Example:
endpoint := vpc.addClientVpnEndpoint(jsii.String("Endpoint"), &ClientVpnEndpointOptions{
Cidr: jsii.String("10.100.0.0/16"),
ServerCertificateArn: jsii.String("arn:aws:acm:us-east-1:123456789012:certificate/server-certificate-id"),
UserBasedAuthentication: ec2.ClientVpnUserBasedAuthentication_Federated(samlProvider),
})
// Client-to-client access
endpoint.AddRoute(jsii.String("Route"), &ClientVpnRouteOptions{
Cidr: jsii.String("10.100.0.0/16"),
Target: ec2.ClientVpnRouteTarget_Local(),
})
type ClientVpnRouteProps ¶
type ClientVpnRouteProps struct {
// The IPv4 address range, in CIDR notation, of the route destination.
//
// For example:
// - To add a route for Internet access, enter 0.0.0.0/0
// - To add a route for a peered VPC, enter the peered VPC's IPv4 CIDR range
// - To add a route for an on-premises network, enter the AWS Site-to-Site VPN
// connection's IPv4 CIDR range
// - To add a route for the local network, enter the client CIDR range.
Cidr *string `field:"required" json:"cidr" yaml:"cidr"`
// The target for the route.
Target ClientVpnRouteTarget `field:"required" json:"target" yaml:"target"`
// A brief description of the authorization rule.
// Default: - no description.
//
Description *string `field:"optional" json:"description" yaml:"description"`
// The client VPN endpoint to which to add the route.
// Default: clientVpnEndpoint is required.
//
ClientVpnEndpoint IClientVpnEndpoint `field:"optional" json:"clientVpnEndpoint" yaml:"clientVpnEndpoint"`
}
Properties for a ClientVpnRoute.
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"
var clientVpnEndpoint clientVpnEndpoint
var clientVpnRouteTarget clientVpnRouteTarget
clientVpnRouteProps := &ClientVpnRouteProps{
Cidr: jsii.String("cidr"),
Target: clientVpnRouteTarget,
// the properties below are optional
ClientVpnEndpoint: clientVpnEndpoint,
Description: jsii.String("description"),
}
type ClientVpnRouteTarget ¶
type ClientVpnRouteTarget interface {
// The subnet ID.
SubnetId() *string
}
Target for a client VPN route.
Example:
endpoint := vpc.addClientVpnEndpoint(jsii.String("Endpoint"), &ClientVpnEndpointOptions{
Cidr: jsii.String("10.100.0.0/16"),
ServerCertificateArn: jsii.String("arn:aws:acm:us-east-1:123456789012:certificate/server-certificate-id"),
UserBasedAuthentication: ec2.ClientVpnUserBasedAuthentication_Federated(samlProvider),
})
// Client-to-client access
endpoint.AddRoute(jsii.String("Route"), &ClientVpnRouteOptions{
Cidr: jsii.String("10.100.0.0/16"),
Target: ec2.ClientVpnRouteTarget_Local(),
})
func ClientVpnRouteTarget_Local ¶
func ClientVpnRouteTarget_Local() ClientVpnRouteTarget
Local network.
func ClientVpnRouteTarget_Subnet ¶
func ClientVpnRouteTarget_Subnet(subnet ISubnet) ClientVpnRouteTarget
Subnet.
The specified subnet must be an existing target network of the client VPN endpoint.
type ClientVpnSessionTimeout ¶ added in v2.10.0
type ClientVpnSessionTimeout string
Maximum VPN session duration time.
const ( // 8 hours. ClientVpnSessionTimeout_EIGHT_HOURS ClientVpnSessionTimeout = "EIGHT_HOURS" // 10 hours. ClientVpnSessionTimeout_TEN_HOURS ClientVpnSessionTimeout = "TEN_HOURS" // 12 hours. ClientVpnSessionTimeout_TWELVE_HOURS ClientVpnSessionTimeout = "TWELVE_HOURS" // 24 hours. ClientVpnSessionTimeout_TWENTY_FOUR_HOURS ClientVpnSessionTimeout = "TWENTY_FOUR_HOURS" )
type ClientVpnUserBasedAuthentication ¶
type ClientVpnUserBasedAuthentication interface {
// Renders the user based authentication.
Render() interface{}
}
User-based authentication for a client VPN endpoint.
Example:
endpoint := vpc.addClientVpnEndpoint(jsii.String("Endpoint"), &ClientVpnEndpointOptions{
Cidr: jsii.String("10.100.0.0/16"),
ServerCertificateArn: jsii.String("arn:aws:acm:us-east-1:123456789012:certificate/server-certificate-id"),
UserBasedAuthentication: ec2.ClientVpnUserBasedAuthentication_Federated(samlProvider),
AuthorizeAllUsersToVpcCidr: jsii.Boolean(false),
})
endpoint.AddAuthorizationRule(jsii.String("Rule"), &ClientVpnAuthorizationRuleOptions{
Cidr: jsii.String("10.0.10.0/32"),
GroupId: jsii.String("group-id"),
})
func ClientVpnUserBasedAuthentication_ActiveDirectory ¶
func ClientVpnUserBasedAuthentication_ActiveDirectory(directoryId *string) ClientVpnUserBasedAuthentication
Active Directory authentication.
func ClientVpnUserBasedAuthentication_Federated ¶
func ClientVpnUserBasedAuthentication_Federated(samlProvider awsiam.ISamlProvider, selfServiceSamlProvider awsiam.ISamlProvider) ClientVpnUserBasedAuthentication
Federated authentication.
type CloudFormationInit ¶
type CloudFormationInit interface {
// Add a config with the given name to this CloudFormationInit object.
AddConfig(configName *string, config InitConfig)
// Add a config set with the given name to this CloudFormationInit object.
//
// The new configset will reference the given configs in the given order.
AddConfigSet(configSetName *string, configNames *[]*string)
// Attach the CloudFormation Init config to the given resource.
//
// As an app builder, use `instance.applyCloudFormationInit()` or
// `autoScalingGroup.applyCloudFormationInit()` to trigger this method.
//
// This method does the following:
//
// - Renders the `AWS::CloudFormation::Init` object to the given resource's
// metadata, potentially adding a `AWS::CloudFormation::Authentication` object
// next to it if required.
// - Updates the instance role policy to be able to call the APIs required for
// `cfn-init` and `cfn-signal` to work, and potentially add permissions to download
// referenced asset and bucket resources.
// - Updates the given UserData with commands to execute the `cfn-init` script.
Attach(attachedResource awscdk.CfnResource, attachOptions *AttachInitOptions)
}
A CloudFormation-init configuration.
Example:
var vpc vpc
var instanceType instanceType
ec2.NewInstance(this, jsii.String("Instance"), &InstanceProps{
Vpc: Vpc,
InstanceType: InstanceType,
MachineImage: ec2.MachineImage_LatestAmazonLinux2023(),
Init: ec2.CloudFormationInit_FromElements(ec2.InitService_SystemdConfigFile(jsii.String("simpleserver"), &SystemdConfigFileOptions{
Command: jsii.String("/usr/bin/python3 -m http.server 8080"),
Cwd: jsii.String("/var/www/html"),
}), ec2.InitService_Enable(jsii.String("simpleserver"), &InitServiceOptions{
ServiceManager: ec2.ServiceManager_SYSTEMD,
}), ec2.InitFile_FromString(jsii.String("/var/www/html/index.html"), jsii.String("Hello! It's working!"))),
})
func CloudFormationInit_FromConfig ¶
func CloudFormationInit_FromConfig(config InitConfig) CloudFormationInit
Use an existing InitConfig object as the default and only config.
func CloudFormationInit_FromConfigSets ¶
func CloudFormationInit_FromConfigSets(props *ConfigSetProps) CloudFormationInit
Build a CloudFormationInit from config sets.
func CloudFormationInit_FromElements ¶
func CloudFormationInit_FromElements(elements ...InitElement) CloudFormationInit
Build a new config from a set of Init Elements.
type CommonNetworkAclEntryOptions ¶
type CommonNetworkAclEntryOptions struct {
// The CIDR range to allow or deny.
Cidr AclCidr `field:"required" json:"cidr" yaml:"cidr"`
// Rule number to assign to the entry, such as 100.
//
// ACL entries are processed in ascending order by rule number.
// Entries can't use the same rule number unless one is an egress rule and the other is an ingress rule.
RuleNumber *float64 `field:"required" json:"ruleNumber" yaml:"ruleNumber"`
// What kind of traffic this ACL rule applies to.
Traffic AclTraffic `field:"required" json:"traffic" yaml:"traffic"`
// Traffic direction, with respect to the subnet, this rule applies to.
// Default: TrafficDirection.INGRESS
//
Direction TrafficDirection `field:"optional" json:"direction" yaml:"direction"`
// The name of the NetworkAclEntry.
//
// It is not recommended to use an explicit group name.
// Default: If you don't specify a NetworkAclName, AWS CloudFormation generates a
// unique physical ID and uses that ID for the group name.
//
NetworkAclEntryName *string `field:"optional" json:"networkAclEntryName" yaml:"networkAclEntryName"`
// Whether to allow or deny traffic that matches the rule; valid values are "allow" or "deny".
//
// Any traffic that is not explicitly allowed is automatically denied in a custom
// ACL, all traffic is automatically allowed in a default ACL.
// Default: ALLOW.
//
RuleAction Action `field:"optional" json:"ruleAction" yaml:"ruleAction"`
}
Basic NetworkACL entry props.
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"
var aclCidr aclCidr
var aclTraffic aclTraffic
commonNetworkAclEntryOptions := &CommonNetworkAclEntryOptions{
Cidr: aclCidr,
RuleNumber: jsii.Number(123),
Traffic: aclTraffic,
// the properties below are optional
Direction: awscdk.Aws_ec2.TrafficDirection_EGRESS,
NetworkAclEntryName: jsii.String("networkAclEntryName"),
RuleAction: awscdk.*Aws_ec2.Action_ALLOW,
}
type ConfigSetProps ¶
type ConfigSetProps struct {
// The sets of configs to pick from.
Configs *map[string]InitConfig `field:"required" json:"configs" yaml:"configs"`
// The definitions of each config set.
ConfigSets *map[string]*[]*string `field:"required" json:"configSets" yaml:"configSets"`
}
Options for CloudFormationInit.withConfigSets.
Example:
var vpc vpc
var instanceType instanceType
var machineImage iMachineImage
ec2.NewInstance(this, jsii.String("Instance"), &InstanceProps{
Vpc: Vpc,
InstanceType: InstanceType,
MachineImage: MachineImage,
// Showing the most complex setup, if you have simpler requirements
// you can use `CloudFormationInit.fromElements()`.
Init: ec2.CloudFormationInit_FromConfigSets(&ConfigSetProps{
ConfigSets: map[string][]*string{
// Applies the configs below in this order
"default": []*string{
jsii.String("yumPreinstall"),
jsii.String("config"),
},
},
Configs: map[string]initConfig{
"yumPreinstall": ec2.NewInitConfig([]InitElement{
ec2.InitPackage_yum(jsii.String("git")),
}),
"config": ec2.NewInitConfig([]InitElement{
ec2.InitFile_fromObject(jsii.String("/etc/stack.json"), map[string]interface{}{
"stackId": awscdk.*stack_of(this).stackId,
"stackName": awscdk.*stack_of(this).stackName,
"region": awscdk.*stack_of(this).region,
}),
ec2.InitGroup_fromName(jsii.String("my-group")),
ec2.InitUser_fromName(jsii.String("my-user")),
ec2.InitPackage_rpm(jsii.String("http://mirrors.ukfast.co.uk/sites/dl.fedoraproject.org/pub/epel/8/Everything/x86_64/Packages/r/rubygem-git-1.5.0-2.el8.noarch.rpm")),
}),
},
}),
InitOptions: &ApplyCloudFormationInitOptions{
// Optional, which configsets to activate (['default'] by default)
ConfigSets: []*string{
jsii.String("default"),
},
// Optional, how long the installation is expected to take (5 minutes by default)
Timeout: awscdk.Duration_Minutes(jsii.Number(30)),
// Optional, whether to include the --url argument when running cfn-init and cfn-signal commands (false by default)
IncludeUrl: jsii.Boolean(true),
// Optional, whether to include the --role argument when running cfn-init and cfn-signal commands (false by default)
IncludeRole: jsii.Boolean(true),
},
})
type ConfigureNatOptions ¶
type ConfigureNatOptions struct {
// The public subnets where the NAT providers need to be placed.
NatSubnets *[]PublicSubnet `field:"required" json:"natSubnets" yaml:"natSubnets"`
// The private subnets that need to route through the NAT providers.
//
// There may be more private subnets than public subnets with NAT providers.
PrivateSubnets *[]PrivateSubnet `field:"required" json:"privateSubnets" yaml:"privateSubnets"`
// The VPC we're configuring NAT for.
Vpc Vpc `field:"required" json:"vpc" yaml:"vpc"`
}
Options passed by the VPC when NAT needs to be configured.
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"
var privateSubnet privateSubnet
var publicSubnet publicSubnet
var vpc vpc
configureNatOptions := &ConfigureNatOptions{
NatSubnets: []*publicSubnet{
publicSubnet,
},
PrivateSubnets: []*privateSubnet{
privateSubnet,
},
Vpc: vpc,
}
type ConnectionRule ¶
type ConnectionRule struct {
// Start of port range for the TCP and UDP protocols, or an ICMP type number.
//
// If you specify icmp for the IpProtocol property, you can specify
// -1 as a wildcard (i.e., any ICMP type number).
FromPort *float64 `field:"required" json:"fromPort" yaml:"fromPort"`
// Description of this connection.
//
// It is applied to both the ingress rule
// and the egress rule.
// Default: No description.
//
Description *string `field:"optional" json:"description" yaml:"description"`
// The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers).
//
// Use -1 to specify all protocols. If you specify -1, or a protocol number
// other than tcp, udp, icmp, or 58 (ICMPv6), traffic on all ports is
// allowed, regardless of any ports you specify. For tcp, udp, and icmp, you
// must specify a port range. For protocol 58 (ICMPv6), you can optionally
// specify a port range; if you don't, traffic for all types and codes is
// allowed.
// Default: tcp.
//
Protocol *string `field:"optional" json:"protocol" yaml:"protocol"`
// End of port range for the TCP and UDP protocols, or an ICMP code.
//
// If you specify icmp for the IpProtocol property, you can specify -1 as a
// wildcard (i.e., any ICMP code).
// Default: If toPort is not specified, it will be the same as fromPort.
//
ToPort *float64 `field:"optional" json:"toPort" yaml:"toPort"`
}
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"
connectionRule := &ConnectionRule{
FromPort: jsii.Number(123),
// the properties below are optional
Description: jsii.String("description"),
Protocol: jsii.String("protocol"),
ToPort: jsii.Number(123),
}
type Connections ¶
type Connections interface {
IConnectable
// The network connections associated with this resource.
Connections() Connections
// The default port configured for this connection peer, if available.
DefaultPort() Port
SecurityGroups() *[]ISecurityGroup
// Add a security group to the list of security groups managed by this object.
AddSecurityGroup(securityGroups ...ISecurityGroup)
// Allow connections from the peer on our default port.
//
// Even if the peer has a default port, we will always use our default port.
AllowDefaultPortFrom(other IConnectable, description *string)
// Allow default connections from all IPv4 ranges.
AllowDefaultPortFromAnyIpv4(description *string)
// Allow hosts inside the security group to connect to each other.
AllowDefaultPortInternally(description *string)
// Allow connections from the peer on our default port.
//
// Even if the peer has a default port, we will always use our default port.
AllowDefaultPortTo(other IConnectable, description *string)
// Allow connections from the peer on the given port.
AllowFrom(other IConnectable, portRange Port, description *string)
// Allow from any IPv4 ranges.
AllowFromAnyIpv4(portRange Port, description *string)
// Allow hosts inside the security group to connect to each other on the given port.
AllowInternally(portRange Port, description *string)
// Allow connections to the peer on the given port.
AllowTo(other IConnectable, portRange Port, description *string)
// Allow to all IPv4 ranges.
AllowToAnyIpv4(portRange Port, description *string)
// Allow connections to the security group on their default port.
AllowToDefaultPort(other IConnectable, description *string)
}
Manage the allowed network connections for constructs with Security Groups.
Security Groups can be thought of as a firewall for network-connected devices. This class makes it easy to allow network connections to and from security groups, and between security groups individually. When establishing connectivity between security groups, it will automatically add rules in both security groups
This object can manage one or more security groups.
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"
var peer iPeer
var port port
var securityGroup securityGroup
connections := awscdk.Aws_ec2.NewConnections(&ConnectionsProps{
DefaultPort: port,
Peer: peer,
SecurityGroups: []iSecurityGroup{
securityGroup,
},
})
func NewConnections ¶
func NewConnections(props *ConnectionsProps) Connections
type ConnectionsProps ¶
type ConnectionsProps struct {
// Default port range for initiating connections to and from this object.
// Default: - No default port.
//
DefaultPort Port `field:"optional" json:"defaultPort" yaml:"defaultPort"`
// Class that represents the rule by which others can connect to this connectable.
//
// This object is required, but will be derived from securityGroup if that is passed.
// Default: Derived from securityGroup if set.
//
Peer IPeer `field:"optional" json:"peer" yaml:"peer"`
// What securityGroup(s) this object is managing connections for.
// Default: No security groups.
//
SecurityGroups *[]ISecurityGroup `field:"optional" json:"securityGroups" yaml:"securityGroups"`
}
Properties to intialize a new Connections object.
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"
var peer iPeer
var port port
var securityGroup securityGroup
connectionsProps := &ConnectionsProps{
DefaultPort: port,
Peer: peer,
SecurityGroups: []iSecurityGroup{
securityGroup,
},
}
type CpuCredits ¶
type CpuCredits string
Provides the options for specifying the CPU credit type for burstable EC2 instance types (T2, T3, T3a, etc).
Example:
var vpc vpc
instance := ec2.NewInstance(this, jsii.String("Instance"), &InstanceProps{
InstanceType: ec2.InstanceType_Of(ec2.InstanceClass_T3, ec2.InstanceSize_MICRO),
MachineImage: ec2.MachineImage_LatestAmazonLinux2(),
Vpc: vpc,
CreditSpecification: ec2.CpuCredits_STANDARD,
})
See: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances-how-to.html
const ( // Standard bursting mode. // See: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances-standard-mode.html // CpuCredits_STANDARD CpuCredits = "STANDARD" // Unlimited bursting mode. // See: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances-unlimited-mode.html // CpuCredits_UNLIMITED CpuCredits = "UNLIMITED" )
type CreateIpv6CidrBlocksRequest ¶ added in v2.121.0
type CreateIpv6CidrBlocksRequest struct {
// The IPv6 CIDR block string representation.
Ipv6SelectedCidr *string `field:"required" json:"ipv6SelectedCidr" yaml:"ipv6SelectedCidr"`
// The number of subnets to assign CIDRs to.
SubnetCount *float64 `field:"required" json:"subnetCount" yaml:"subnetCount"`
// Size of the covered bits in the CIDR.
// Default: - 128 - 64 = /64 CIDR.
//
SizeMask *string `field:"optional" json:"sizeMask" yaml:"sizeMask"`
}
Request for IPv6 CIDR block to be split up.
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"
createIpv6CidrBlocksRequest := &CreateIpv6CidrBlocksRequest{
Ipv6SelectedCidr: jsii.String("ipv6SelectedCidr"),
SubnetCount: jsii.Number(123),
// the properties below are optional
SizeMask: jsii.String("sizeMask"),
}
type DefaultInstanceTenancy ¶
type DefaultInstanceTenancy string
The default tenancy of instances launched into the VPC.
const ( // Instances can be launched with any tenancy. DefaultInstanceTenancy_DEFAULT DefaultInstanceTenancy = "DEFAULT" // Any instance launched into the VPC automatically has dedicated tenancy, unless you launch it with the default tenancy. DefaultInstanceTenancy_DEDICATED DefaultInstanceTenancy = "DEDICATED" )
type DestinationOptions ¶ added in v2.31.0
type DestinationOptions struct {
// The format for the flow log.
// Default: FlowLogFileFormat.PLAIN_TEXT
//
FileFormat FlowLogFileFormat `field:"optional" json:"fileFormat" yaml:"fileFormat"`
// Use Hive-compatible prefixes for flow logs stored in Amazon S3.
// Default: false.
//
HiveCompatiblePartitions *bool `field:"optional" json:"hiveCompatiblePartitions" yaml:"hiveCompatiblePartitions"`
// Partition the flow log per hour.
// Default: false.
//
PerHourPartition *bool `field:"optional" json:"perHourPartition" yaml:"perHourPartition"`
}
Options for writing logs to a destination.
TODO: there are other destination options, currently they are only for s3 destinations (not sure if that will change).
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"
destinationOptions := &DestinationOptions{
FileFormat: awscdk.Aws_ec2.FlowLogFileFormat_PLAIN_TEXT,
HiveCompatiblePartitions: jsii.Boolean(false),
PerHourPartition: jsii.Boolean(false),
}
type EbsDeviceOptions ¶
type EbsDeviceOptions struct {
// Indicates whether to delete the volume when the instance is terminated.
// Default: - true for Amazon EC2 Auto Scaling, false otherwise (e.g. EBS)
//
DeleteOnTermination *bool `field:"optional" json:"deleteOnTermination" yaml:"deleteOnTermination"`
// The number of I/O operations per second (IOPS) to provision for the volume.
//
// Must only be set for `volumeType`: `EbsDeviceVolumeType.IO1`
//
// The maximum ratio of IOPS to volume size (in GiB) is 50:1, so for 5,000 provisioned IOPS,
// you need at least 100 GiB storage on the volume.
// See: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html
//
// Default: - none, required for `EbsDeviceVolumeType.IO1`
//
Iops *float64 `field:"optional" json:"iops" yaml:"iops"`
// The throughput to provision for a `gp3` volume.
//
// Valid Range: Minimum value of 125. Maximum value of 1000.
//
// `gp3` volumes deliver a consistent baseline throughput performance of 125 MiB/s.
// You can provision additional throughput for an additional cost at a ratio of 0.25 MiB/s per provisioned IOPS.
// See: https://docs.aws.amazon.com/ebs/latest/userguide/general-purpose.html#gp3-performance
//
// Default: - 125 MiB/s.
//
Throughput *float64 `field:"optional" json:"throughput" yaml:"throughput"`
// The EBS volume type.
// See: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html
//
// Default: `EbsDeviceVolumeType.GENERAL_PURPOSE_SSD` or `EbsDeviceVolumeType.GENERAL_PURPOSE_SSD_GP3` if
// `@aws-cdk/aws-ec2:ebsDefaultGp3Volume` is enabled.
//
VolumeType EbsDeviceVolumeType `field:"optional" json:"volumeType" yaml:"volumeType"`
// Specifies whether the EBS volume is encrypted.
//
// Encrypted EBS volumes can only be attached to instances that support Amazon EBS encryption.
// See: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#EBSEncryption_supported_instances
//
// Default: false.
//
Encrypted *bool `field:"optional" json:"encrypted" yaml:"encrypted"`
// The ARN of the AWS Key Management Service (AWS KMS) CMK used for encryption.
//
// You have to ensure that the KMS CMK has the correct permissions to be used by the service launching the ec2 instances.
// See: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#ebs-encryption-requirements
//
// Default: - If encrypted is true, the default aws/ebs KMS key will be used.
//
KmsKey awskms.IKey `field:"optional" json:"kmsKey" yaml:"kmsKey"`
}
Block device options for an EBS volume.
Example:
var vpc vpc
var instanceType instanceType
var machineImage iMachineImage
ec2.NewInstance(this, jsii.String("Instance"), &InstanceProps{
Vpc: Vpc,
InstanceType: InstanceType,
MachineImage: MachineImage,
// ...
BlockDevices: []blockDevice{
&blockDevice{
DeviceName: jsii.String("/dev/sda1"),
Volume: ec2.BlockDeviceVolume_Ebs(jsii.Number(100), &EbsDeviceOptions{
VolumeType: ec2.EbsDeviceVolumeType_GP3,
Throughput: jsii.Number(250),
}),
},
},
})
type EbsDeviceOptionsBase ¶
type EbsDeviceOptionsBase struct {
// Indicates whether to delete the volume when the instance is terminated.
// Default: - true for Amazon EC2 Auto Scaling, false otherwise (e.g. EBS)
//
DeleteOnTermination *bool `field:"optional" json:"deleteOnTermination" yaml:"deleteOnTermination"`
// The number of I/O operations per second (IOPS) to provision for the volume.
//
// Must only be set for `volumeType`: `EbsDeviceVolumeType.IO1`
//
// The maximum ratio of IOPS to volume size (in GiB) is 50:1, so for 5,000 provisioned IOPS,
// you need at least 100 GiB storage on the volume.
// See: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html
//
// Default: - none, required for `EbsDeviceVolumeType.IO1`
//
Iops *float64 `field:"optional" json:"iops" yaml:"iops"`
// The throughput to provision for a `gp3` volume.
//
// Valid Range: Minimum value of 125. Maximum value of 1000.
//
// `gp3` volumes deliver a consistent baseline throughput performance of 125 MiB/s.
// You can provision additional throughput for an additional cost at a ratio of 0.25 MiB/s per provisioned IOPS.
// See: https://docs.aws.amazon.com/ebs/latest/userguide/general-purpose.html#gp3-performance
//
// Default: - 125 MiB/s.
//
Throughput *float64 `field:"optional" json:"throughput" yaml:"throughput"`
// The EBS volume type.
// See: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html
//
// Default: `EbsDeviceVolumeType.GENERAL_PURPOSE_SSD` or `EbsDeviceVolumeType.GENERAL_PURPOSE_SSD_GP3` if
// `@aws-cdk/aws-ec2:ebsDefaultGp3Volume` is enabled.
//
VolumeType EbsDeviceVolumeType `field:"optional" json:"volumeType" yaml:"volumeType"`
}
Base block device options for an EBS volume.
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"
ebsDeviceOptionsBase := &EbsDeviceOptionsBase{
DeleteOnTermination: jsii.Boolean(false),
Iops: jsii.Number(123),
Throughput: jsii.Number(123),
VolumeType: awscdk.Aws_ec2.EbsDeviceVolumeType_STANDARD,
}
type EbsDeviceProps ¶
type EbsDeviceProps struct {
// Indicates whether to delete the volume when the instance is terminated.
// Default: - true for Amazon EC2 Auto Scaling, false otherwise (e.g. EBS)
//
DeleteOnTermination *bool `field:"optional" json:"deleteOnTermination" yaml:"deleteOnTermination"`
// The number of I/O operations per second (IOPS) to provision for the volume.
//
// Must only be set for `volumeType`: `EbsDeviceVolumeType.IO1`
//
// The maximum ratio of IOPS to volume size (in GiB) is 50:1, so for 5,000 provisioned IOPS,
// you need at least 100 GiB storage on the volume.
// See: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html
//
// Default: - none, required for `EbsDeviceVolumeType.IO1`
//
Iops *float64 `field:"optional" json:"iops" yaml:"iops"`
// The throughput to provision for a `gp3` volume.
//
// Valid Range: Minimum value of 125. Maximum value of 1000.
//
// `gp3` volumes deliver a consistent baseline throughput performance of 125 MiB/s.
// You can provision additional throughput for an additional cost at a ratio of 0.25 MiB/s per provisioned IOPS.
// See: https://docs.aws.amazon.com/ebs/latest/userguide/general-purpose.html#gp3-performance
//
// Default: - 125 MiB/s.
//
Throughput *float64 `field:"optional" json:"throughput" yaml:"throughput"`
// The EBS volume type.
// See: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html
//
// Default: `EbsDeviceVolumeType.GENERAL_PURPOSE_SSD` or `EbsDeviceVolumeType.GENERAL_PURPOSE_SSD_GP3` if
// `@aws-cdk/aws-ec2:ebsDefaultGp3Volume` is enabled.
//
VolumeType EbsDeviceVolumeType `field:"optional" json:"volumeType" yaml:"volumeType"`
// The volume size, in Gibibytes (GiB).
//
// If you specify volumeSize, it must be equal or greater than the size of the snapshot.
// Default: - The snapshot size.
//
VolumeSize *float64 `field:"optional" json:"volumeSize" yaml:"volumeSize"`
// Specifies whether the EBS volume is encrypted.
//
// Encrypted EBS volumes can only be attached to instances that support Amazon EBS encryption.
// See: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#EBSEncryption_supported_instances
//
// Default: false.
//
Encrypted *bool `field:"optional" json:"encrypted" yaml:"encrypted"`
// The ARN of the AWS Key Management Service (AWS KMS) CMK used for encryption.
//
// You have to ensure that the KMS CMK has the correct permissions to be used by the service launching the ec2 instances.
// See: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#ebs-encryption-requirements
//
// Default: - If encrypted is true, the default aws/ebs KMS key will be used.
//
KmsKey awskms.IKey `field:"optional" json:"kmsKey" yaml:"kmsKey"`
// The snapshot ID of the volume to use.
// Default: - No snapshot will be used.
//
SnapshotId *string `field:"optional" json:"snapshotId" yaml:"snapshotId"`
}
Properties of an EBS block device.
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"
import "github.com/aws/aws-cdk-go/awscdk"
var key key
ebsDeviceProps := &EbsDeviceProps{
DeleteOnTermination: jsii.Boolean(false),
Encrypted: jsii.Boolean(false),
Iops: jsii.Number(123),
KmsKey: key,
SnapshotId: jsii.String("snapshotId"),
Throughput: jsii.Number(123),
VolumeSize: jsii.Number(123),
VolumeType: awscdk.Aws_ec2.EbsDeviceVolumeType_STANDARD,
}
type EbsDeviceSnapshotOptions ¶
type EbsDeviceSnapshotOptions struct {
// Indicates whether to delete the volume when the instance is terminated.
// Default: - true for Amazon EC2 Auto Scaling, false otherwise (e.g. EBS)
//
DeleteOnTermination *bool `field:"optional" json:"deleteOnTermination" yaml:"deleteOnTermination"`
// The number of I/O operations per second (IOPS) to provision for the volume.
//
// Must only be set for `volumeType`: `EbsDeviceVolumeType.IO1`
//
// The maximum ratio of IOPS to volume size (in GiB) is 50:1, so for 5,000 provisioned IOPS,
// you need at least 100 GiB storage on the volume.
// See: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html
//
// Default: - none, required for `EbsDeviceVolumeType.IO1`
//
Iops *float64 `field:"optional" json:"iops" yaml:"iops"`
// The throughput to provision for a `gp3` volume.
//
// Valid Range: Minimum value of 125. Maximum value of 1000.
//
// `gp3` volumes deliver a consistent baseline throughput performance of 125 MiB/s.
// You can provision additional throughput for an additional cost at a ratio of 0.25 MiB/s per provisioned IOPS.
// See: https://docs.aws.amazon.com/ebs/latest/userguide/general-purpose.html#gp3-performance
//
// Default: - 125 MiB/s.
//
Throughput *float64 `field:"optional" json:"throughput" yaml:"throughput"`
// The EBS volume type.
// See: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html
//
// Default: `EbsDeviceVolumeType.GENERAL_PURPOSE_SSD` or `EbsDeviceVolumeType.GENERAL_PURPOSE_SSD_GP3` if
// `@aws-cdk/aws-ec2:ebsDefaultGp3Volume` is enabled.
//
VolumeType EbsDeviceVolumeType `field:"optional" json:"volumeType" yaml:"volumeType"`
// The volume size, in Gibibytes (GiB).
//
// If you specify volumeSize, it must be equal or greater than the size of the snapshot.
// Default: - The snapshot size.
//
VolumeSize *float64 `field:"optional" json:"volumeSize" yaml:"volumeSize"`
}
Block device options for an EBS volume created from a snapshot.
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"
ebsDeviceSnapshotOptions := &EbsDeviceSnapshotOptions{
DeleteOnTermination: jsii.Boolean(false),
Iops: jsii.Number(123),
Throughput: jsii.Number(123),
VolumeSize: jsii.Number(123),
VolumeType: awscdk.Aws_ec2.EbsDeviceVolumeType_STANDARD,
}
type EbsDeviceVolumeType ¶
type EbsDeviceVolumeType string
Supported EBS volume types for blockDevices.
Example:
var vpc vpc
var instanceType instanceType
var machineImage iMachineImage
ec2.NewInstance(this, jsii.String("Instance"), &InstanceProps{
Vpc: Vpc,
InstanceType: InstanceType,
MachineImage: MachineImage,
// ...
BlockDevices: []blockDevice{
&blockDevice{
DeviceName: jsii.String("/dev/sda1"),
Volume: ec2.BlockDeviceVolume_Ebs(jsii.Number(100), &EbsDeviceOptions{
VolumeType: ec2.EbsDeviceVolumeType_GP3,
Throughput: jsii.Number(250),
}),
},
},
})
const ( // Magnetic. EbsDeviceVolumeType_STANDARD EbsDeviceVolumeType = "STANDARD" // Provisioned IOPS SSD - IO1. EbsDeviceVolumeType_IO1 EbsDeviceVolumeType = "IO1" // Provisioned IOPS SSD - IO2. EbsDeviceVolumeType_IO2 EbsDeviceVolumeType = "IO2" // General Purpose SSD - GP2. EbsDeviceVolumeType_GP2 EbsDeviceVolumeType = "GP2" // General Purpose SSD - GP3. EbsDeviceVolumeType_GP3 EbsDeviceVolumeType = "GP3" // Throughput Optimized HDD. EbsDeviceVolumeType_ST1 EbsDeviceVolumeType = "ST1" // Cold HDD. EbsDeviceVolumeType_SC1 EbsDeviceVolumeType = "SC1" )
type EnableVpnGatewayOptions ¶
type EnableVpnGatewayOptions struct {
// Default type ipsec.1.
Type *string `field:"required" json:"type" yaml:"type"`
// Explicitly specify an Asn or let aws pick an Asn for you.
// Default: 65000.
//
AmazonSideAsn *float64 `field:"optional" json:"amazonSideAsn" yaml:"amazonSideAsn"`
// Provide an array of subnets where the route propagation should be added.
// Default: noPropagation.
//
VpnRoutePropagation *[]*SubnetSelection `field:"optional" json:"vpnRoutePropagation" yaml:"vpnRoutePropagation"`
}
Options for the Vpc.enableVpnGateway() method.
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"
var subnet subnet
var subnetFilter subnetFilter
enableVpnGatewayOptions := &EnableVpnGatewayOptions{
Type: jsii.String("type"),
// the properties below are optional
AmazonSideAsn: jsii.Number(123),
VpnRoutePropagation: []subnetSelection{
&subnetSelection{
AvailabilityZones: []*string{
jsii.String("availabilityZones"),
},
OnePerAz: jsii.Boolean(false),
SubnetFilters: []*subnetFilter{
subnetFilter,
},
SubnetGroupName: jsii.String("subnetGroupName"),
Subnets: []iSubnet{
subnet,
},
SubnetType: awscdk.Aws_ec2.SubnetType_PRIVATE_ISOLATED,
},
},
}
type ExecuteFileOptions ¶
type ExecuteFileOptions struct {
// The path to the file.
FilePath *string `field:"required" json:"filePath" yaml:"filePath"`
// The arguments to be passed to the file.
// Default: No arguments are passed to the file.
//
Arguments *string `field:"optional" json:"arguments" yaml:"arguments"`
}
Options when executing a file.
Example:
import "github.com/aws/aws-cdk-go/awscdk"
var instance instance
asset := awscdk.NewAsset(this, jsii.String("Asset"), &AssetProps{
Path: jsii.String("./configure.sh"),
})
localPath := instance.UserData.AddS3DownloadCommand(&S3DownloadOptions{
Bucket: asset.Bucket,
BucketKey: asset.S3ObjectKey,
Region: jsii.String("us-east-1"),
})
instance.UserData.AddExecuteFileCommand(&ExecuteFileOptions{
FilePath: localPath,
Arguments: jsii.String("--verbose -y"),
})
asset.GrantRead(instance.Role)
type FlowLog ¶
type FlowLog interface {
awscdk.Resource
IFlowLog
// The S3 bucket to publish flow logs to.
Bucket() awss3.IBucket
// The ARN of the Kinesis Data Firehose delivery stream to publish flow logs to.
DeliveryStreamArn() *string
// The environment this resource belongs to.
//
// For resources that are created and managed by the CDK
// (generally, those created by creating new class instances like Role, Bucket, etc.),
// this is always the same as the environment of the stack they belong to;
// however, for imported resources
// (those obtained from static methods like fromRoleArn, fromBucketName, etc.),
// that might be different than the stack they were imported into.
Env() *awscdk.ResourceEnvironment
// The Id of the VPC Flow Log.
FlowLogId() *string
// The iam role used to publish logs to CloudWatch.
IamRole() awsiam.IRole
// S3 bucket key prefix to publish the flow logs under.
KeyPrefix() *string
// The CloudWatch Logs LogGroup to publish flow logs to.
LogGroup() awslogs.ILogGroup
// The tree node.
Node() constructs.Node
// Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
//
// This value will resolve to one of the following:
// - a concrete value (e.g. `"my-awesome-bucket"`)
// - `undefined`, when a name should be generated by CloudFormation
// - a concrete name generated automatically during synthesis, in
// cross-environment scenarios.
PhysicalName() *string
// The stack in which this resource is defined.
Stack() awscdk.Stack
// Apply the given removal policy to this resource.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
GeneratePhysicalName() *string
// Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`).
//
// Normally, this token will resolve to `arnAttr`, but if the resource is
// referenced across environments, `arnComponents` will be used to synthesize
// a concrete ARN with the resource's physical name. Make sure to reference
// `this.physicalName` in `arnComponents`.
GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
// Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`).
//
// Normally, this token will resolve to `nameAttr`, but if the resource is
// referenced across environments, it will be resolved to `this.physicalName`,
// which will be a concrete name.
GetResourceNameAttribute(nameAttr *string) *string
// Returns a string representation of this construct.
ToString() *string
}
A VPC flow log.
Example:
var tgw cfnTransitGateway
ec2.NewFlowLog(this, jsii.String("TransitGatewayFlowLog"), &FlowLogProps{
ResourceType: ec2.FlowLogResourceType_FromTransitGatewayId(tgw.ref),
})
func NewFlowLog ¶
func NewFlowLog(scope constructs.Construct, id *string, props *FlowLogProps) FlowLog
type FlowLogDestination ¶
type FlowLogDestination interface {
// Generates a flow log destination configuration.
Bind(scope constructs.Construct, flowLog FlowLog) *FlowLogDestinationConfig
}
The destination type for the flow log.
Example:
var vpc vpc
logGroup := logs.NewLogGroup(this, jsii.String("MyCustomLogGroup"))
role := iam.NewRole(this, jsii.String("MyCustomRole"), &RoleProps{
AssumedBy: iam.NewServicePrincipal(jsii.String("vpc-flow-logs.amazonaws.com")),
})
ec2.NewFlowLog(this, jsii.String("FlowLog"), &FlowLogProps{
ResourceType: ec2.FlowLogResourceType_FromVpc(vpc),
Destination: ec2.FlowLogDestination_ToCloudWatchLogs(logGroup, role),
})
func FlowLogDestination_ToCloudWatchLogs ¶
func FlowLogDestination_ToCloudWatchLogs(logGroup awslogs.ILogGroup, iamRole awsiam.IRole) FlowLogDestination
Use CloudWatch logs as the destination.
func FlowLogDestination_ToKinesisDataFirehoseDestination ¶ added in v2.106.0
func FlowLogDestination_ToKinesisDataFirehoseDestination(deliveryStreamArn *string) FlowLogDestination
Use Kinesis Data Firehose as the destination.
func FlowLogDestination_ToS3 ¶
func FlowLogDestination_ToS3(bucket awss3.IBucket, keyPrefix *string, options *S3DestinationOptions) FlowLogDestination
Use S3 as the destination.
type FlowLogDestinationConfig ¶
type FlowLogDestinationConfig struct {
// The type of destination to publish the flow logs to.
// Default: - CLOUD_WATCH_LOGS.
//
LogDestinationType FlowLogDestinationType `field:"required" json:"logDestinationType" yaml:"logDestinationType"`
// The ARN of Kinesis Data Firehose delivery stream to publish the flow logs to.
// Default: - undefined.
//
DeliveryStreamArn *string `field:"optional" json:"deliveryStreamArn" yaml:"deliveryStreamArn"`
// Options for writing flow logs to a supported destination.
// Default: - undefined.
//
DestinationOptions *DestinationOptions `field:"optional" json:"destinationOptions" yaml:"destinationOptions"`
// The IAM Role that has access to publish to CloudWatch logs.
// Default: - default IAM role is created for you.
//
IamRole awsiam.IRole `field:"optional" json:"iamRole" yaml:"iamRole"`
// S3 bucket key prefix to publish the flow logs to.
// Default: - undefined.
//
KeyPrefix *string `field:"optional" json:"keyPrefix" yaml:"keyPrefix"`
// The CloudWatch Logs Log Group to publish the flow logs to.
// Default: - default log group is created for you.
//
LogGroup awslogs.ILogGroup `field:"optional" json:"logGroup" yaml:"logGroup"`
// S3 bucket to publish the flow logs to.
// Default: - undefined.
//
S3Bucket awss3.IBucket `field:"optional" json:"s3Bucket" yaml:"s3Bucket"`
}
Flow Log Destination configuration.
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"
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
var bucket bucket
var logGroup logGroup
var role role
flowLogDestinationConfig := &FlowLogDestinationConfig{
LogDestinationType: awscdk.Aws_ec2.FlowLogDestinationType_CLOUD_WATCH_LOGS,
// the properties below are optional
DeliveryStreamArn: jsii.String("deliveryStreamArn"),
DestinationOptions: &DestinationOptions{
FileFormat: awscdk.*Aws_ec2.FlowLogFileFormat_PLAIN_TEXT,
HiveCompatiblePartitions: jsii.Boolean(false),
PerHourPartition: jsii.Boolean(false),
},
IamRole: role,
KeyPrefix: jsii.String("keyPrefix"),
LogGroup: logGroup,
S3Bucket: bucket,
}
type FlowLogDestinationType ¶
type FlowLogDestinationType string
The available destination types for Flow Logs.
const ( // Send flow logs to CloudWatch Logs Group. FlowLogDestinationType_CLOUD_WATCH_LOGS FlowLogDestinationType = "CLOUD_WATCH_LOGS" // Send flow logs to S3 Bucket. FlowLogDestinationType_S3 FlowLogDestinationType = "S3" // Send flow logs to Kinesis Data Firehose. FlowLogDestinationType_KINESIS_DATA_FIREHOSE FlowLogDestinationType = "KINESIS_DATA_FIREHOSE" )
type FlowLogFileFormat ¶ added in v2.32.0
type FlowLogFileFormat string
The file format for flow logs written to an S3 bucket destination.
const ( // File will be written as plain text. // // This is the default value. FlowLogFileFormat_PLAIN_TEXT FlowLogFileFormat = "PLAIN_TEXT" // File will be written in parquet format. FlowLogFileFormat_PARQUET FlowLogFileFormat = "PARQUET" )
type FlowLogMaxAggregationInterval ¶ added in v2.43.0
type FlowLogMaxAggregationInterval string
The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record.
Example:
vpc := ec2.NewVpc(this, jsii.String("Vpc"))
vpc.addFlowLog(jsii.String("FlowLogS3"), &FlowLogOptions{
Destination: ec2.FlowLogDestination_ToS3(),
})
// Only reject traffic and interval every minute.
vpc.addFlowLog(jsii.String("FlowLogCloudWatch"), &FlowLogOptions{
TrafficType: ec2.FlowLogTrafficType_REJECT,
MaxAggregationInterval: ec2.FlowLogMaxAggregationInterval_ONE_MINUTE,
})
const ( // 1 minute (60 seconds). FlowLogMaxAggregationInterval_ONE_MINUTE FlowLogMaxAggregationInterval = "ONE_MINUTE" // 10 minutes (600 seconds). FlowLogMaxAggregationInterval_TEN_MINUTES FlowLogMaxAggregationInterval = "TEN_MINUTES" )
type FlowLogOptions ¶
type FlowLogOptions struct {
// Specifies the type of destination to which the flow log data is to be published.
//
// Flow log data can be published to CloudWatch Logs or Amazon S3.
// Default: FlowLogDestinationType.toCloudWatchLogs()
//
Destination FlowLogDestination `field:"optional" json:"destination" yaml:"destination"`
// The fields to include in the flow log record, in the order in which they should appear.
//
// If multiple fields are specified, they will be separated by spaces. For full control over the literal log format
// string, pass a single field constructed with `LogFormat.custom()`.
//
// See https://docs.aws.amazon.com/vpc/latest/userguide/flow-logs.html#flow-log-records
// Default: - default log format is used.
//
LogFormat *[]LogFormat `field:"optional" json:"logFormat" yaml:"logFormat"`
// The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record.
//
// When creating flow logs for a Transit Gateway or Transit Gateway Attachment,
// this property must be ONE_MINUTES.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-maxaggregationinterval
//
// Default: - FlowLogMaxAggregationInterval.ONE_MINUTES if creating flow logs for Transit Gateway, otherwise FlowLogMaxAggregationInterval.TEN_MINUTES.
//
MaxAggregationInterval FlowLogMaxAggregationInterval `field:"optional" json:"maxAggregationInterval" yaml:"maxAggregationInterval"`
// The type of traffic to log.
//
// You can log traffic that the resource accepts or rejects, or all traffic.
// When the target is either `TransitGateway` or `TransitGatewayAttachment`, setting the traffic type is not possible.
// See: https://docs.aws.amazon.com/vpc/latest/tgw/working-with-flow-logs.html
//
// Default: ALL.
//
TrafficType FlowLogTrafficType `field:"optional" json:"trafficType" yaml:"trafficType"`
}
Options to add a flow log to a VPC.
Example:
vpc := ec2.NewVpc(this, jsii.String("Vpc"))
vpc.addFlowLog(jsii.String("FlowLogS3"), &FlowLogOptions{
Destination: ec2.FlowLogDestination_ToS3(),
})
// Only reject traffic and interval every minute.
vpc.addFlowLog(jsii.String("FlowLogCloudWatch"), &FlowLogOptions{
TrafficType: ec2.FlowLogTrafficType_REJECT,
MaxAggregationInterval: ec2.FlowLogMaxAggregationInterval_ONE_MINUTE,
})
type FlowLogProps ¶
type FlowLogProps struct {
// Specifies the type of destination to which the flow log data is to be published.
//
// Flow log data can be published to CloudWatch Logs or Amazon S3.
// Default: FlowLogDestinationType.toCloudWatchLogs()
//
Destination FlowLogDestination `field:"optional" json:"destination" yaml:"destination"`
// The fields to include in the flow log record, in the order in which they should appear.
//
// If multiple fields are specified, they will be separated by spaces. For full control over the literal log format
// string, pass a single field constructed with `LogFormat.custom()`.
//
// See https://docs.aws.amazon.com/vpc/latest/userguide/flow-logs.html#flow-log-records
// Default: - default log format is used.
//
LogFormat *[]LogFormat `field:"optional" json:"logFormat" yaml:"logFormat"`
// The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record.
//
// When creating flow logs for a Transit Gateway or Transit Gateway Attachment,
// this property must be ONE_MINUTES.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-maxaggregationinterval
//
// Default: - FlowLogMaxAggregationInterval.ONE_MINUTES if creating flow logs for Transit Gateway, otherwise FlowLogMaxAggregationInterval.TEN_MINUTES.
//
MaxAggregationInterval FlowLogMaxAggregationInterval `field:"optional" json:"maxAggregationInterval" yaml:"maxAggregationInterval"`
// The type of traffic to log.
//
// You can log traffic that the resource accepts or rejects, or all traffic.
// When the target is either `TransitGateway` or `TransitGatewayAttachment`, setting the traffic type is not possible.
// See: https://docs.aws.amazon.com/vpc/latest/tgw/working-with-flow-logs.html
//
// Default: ALL.
//
TrafficType FlowLogTrafficType `field:"optional" json:"trafficType" yaml:"trafficType"`
// The type of resource for which to create the flow log.
ResourceType FlowLogResourceType `field:"required" json:"resourceType" yaml:"resourceType"`
// The name of the FlowLog.
//
// Since the FlowLog resource doesn't support providing a physical name, the value provided here will be recorded in the `Name` tag.
// Default: CDK generated name.
//
FlowLogName *string `field:"optional" json:"flowLogName" yaml:"flowLogName"`
}
Properties of a VPC Flow Log.
Example:
var tgw cfnTransitGateway
ec2.NewFlowLog(this, jsii.String("TransitGatewayFlowLog"), &FlowLogProps{
ResourceType: ec2.FlowLogResourceType_FromTransitGatewayId(tgw.ref),
})
type FlowLogResourceType ¶
type FlowLogResourceType interface {
// The Id of the resource that the flow log should be attached to.
ResourceId() *string
SetResourceId(val *string)
// The type of resource to attach a flow log to.
ResourceType() *string
SetResourceType(val *string)
}
The type of resource to create the flow log for.
Example:
var tgw cfnTransitGateway
ec2.NewFlowLog(this, jsii.String("TransitGatewayFlowLog"), &FlowLogProps{
ResourceType: ec2.FlowLogResourceType_FromTransitGatewayId(tgw.ref),
})
func FlowLogResourceType_FromNetworkInterfaceId ¶
func FlowLogResourceType_FromNetworkInterfaceId(id *string) FlowLogResourceType
The Network Interface to attach the Flow Log to.
func FlowLogResourceType_FromSubnet ¶
func FlowLogResourceType_FromSubnet(subnet ISubnet) FlowLogResourceType
The subnet to attach the Flow Log to.
func FlowLogResourceType_FromTransitGatewayAttachmentId ¶ added in v2.123.0
func FlowLogResourceType_FromTransitGatewayAttachmentId(id *string) FlowLogResourceType
The Transit Gateway Attachment to attach the Flow Log to.
func FlowLogResourceType_FromTransitGatewayId ¶ added in v2.123.0
func FlowLogResourceType_FromTransitGatewayId(id *string) FlowLogResourceType
The Transit Gateway to attach the Flow Log to.
func FlowLogResourceType_FromVpc ¶
func FlowLogResourceType_FromVpc(vpc IVpc) FlowLogResourceType
The VPC to attach the Flow Log to.
type FlowLogTrafficType ¶
type FlowLogTrafficType string
The type of VPC traffic to log.
Example:
vpc := ec2.NewVpc(this, jsii.String("Vpc"))
vpc.addFlowLog(jsii.String("FlowLogS3"), &FlowLogOptions{
Destination: ec2.FlowLogDestination_ToS3(),
})
// Only reject traffic and interval every minute.
vpc.addFlowLog(jsii.String("FlowLogCloudWatch"), &FlowLogOptions{
TrafficType: ec2.FlowLogTrafficType_REJECT,
MaxAggregationInterval: ec2.FlowLogMaxAggregationInterval_ONE_MINUTE,
})
const ( // Only log accepts. FlowLogTrafficType_ACCEPT FlowLogTrafficType = "ACCEPT" // Log all requests. FlowLogTrafficType_ALL FlowLogTrafficType = "ALL" // Only log rejects. FlowLogTrafficType_REJECT FlowLogTrafficType = "REJECT" )
type GatewayConfig ¶
type GatewayConfig struct {
// Availability Zone.
Az *string `field:"required" json:"az" yaml:"az"`
// Identity of gateway spawned by the provider.
GatewayId *string `field:"required" json:"gatewayId" yaml:"gatewayId"`
}
Pair represents a gateway created by NAT Provider.
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"
gatewayConfig := &GatewayConfig{
Az: jsii.String("az"),
GatewayId: jsii.String("gatewayId"),
}
type GatewayVpcEndpoint ¶
type GatewayVpcEndpoint interface {
VpcEndpoint
IGatewayVpcEndpoint
// The environment this resource belongs to.
//
// For resources that are created and managed by the CDK
// (generally, those created by creating new class instances like Role, Bucket, etc.),
// this is always the same as the environment of the stack they belong to;
// however, for imported resources
// (those obtained from static methods like fromRoleArn, fromBucketName, etc.),
// that might be different than the stack they were imported into.
Env() *awscdk.ResourceEnvironment
// The tree node.
Node() constructs.Node
// Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
//
// This value will resolve to one of the following:
// - a concrete value (e.g. `"my-awesome-bucket"`)
// - `undefined`, when a name should be generated by CloudFormation
// - a concrete name generated automatically during synthesis, in
// cross-environment scenarios.
PhysicalName() *string
PolicyDocument() awsiam.PolicyDocument
SetPolicyDocument(val awsiam.PolicyDocument)
// The stack in which this resource is defined.
Stack() awscdk.Stack
// The date and time the gateway VPC endpoint was created.
VpcEndpointCreationTimestamp() *string
VpcEndpointDnsEntries() *[]*string
// The gateway VPC endpoint identifier.
VpcEndpointId() *string
VpcEndpointNetworkInterfaceIds() *[]*string
// Adds a statement to the policy document of the VPC endpoint. The statement must have a Principal.
//
// Not all interface VPC endpoints support policy. For more information
// see https://docs.aws.amazon.com/vpc/latest/userguide/vpce-interface.html
AddToPolicy(statement awsiam.PolicyStatement)
// Apply the given removal policy to this resource.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
GeneratePhysicalName() *string
// Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`).
//
// Normally, this token will resolve to `arnAttr`, but if the resource is
// referenced across environments, `arnComponents` will be used to synthesize
// a concrete ARN with the resource's physical name. Make sure to reference
// `this.physicalName` in `arnComponents`.
GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
// Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`).
//
// Normally, this token will resolve to `nameAttr`, but if the resource is
// referenced across environments, it will be resolved to `this.physicalName`,
// which will be a concrete name.
GetResourceNameAttribute(nameAttr *string) *string
// Returns a string representation of this construct.
ToString() *string
}
A gateway VPC endpoint.
Example:
// Add gateway endpoints when creating the VPC
vpc := ec2.NewVpc(this, jsii.String("MyVpc"), &VpcProps{
GatewayEndpoints: map[string]gatewayVpcEndpointOptions{
"S3": &gatewayVpcEndpointOptions{
"service": ec2.GatewayVpcEndpointAwsService_S3(),
},
},
})
// Alternatively gateway endpoints can be added on the VPC
dynamoDbEndpoint := vpc.addGatewayEndpoint(jsii.String("DynamoDbEndpoint"), &gatewayVpcEndpointOptions{
Service: ec2.GatewayVpcEndpointAwsService_DYNAMODB(),
})
// This allows to customize the endpoint policy
dynamoDbEndpoint.AddToPolicy(
iam.NewPolicyStatement(&PolicyStatementProps{
// Restrict to listing and describing tables
Principals: []iPrincipal{
iam.NewAnyPrincipal(),
},
Actions: []*string{
jsii.String("dynamodb:DescribeTable"),
jsii.String("dynamodb:ListTables"),
},
Resources: []*string{
jsii.String("*"),
},
}))
// Add an interface endpoint
vpc.addInterfaceEndpoint(jsii.String("EcrDockerEndpoint"), &InterfaceVpcEndpointOptions{
Service: ec2.InterfaceVpcEndpointAwsService_ECR_DOCKER(),
})
func NewGatewayVpcEndpoint ¶
func NewGatewayVpcEndpoint(scope constructs.Construct, id *string, props *GatewayVpcEndpointProps) GatewayVpcEndpoint
type GatewayVpcEndpointAwsService ¶
type GatewayVpcEndpointAwsService interface {
IGatewayVpcEndpointService
// The name of the service.
Name() *string
}
An AWS service for a gateway VPC endpoint.
Example:
// Add gateway endpoints when creating the VPC
vpc := ec2.NewVpc(this, jsii.String("MyVpc"), &VpcProps{
GatewayEndpoints: map[string]gatewayVpcEndpointOptions{
"S3": &gatewayVpcEndpointOptions{
"service": ec2.GatewayVpcEndpointAwsService_S3(),
},
},
})
// Alternatively gateway endpoints can be added on the VPC
dynamoDbEndpoint := vpc.addGatewayEndpoint(jsii.String("DynamoDbEndpoint"), &gatewayVpcEndpointOptions{
Service: ec2.GatewayVpcEndpointAwsService_DYNAMODB(),
})
// This allows to customize the endpoint policy
dynamoDbEndpoint.AddToPolicy(
iam.NewPolicyStatement(&PolicyStatementProps{
// Restrict to listing and describing tables
Principals: []iPrincipal{
iam.NewAnyPrincipal(),
},
Actions: []*string{
jsii.String("dynamodb:DescribeTable"),
jsii.String("dynamodb:ListTables"),
},
Resources: []*string{
jsii.String("*"),
},
}))
// Add an interface endpoint
vpc.addInterfaceEndpoint(jsii.String("EcrDockerEndpoint"), &InterfaceVpcEndpointOptions{
Service: ec2.InterfaceVpcEndpointAwsService_ECR_DOCKER(),
})
func GatewayVpcEndpointAwsService_DYNAMODB ¶
func GatewayVpcEndpointAwsService_DYNAMODB() GatewayVpcEndpointAwsService
func GatewayVpcEndpointAwsService_S3 ¶
func GatewayVpcEndpointAwsService_S3() GatewayVpcEndpointAwsService
func GatewayVpcEndpointAwsService_S3_EXPRESS ¶ added in v2.134.0
func GatewayVpcEndpointAwsService_S3_EXPRESS() GatewayVpcEndpointAwsService
func NewGatewayVpcEndpointAwsService ¶
func NewGatewayVpcEndpointAwsService(name *string, prefix *string) GatewayVpcEndpointAwsService
type GatewayVpcEndpointOptions ¶
type GatewayVpcEndpointOptions struct {
// The service to use for this gateway VPC endpoint.
Service IGatewayVpcEndpointService `field:"required" json:"service" yaml:"service"`
// Where to add endpoint routing.
//
// By default, this endpoint will be routable from all subnets in the VPC.
// Specify a list of subnet selection objects here to be more specific.
//
// Example:
// var vpc vpc
//
//
// vpc.addGatewayEndpoint(jsii.String("DynamoDbEndpoint"), &GatewayVpcEndpointOptions{
// Service: ec2.GatewayVpcEndpointAwsService_DYNAMODB(),
// // Add only to ISOLATED subnets
// Subnets: []subnetSelection{
// &subnetSelection{
// SubnetType: ec2.SubnetType_PRIVATE_ISOLATED,
// },
// },
// })
//
// Default: - All subnets in the VPC.
//
Subnets *[]*SubnetSelection `field:"optional" json:"subnets" yaml:"subnets"`
}
Options to add a gateway endpoint to a VPC.
Example:
// Add gateway endpoints when creating the VPC
vpc := ec2.NewVpc(this, jsii.String("MyVpc"), &VpcProps{
GatewayEndpoints: map[string]gatewayVpcEndpointOptions{
"S3": &gatewayVpcEndpointOptions{
"service": ec2.GatewayVpcEndpointAwsService_S3(),
},
},
})
// Alternatively gateway endpoints can be added on the VPC
dynamoDbEndpoint := vpc.addGatewayEndpoint(jsii.String("DynamoDbEndpoint"), &gatewayVpcEndpointOptions{
Service: ec2.GatewayVpcEndpointAwsService_DYNAMODB(),
})
// This allows to customize the endpoint policy
dynamoDbEndpoint.AddToPolicy(
iam.NewPolicyStatement(&PolicyStatementProps{
// Restrict to listing and describing tables
Principals: []iPrincipal{
iam.NewAnyPrincipal(),
},
Actions: []*string{
jsii.String("dynamodb:DescribeTable"),
jsii.String("dynamodb:ListTables"),
},
Resources: []*string{
jsii.String("*"),
},
}))
// Add an interface endpoint
vpc.addInterfaceEndpoint(jsii.String("EcrDockerEndpoint"), &InterfaceVpcEndpointOptions{
Service: ec2.InterfaceVpcEndpointAwsService_ECR_DOCKER(),
})
type GatewayVpcEndpointProps ¶
type GatewayVpcEndpointProps struct {
// The service to use for this gateway VPC endpoint.
Service IGatewayVpcEndpointService `field:"required" json:"service" yaml:"service"`
// Where to add endpoint routing.
//
// By default, this endpoint will be routable from all subnets in the VPC.
// Specify a list of subnet selection objects here to be more specific.
//
// Example:
// declare const vpc: ec2.Vpc;
//
// vpc.addGatewayEndpoint('DynamoDbEndpoint', {
// service: ec2.GatewayVpcEndpointAwsService.DYNAMODB,
// // Add only to ISOLATED subnets
// subnets: [
// { subnetType: ec2.SubnetType.PRIVATE_ISOLATED }
// ]
// });
//
// Default: - All subnets in the VPC.
//
Subnets *[]*SubnetSelection `field:"optional" json:"subnets" yaml:"subnets"`
// The VPC network in which the gateway endpoint will be used.
Vpc IVpc `field:"required" json:"vpc" yaml:"vpc"`
}
Construction properties for a GatewayVpcEndpoint.
Example:
stack := awscdk.Newstack()
myVpc := awsec2alpha.NewVpcV2(this, jsii.String("Vpc"))
routeTable := awsec2alpha.NewRouteTable(this, jsii.String("RouteTable"), &RouteTableProps{
Vpc: myVpc,
})
subnet := awsec2alpha.NewSubnetV2(this, jsii.String("Subnet"), &SubnetV2Props{
Vpc: myVpc,
AvailabilityZone: jsii.String("eu-west-2a"),
Ipv4CidrBlock: awsec2alpha.NewIpCidr(jsii.String("10.0.0.0/24")),
SubnetType: awscdk.SubnetType_PRIVATE,
})
dynamoEndpoint := ec2.NewGatewayVpcEndpoint(this, jsii.String("DynamoEndpoint"), &GatewayVpcEndpointProps{
Service: ec2.GatewayVpcEndpointAwsService_DYNAMODB(),
Vpc: myVpc,
Subnets: []subnetSelection{
subnet,
},
})
awsec2alpha.NewRoute(this, jsii.String("DynamoDBRoute"), &RouteProps{
RouteTable: RouteTable,
Destination: jsii.String("0.0.0.0/0"),
Target: map[string]iVpcEndpoint{
"endpoint": dynamoEndpoint,
},
})
type GenericLinuxImage ¶
type GenericLinuxImage interface {
IMachineImage
// Return the image to use in the given context.
GetImage(scope constructs.Construct) *MachineImageConfig
}
Construct a Linux machine image from an AMI map.
Linux images IDs are not published to SSM parameter store yet, so you'll have to manually specify an AMI map.
Example:
// Pick a Windows edition to use
windows := ec2.NewWindowsImage(ec2.WindowsVersion_WINDOWS_SERVER_2019_ENGLISH_FULL_BASE)
// Pick the right Amazon Linux edition. All arguments shown are optional
// and will default to these values when omitted.
amznLinux := ec2.NewAmazonLinuxImage(&AmazonLinuxImageProps{
Generation: ec2.AmazonLinuxGeneration_AMAZON_LINUX,
Edition: ec2.AmazonLinuxEdition_STANDARD,
Virtualization: ec2.AmazonLinuxVirt_HVM,
Storage: ec2.AmazonLinuxStorage_GENERAL_PURPOSE,
})
// For other custom (Linux) images, instantiate a `GenericLinuxImage` with
// a map giving the AMI to in for each region:
linux := ec2.NewGenericLinuxImage(map[string]*string{
"us-east-1": jsii.String("ami-97785bed"),
"eu-west-1": jsii.String("ami-12345678"),
})
func NewGenericLinuxImage ¶
func NewGenericLinuxImage(amiMap *map[string]*string, props *GenericLinuxImageProps) GenericLinuxImage
type GenericLinuxImageProps ¶
type GenericLinuxImageProps struct {
// Initial user data.
// Default: - Empty UserData for Linux machines.
//
UserData UserData `field:"optional" json:"userData" yaml:"userData"`
}
Configuration options for GenericLinuxImage.
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"
var userData userData
genericLinuxImageProps := &GenericLinuxImageProps{
UserData: userData,
}
type GenericSSMParameterImage ¶
type GenericSSMParameterImage interface {
IMachineImage
// Name of the SSM parameter we're looking up.
ParameterName() *string
// Return the image to use in the given context.
GetImage(scope constructs.Construct) *MachineImageConfig
}
Select the image based on a given SSM parameter at deployment time of the CloudFormation Stack.
This Machine Image automatically updates to the latest version on every deployment. Be aware this will cause your instances to be replaced when a new version of the image becomes available. Do not store stateful information on the instance if you are using this image.
The AMI ID is selected using the values published to the SSM parameter store.
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"
var userData userData
genericSSMParameterImage := awscdk.Aws_ec2.NewGenericSSMParameterImage(jsii.String("parameterName"), awscdk.Aws_ec2.OperatingSystemType_LINUX, userData)
func NewGenericSSMParameterImage ¶
func NewGenericSSMParameterImage(parameterName *string, os OperatingSystemType, userData UserData) GenericSSMParameterImage
type GenericWindowsImage ¶
type GenericWindowsImage interface {
IMachineImage
// Return the image to use in the given context.
GetImage(scope constructs.Construct) *MachineImageConfig
}
Construct a Windows machine image from an AMI map.
Allows you to create a generic Windows EC2 , manually specify an AMI map.
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"
var userData userData
genericWindowsImage := awscdk.Aws_ec2.NewGenericWindowsImage(map[string]*string{
"amiMapKey": jsii.String("amiMap"),
}, &GenericWindowsImageProps{
UserData: userData,
})
func NewGenericWindowsImage ¶
func NewGenericWindowsImage(amiMap *map[string]*string, props *GenericWindowsImageProps) GenericWindowsImage
type GenericWindowsImageProps ¶
type GenericWindowsImageProps struct {
// Initial user data.
// Default: - Empty UserData for Windows machines.
//
UserData UserData `field:"optional" json:"userData" yaml:"userData"`
}
Configuration options for GenericWindowsImage.
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"
var userData userData
genericWindowsImageProps := &GenericWindowsImageProps{
UserData: userData,
}
type IClientVpnConnectionHandler ¶
type IClientVpnConnectionHandler interface {
// The ARN of the function.
FunctionArn() *string
// The name of the function.
FunctionName() *string
}
A connection handler for client VPN endpoints.
type IClientVpnEndpoint ¶
type IClientVpnEndpoint interface {
IConnectable
awscdk.IResource
// The endpoint ID.
EndpointId() *string
// Dependable that can be depended upon to force target networks associations.
TargetNetworksAssociated() constructs.IDependable
}
A client VPN endpoint.
func ClientVpnEndpoint_FromEndpointAttributes ¶
func ClientVpnEndpoint_FromEndpointAttributes(scope constructs.Construct, id *string, attrs *ClientVpnEndpointAttributes) IClientVpnEndpoint
Import an existing client VPN endpoint.
type IConnectable ¶
type IConnectable interface {
// The network connections associated with this resource.
Connections() Connections
}
An object that has a Connections object.
type IFlowLog ¶
type IFlowLog interface {
awscdk.IResource
// The Id of the VPC Flow Log.
FlowLogId() *string
}
A FlowLog.
func FlowLog_FromFlowLogId ¶
Import a Flow Log by it's Id.
type IGatewayVpcEndpoint ¶
type IGatewayVpcEndpoint interface {
IVpcEndpoint
}
A gateway VPC endpoint.
func GatewayVpcEndpoint_FromGatewayVpcEndpointId ¶
func GatewayVpcEndpoint_FromGatewayVpcEndpointId(scope constructs.Construct, id *string, gatewayVpcEndpointId *string) IGatewayVpcEndpoint
type IGatewayVpcEndpointService ¶
type IGatewayVpcEndpointService interface {
// The name of the service.
Name() *string
}
A service for a gateway VPC endpoint.
type IInstance ¶
type IInstance interface {
IConnectable
awsiam.IGrantable
awscdk.IResource
// The availability zone the instance was launched in.
InstanceAvailabilityZone() *string
// The instance's ID.
InstanceId() *string
// Private DNS name for this instance.
InstancePrivateDnsName() *string
// Private IP for this instance.
InstancePrivateIp() *string
// Publicly-routable DNS name for this instance.
//
// (May be an empty string if the instance does not have a public name).
InstancePublicDnsName() *string
// Publicly-routable IP address for this instance.
//
// (May be an empty string if the instance does not have a public IP).
InstancePublicIp() *string
}
type IInterfaceVpcEndpoint ¶
type IInterfaceVpcEndpoint interface {
IConnectable
IVpcEndpoint
}
An interface VPC endpoint.
func InterfaceVpcEndpoint_FromInterfaceVpcEndpointAttributes ¶
func InterfaceVpcEndpoint_FromInterfaceVpcEndpointAttributes(scope constructs.Construct, id *string, attrs *InterfaceVpcEndpointAttributes) IInterfaceVpcEndpoint
Imports an existing interface VPC endpoint.
type IInterfaceVpcEndpointService ¶
type IInterfaceVpcEndpointService interface {
// The name of the service.
Name() *string
// The port of the service.
Port() *float64
// Whether Private DNS is supported by default.
PrivateDnsDefault() *bool
}
A service for an interface VPC endpoint.
type IIpAddresses ¶ added in v2.48.0
type IIpAddresses interface {
// Called by the VPC to retrieve Subnet options from the Ipam.
//
// Don't call this directly, the VPC will call it automatically.
AllocateSubnetsCidr(input *AllocateCidrRequest) *SubnetIpamOptions
// Called by the VPC to retrieve VPC options from the Ipam.
//
// Don't call this directly, the VPC will call it automatically.
AllocateVpcCidr() *VpcIpamOptions
}
Implementations for ip address management.
Note this is specific to the IPv4 CIDR.
func IpAddresses_AwsIpamAllocation ¶ added in v2.48.0
func IpAddresses_AwsIpamAllocation(props *AwsIpamProps) IIpAddresses
Used to provide centralized Ip Address Management services for your VPC.
Uses VPC CIDR allocations from AWS IPAM ¶
Note this is specific to the IPv4 CIDR. See: https://docs.aws.amazon.com/vpc/latest/ipam/what-it-is-ipam.html
func IpAddresses_Cidr ¶ added in v2.48.0
func IpAddresses_Cidr(cidrBlock *string) IIpAddresses
Used to provide local Ip Address Management services for your VPC.
VPC CIDR is supplied at creation and subnets are calculated locally ¶
Note this is specific to the IPv4 CIDR.
type IIpv6Addresses ¶ added in v2.121.0
type IIpv6Addresses interface {
// Allocates Subnets IPv6 CIDRs. Called by VPC when creating subnets with IPv6 enabled.
//
// Note this is specific to the IPv6 CIDR.
AllocateSubnetsIpv6Cidr(input *AllocateIpv6CidrRequest) *SubnetIpamOptions
// Called by VPC to allocate IPv6 CIDR.
//
// Note this is specific to the IPv6 CIDR.
AllocateVpcIpv6Cidr(input *AllocateVpcIpv6CidrRequest) CfnVPCCidrBlock
// Split IPv6 CIDR block up for subnets.
//
// Note this is specific to the IPv6 CIDR.
CreateIpv6CidrBlocks(input *CreateIpv6CidrBlocksRequest) *[]*string
// Whether the IPv6 CIDR is Amazon provided or not.
//
// Note this is specific to the IPv6 CIDR.
AmazonProvided() *bool
SetAmazonProvided(a *bool)
}
Implementations for IPv6 address management.
Note this is specific to the IPv6 CIDR.
func Ipv6Addresses_AmazonProvided ¶ added in v2.121.0
func Ipv6Addresses_AmazonProvided() IIpv6Addresses
Used for IPv6 address management with Amazon provided CIDRs.
Note this is specific to the IPv6 CIDR.
type IKeyPair ¶ added in v2.116.0
type IKeyPair interface {
awscdk.IResource
// The name of the key pair.
KeyPairName() *string
// The type of the key pair.
Type() KeyPairType
}
An EC2 Key Pair.
func KeyPair_FromKeyPairAttributes ¶ added in v2.116.0
func KeyPair_FromKeyPairAttributes(scope constructs.Construct, id *string, attrs *KeyPairAttributes) IKeyPair
Imports a key pair with a name and optional type.
func KeyPair_FromKeyPairName ¶ added in v2.116.0
Imports a key pair based on the name.
type ILaunchTemplate ¶
type ILaunchTemplate interface {
awscdk.IResource
// The identifier of the Launch Template.
//
// Exactly one of `launchTemplateId` and `launchTemplateName` will be set.
LaunchTemplateId() *string
// The name of the Launch Template.
//
// Exactly one of `launchTemplateId` and `launchTemplateName` will be set.
LaunchTemplateName() *string
// The version number of this launch template to use.
VersionNumber() *string
}
Interface for LaunchTemplate-like objects.
func LaunchTemplate_FromLaunchTemplateAttributes ¶
func LaunchTemplate_FromLaunchTemplateAttributes(scope constructs.Construct, id *string, attrs *LaunchTemplateAttributes) ILaunchTemplate
Import an existing LaunchTemplate.
type IMachineImage ¶
type IMachineImage interface {
// Return the image to use in the given context.
GetImage(scope constructs.Construct) *MachineImageConfig
}
Interface for classes that can select an appropriate machine image to use.
func MachineImage_FromSsmParameter ¶
func MachineImage_FromSsmParameter(parameterName *string, options *SsmParameterImageOptions) IMachineImage
An image specified in SSM parameter store.
By default, the SSM parameter is refreshed at every deployment, causing your instances to be replaced whenever a new version of the AMI is released.
Pass `{ cachedInContext: true }` to keep the AMI ID stable. If you do, you will have to remember to periodically invalidate the context to refresh to the newest AMI ID.
func MachineImage_GenericLinux ¶
func MachineImage_GenericLinux(amiMap *map[string]*string, props *GenericLinuxImageProps) IMachineImage
A Linux image where you specify the AMI ID for every region.
func MachineImage_GenericWindows ¶
func MachineImage_GenericWindows(amiMap *map[string]*string, props *GenericWindowsImageProps) IMachineImage
A Windows image where you specify the AMI ID for every region.
func MachineImage_LatestAmazonLinux ¶
func MachineImage_LatestAmazonLinux(props *AmazonLinuxImageProps) IMachineImage
An Amazon Linux image that is automatically kept up-to-date.
This Machine Image automatically updates to the latest version on every deployment. Be aware this will cause your instances to be replaced when a new version of the image becomes available. Do not store stateful information on the instance if you are using this image.
N.B.: "latest" in the name of this function indicates that it always uses the most recent image of a particular generation of Amazon Linux, not that it uses the "latest generation". For backwards compatibility, this function uses Amazon Linux 1 if no generation is specified.
Specify the desired generation using the `generation` property:
```ts
ec2.MachineImage.latestAmazonLinux({
// Use Amazon Linux 2
generation: ec2.AmazonLinuxGeneration.AMAZON_LINUX_2,
})
```. Deprecated: use MachineImage.latestAmazonLinux2 instead
func MachineImage_LatestAmazonLinux2 ¶ added in v2.76.0
func MachineImage_LatestAmazonLinux2(props *AmazonLinux2ImageSsmParameterProps) IMachineImage
An Amazon Linux 2 image that is automatically kept up-to-date.
This Machine Image automatically updates to the latest version on every deployment. Be aware this will cause your instances to be replaced when a new version of the image becomes available. Do not store stateful information on the instance if you are using this image.
func MachineImage_LatestAmazonLinux2022 ¶ added in v2.76.0
func MachineImage_LatestAmazonLinux2022(props *AmazonLinux2022ImageSsmParameterProps) IMachineImage
An Amazon Linux 2022 image that is automatically kept up-to-date.
This Machine Image automatically updates to the latest version on every deployment. Be aware this will cause your instances to be replaced when a new version of the image becomes available. Do not store stateful information on the instance if you are using this image. Deprecated: - use latestAmazonLinux2023() instead.
func MachineImage_LatestAmazonLinux2023 ¶ added in v2.76.0
func MachineImage_LatestAmazonLinux2023(props *AmazonLinux2023ImageSsmParameterProps) IMachineImage
An Amazon Linux 2023 image that is automatically kept up-to-date.
This Machine Image automatically updates to the latest version on every deployment. Be aware this will cause your instances to be replaced when a new version of the image becomes available. Do not store stateful information on the instance if you are using this image.
func MachineImage_LatestWindows ¶
func MachineImage_LatestWindows(version WindowsVersion, props *WindowsImageProps) IMachineImage
A Windows image that is automatically kept up-to-date.
This Machine Image automatically updates to the latest version on every deployment. Be aware this will cause your instances to be replaced when a new version of the image becomes available. Do not store stateful information on the instance if you are using this image.
func MachineImage_Lookup ¶
func MachineImage_Lookup(props *LookupMachineImageProps) IMachineImage
Look up a shared Machine Image using DescribeImages.
The most recent, available, launchable image matching the given filter criteria will be used. Looking up AMIs may take a long time; specify as many filter criteria as possible to narrow down the search.
The AMI selected will be cached in `cdk.context.json` and the same value will be used on future runs. To refresh the AMI lookup, you will have to evict the value from the cache using the `cdk context` command. See https://docs.aws.amazon.com/cdk/latest/guide/context.html for more information.
This function can not be used in environment-agnostic stacks.
func MachineImage_ResolveSsmParameterAtLaunch ¶ added in v2.88.0
func MachineImage_ResolveSsmParameterAtLaunch(parameterName *string, options *SsmParameterImageOptions) IMachineImage
An image specified in SSM parameter store that will be resolved at instance launch time.
The AMI ID will be resolved at instance launch time. See: https://docs.aws.amazon.com/autoscaling/ec2/userguide/using-systems-manager-parameters.html
type INetworkAcl ¶
type INetworkAcl interface {
awscdk.IResource
// Add a new entry to the ACL.
AddEntry(id *string, options *CommonNetworkAclEntryOptions) NetworkAclEntry
// ID for the current Network ACL.
NetworkAclId() *string
}
A NetworkAcl.
func NetworkAcl_FromNetworkAclId ¶
func NetworkAcl_FromNetworkAclId(scope constructs.Construct, id *string, networkAclId *string) INetworkAcl
Import an existing NetworkAcl into this app.
type INetworkAclEntry ¶
type INetworkAclEntry interface {
awscdk.IResource
// The network ACL.
NetworkAcl() INetworkAcl
}
A NetworkAclEntry.
type IPeer ¶
type IPeer interface {
IConnectable
// Produce the egress rule JSON for the given connection.
ToEgressRuleConfig() interface{}
// Produce the ingress rule JSON for the given connection.
ToIngressRuleConfig() interface{}
// Whether the rule can be inlined into a SecurityGroup or not.
CanInlineRule() *bool
// A unique identifier for this connection peer.
UniqueId() *string
}
Interface for classes that provide the peer-specification parts of a security group rule.
func Peer_SecurityGroupId ¶ added in v2.9.0
A security group ID.
type IPlacementGroup ¶ added in v2.74.0
type IPlacementGroup interface {
awscdk.IResource
// The number of partitions.
//
// Valid only when Strategy is set to PARTITION.
// Default: 0.
//
Partitions() *float64
// The name of this placement group.
PlacementGroupName() *string
// Places instances on distinct hardware.
//
// Spread placement groups are recommended for applications
// that have a small number of critical instances that should be kept separate from each other.
// Launching instances in a spread level placement group reduces the risk of simultaneous failures
// that might occur when instances share the same equipment.
// Spread level placement groups provide access to distinct hardware,
// and are therefore suitable for mixing instance types or launching instances over time.
// If you start or launch an instance in a spread placement group and there is insufficient
// unique hardware to fulfill the request, the request fails. Amazon EC2 makes more distinct hardware
// available over time, so you can try your request again later.
// Placement groups can spread instances across racks or hosts.
// You can use host level spread placement groups only with AWS Outposts.
// Default: - no spread level.
//
SpreadLevel() PlacementGroupSpreadLevel
// Which strategy to use when launching instances.
// Default: - `PlacementGroupStrategy.PARTITION` if `partitions` is defined, `CLUSTER` otherwise
//
Strategy() PlacementGroupStrategy
}
Determines where your instances are placed on the underlying hardware according to the specified PlacementGroupStrategy. See: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html
func PlacementGroup_FromPlacementGroupName ¶ added in v2.74.0
func PlacementGroup_FromPlacementGroupName(scope constructs.Construct, id *string, placementGroupName *string) IPlacementGroup
Import a PlacementGroup by its arn.
type IPrefixList ¶ added in v2.78.0
type IPrefixList interface {
awscdk.IResource
// The ID of the prefix list.
PrefixListId() *string
}
A prefix list.
func PrefixList_FromPrefixListId ¶ added in v2.78.0
func PrefixList_FromPrefixListId(scope constructs.Construct, id *string, prefixListId *string) IPrefixList
Look up prefix list by id.
type IPrivateSubnet ¶
type IPrivateSubnet interface {
ISubnet
}
func PrivateSubnet_FromPrivateSubnetAttributes ¶
func PrivateSubnet_FromPrivateSubnetAttributes(scope constructs.Construct, id *string, attrs *PrivateSubnetAttributes) IPrivateSubnet
type IPublicSubnet ¶
type IPublicSubnet interface {
ISubnet
}
func PublicSubnet_FromPublicSubnetAttributes ¶
func PublicSubnet_FromPublicSubnetAttributes(scope constructs.Construct, id *string, attrs *PublicSubnetAttributes) IPublicSubnet
type IRouteTable ¶
type IRouteTable interface {
// Route table ID.
RouteTableId() *string
}
An abstract route table.
type ISecurityGroup ¶
type ISecurityGroup interface {
IPeer
awscdk.IResource
// Add an egress rule for the current security group.
//
// `remoteRule` controls where the Rule object is created if the peer is also a
// securityGroup and they are in different stack. If false (default) the
// rule object is created under the current SecurityGroup object. If true and the
// peer is also a SecurityGroup, the rule object is created under the remote
// SecurityGroup object.
AddEgressRule(peer IPeer, connection Port, description *string, remoteRule *bool)
// Add an ingress rule for the current security group.
//
// `remoteRule` controls where the Rule object is created if the peer is also a
// securityGroup and they are in different stack. If false (default) the
// rule object is created under the current SecurityGroup object. If true and the
// peer is also a SecurityGroup, the rule object is created under the remote
// SecurityGroup object.
AddIngressRule(peer IPeer, connection Port, description *string, remoteRule *bool)
// Whether the SecurityGroup has been configured to allow all outbound traffic.
AllowAllOutbound() *bool
// ID for the current security group.
SecurityGroupId() *string
}
Interface for security group-like objects.
func SecurityGroup_FromLookupById ¶
func SecurityGroup_FromLookupById(scope constructs.Construct, id *string, securityGroupId *string) ISecurityGroup
Look up a security group by id.
func SecurityGroup_FromLookupByName ¶
func SecurityGroup_FromLookupByName(scope constructs.Construct, id *string, securityGroupName *string, vpc IVpc) ISecurityGroup
Look up a security group by name.
func SecurityGroup_FromSecurityGroupId ¶
func SecurityGroup_FromSecurityGroupId(scope constructs.Construct, id *string, securityGroupId *string, options *SecurityGroupImportOptions) ISecurityGroup
Import an existing security group into this app.
This method will assume that the Security Group has a rule in it which allows all outbound traffic, and so will not add egress rules to the imported Security Group (only ingress rules).
If your existing Security Group needs to have egress rules added, pass the `allowAllOutbound: false` option on import.
type ISubnet ¶
type ISubnet interface {
awscdk.IResource
// Associate a Network ACL with this subnet.
AssociateNetworkAcl(id *string, acl INetworkAcl)
// The Availability Zone the subnet is located in.
AvailabilityZone() *string
// Dependable that can be depended upon to force internet connectivity established on the VPC.
InternetConnectivityEstablished() constructs.IDependable
// The IPv4 CIDR block for this subnet.
Ipv4CidrBlock() *string
// The route table for this subnet.
RouteTable() IRouteTable
// The subnetId for this particular subnet.
SubnetId() *string
}
func PrivateSubnet_FromSubnetAttributes ¶
func PrivateSubnet_FromSubnetAttributes(scope constructs.Construct, id *string, attrs *SubnetAttributes) ISubnet
func PrivateSubnet_FromSubnetId ¶
Import existing subnet from id.
func PublicSubnet_FromSubnetAttributes ¶
func PublicSubnet_FromSubnetAttributes(scope constructs.Construct, id *string, attrs *SubnetAttributes) ISubnet
func PublicSubnet_FromSubnetId ¶
Import existing subnet from id.
func Subnet_FromSubnetAttributes ¶
func Subnet_FromSubnetAttributes(scope constructs.Construct, id *string, attrs *SubnetAttributes) ISubnet
func Subnet_FromSubnetId ¶
Import existing subnet from id.
type ISubnetNetworkAclAssociation ¶
type ISubnetNetworkAclAssociation interface {
awscdk.IResource
// ID for the current SubnetNetworkAclAssociation.
SubnetNetworkAclAssociationAssociationId() *string
}
A SubnetNetworkAclAssociation.
func SubnetNetworkAclAssociation_FromSubnetNetworkAclAssociationAssociationId ¶
func SubnetNetworkAclAssociation_FromSubnetNetworkAclAssociationAssociationId(scope constructs.Construct, id *string, subnetNetworkAclAssociationAssociationId *string) ISubnetNetworkAclAssociation
type IVolume ¶
type IVolume interface {
awscdk.IResource
// Grants permission to attach this Volume to an instance.
//
// CAUTION: Granting an instance permission to attach to itself using this method will lead to
// an unresolvable circular reference between the instance role and the instance.
// Use `IVolume.grantAttachVolumeToSelf` to grant an instance permission to attach this
// volume to itself.
GrantAttachVolume(grantee awsiam.IGrantable, instances *[]IInstance) awsiam.Grant
// Grants permission to attach the Volume by a ResourceTag condition.
//
// If you are looking to
// grant an Instance, AutoScalingGroup, EC2-Fleet, SpotFleet, ECS host, etc the ability to attach
// this volume to **itself** then this is the method you want to use.
//
// This is implemented by adding a Tag with key `VolumeGrantAttach-<suffix>` to the given
// constructs and this Volume, and then conditioning the Grant such that the grantee is only
// given the ability to AttachVolume if both the Volume and the destination Instance have that
// tag applied to them.
GrantAttachVolumeByResourceTag(grantee awsiam.IGrantable, constructs *[]constructs.Construct, tagKeySuffix *string) awsiam.Grant
// Grants permission to detach this Volume from an instance CAUTION: Granting an instance permission to detach from itself using this method will lead to an unresolvable circular reference between the instance role and the instance.
//
// Use `IVolume.grantDetachVolumeFromSelf` to grant an instance permission to detach this
// volume from itself.
GrantDetachVolume(grantee awsiam.IGrantable, instances *[]IInstance) awsiam.Grant
// Grants permission to detach the Volume by a ResourceTag condition.
//
// This is implemented via the same mechanism as `IVolume.grantAttachVolumeByResourceTag`,
// and is subject to the same conditions.
GrantDetachVolumeByResourceTag(grantee awsiam.IGrantable, constructs *[]constructs.Construct, tagKeySuffix *string) awsiam.Grant
// The availability zone that the EBS Volume is contained within (ex: us-west-2a).
AvailabilityZone() *string
// The customer-managed encryption key that is used to encrypt the Volume.
EncryptionKey() awskms.IKey
// The EBS Volume's ID.
VolumeId() *string
}
An EBS Volume in AWS EC2.
func Volume_FromVolumeAttributes ¶
func Volume_FromVolumeAttributes(scope constructs.Construct, id *string, attrs *VolumeAttributes) IVolume
Import an existing EBS Volume into the Stack.
type IVpc ¶
type IVpc interface {
awscdk.IResource
// Adds a new client VPN endpoint to this VPC.
AddClientVpnEndpoint(id *string, options *ClientVpnEndpointOptions) ClientVpnEndpoint
// Adds a new Flow Log to this VPC.
AddFlowLog(id *string, options *FlowLogOptions) FlowLog
// Adds a new gateway endpoint to this VPC.
AddGatewayEndpoint(id *string, options *GatewayVpcEndpointOptions) GatewayVpcEndpoint
// Adds a new interface endpoint to this VPC.
AddInterfaceEndpoint(id *string, options *InterfaceVpcEndpointOptions) InterfaceVpcEndpoint
// Adds a new VPN connection to this VPC.
AddVpnConnection(id *string, options *VpnConnectionOptions) VpnConnection
// Adds a VPN Gateway to this VPC.
EnableVpnGateway(options *EnableVpnGatewayOptions)
// Return information on the subnets appropriate for the given selection strategy.
//
// Requires that at least one subnet is matched, throws a descriptive
// error message otherwise.
SelectSubnets(selection *SubnetSelection) *SelectedSubnets
// AZs for this VPC.
AvailabilityZones() *[]*string
// Dependable that can be depended upon to force internet connectivity established on the VPC.
InternetConnectivityEstablished() constructs.IDependable
// List of isolated subnets in this VPC.
IsolatedSubnets() *[]ISubnet
// List of private subnets in this VPC.
PrivateSubnets() *[]ISubnet
// List of public subnets in this VPC.
PublicSubnets() *[]ISubnet
// ARN for this VPC.
VpcArn() *string
// CIDR range for this VPC.
VpcCidrBlock() *string
// Identifier for this VPC.
VpcId() *string
// Identifier for the VPN gateway.
VpnGatewayId() *string
}
func Vpc_FromLookup ¶
func Vpc_FromLookup(scope constructs.Construct, id *string, options *VpcLookupOptions) IVpc
Import an existing VPC by querying the AWS environment this stack is deployed to.
This function only needs to be used to use VPCs not defined in your CDK application. If you are looking to share a VPC between stacks, you can pass the `Vpc` object between stacks and use it as normal.
Calling this method will lead to a lookup when the CDK CLI is executed. You can therefore not use any values that will only be available at CloudFormation execution time (i.e., Tokens).
The VPC information will be cached in `cdk.context.json` and the same VPC will be used on future runs. To refresh the lookup, you will have to evict the value from the cache using the `cdk context` command. See https://docs.aws.amazon.com/cdk/latest/guide/context.html for more information.
func Vpc_FromVpcAttributes ¶
func Vpc_FromVpcAttributes(scope constructs.Construct, id *string, attrs *VpcAttributes) IVpc
Import a VPC by supplying all attributes directly.
NOTE: using `fromVpcAttributes()` with deploy-time parameters (like a `Fn.importValue()` or `CfnParameter` to represent a list of subnet IDs) sometimes accidentally works. It happens to work for constructs that need a list of subnets (like `AutoScalingGroup` and `eks.Cluster`) but it does not work for constructs that need individual subnets (like `Instance`). See https://github.com/aws/aws-cdk/issues/4118 for more information.
Prefer to use `Vpc.fromLookup()` instead.
type IVpcEndpoint ¶
type IVpcEndpoint interface {
awscdk.IResource
// The VPC endpoint identifier.
VpcEndpointId() *string
}
A VPC endpoint.
type IVpcEndpointService ¶
type IVpcEndpointService interface {
awscdk.IResource
// The id of the VPC Endpoint Service that clients use to connect to, like vpce-svc-xxxxxxxxxxxxxxxx.
VpcEndpointServiceId() *string
// The service name of the VPC Endpoint Service that clients use to connect to, like com.amazonaws.vpce.<region>.vpce-svc-xxxxxxxxxxxxxxxx.
VpcEndpointServiceName() *string
}
A VPC endpoint service.
type IVpcEndpointServiceLoadBalancer ¶
type IVpcEndpointServiceLoadBalancer interface {
// The ARN of the load balancer that hosts the VPC Endpoint Service.
LoadBalancerArn() *string
}
A load balancer that can host a VPC Endpoint Service.
type IVpnConnection ¶
type IVpnConnection interface {
awscdk.IResource
// Return the given named metric for this VPNConnection.
Metric(metricName *string, props *awscloudwatch.MetricOptions) awscloudwatch.Metric
// The bytes received through the VPN tunnel.
//
// Sum over 5 minutes.
MetricTunnelDataIn(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
// The bytes sent through the VPN tunnel.
//
// Sum over 5 minutes.
MetricTunnelDataOut(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
// The state of the tunnel. 0 indicates DOWN and 1 indicates UP.
//
// Average over 5 minutes.
MetricTunnelState(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
// The ASN of the customer gateway.
CustomerGatewayAsn() *float64
// The id of the customer gateway.
CustomerGatewayId() *string
// The ip address of the customer gateway.
CustomerGatewayIp() *string
// The id of the VPN connection.
VpnId() *string
}
func VpnConnection_FromVpnConnectionAttributes ¶ added in v2.43.0
func VpnConnection_FromVpnConnectionAttributes(scope constructs.Construct, id *string, attrs *VpnConnectionAttributes) IVpnConnection
Import a VPN connection by supplying all attributes directly.
type IVpnGateway ¶
type IVpnGateway interface {
awscdk.IResource
// The virtual private gateway Id.
GatewayId() *string
}
The virtual private gateway interface.
type InitCommand ¶
type InitCommand interface {
InitElement
// Returns the init element type for this element.
ElementType() *string
}
Command to execute on the instance.
Example:
handle := ec2.NewInitServiceRestartHandle()
ec2.CloudFormationInit_FromElements(ec2.InitCommand_ShellCommand(jsii.String("/usr/bin/custom-nginx-install.sh"), &InitCommandOptions{
ServiceRestartHandles: []initServiceRestartHandle{
handle,
},
}), ec2.InitService_Enable(jsii.String("nginx"), &InitServiceOptions{
ServiceRestartHandle: handle,
}))
func InitCommand_ArgvCommand ¶
func InitCommand_ArgvCommand(argv *[]*string, options *InitCommandOptions) InitCommand
Run a command from an argv array.
You do not need to escape space characters or enclose command parameters in quotes.
func InitCommand_ShellCommand ¶
func InitCommand_ShellCommand(shellCommand *string, options *InitCommandOptions) InitCommand
Run a shell command.
Remember that some characters like `&`, `|`, `;`, `>` etc. have special meaning in a shell and need to be preceded by a `\` if you want to treat them as part of a filename.
type InitCommandOptions ¶
type InitCommandOptions struct {
// The working directory.
// Default: - Use default working directory.
//
Cwd *string `field:"optional" json:"cwd" yaml:"cwd"`
// Sets environment variables for the command.
//
// This property overwrites, rather than appends, the existing environment.
// Default: - Use current environment.
//
Env *map[string]*string `field:"optional" json:"env" yaml:"env"`
// Continue running if this command fails.
// Default: false.
//
IgnoreErrors *bool `field:"optional" json:"ignoreErrors" yaml:"ignoreErrors"`
// Identifier key for this command.
//
// Commands are executed in lexicographical order of their key names.
// Default: - Automatically generated based on index.
//
Key *string `field:"optional" json:"key" yaml:"key"`
// Restart the given service(s) after this command has run.
// Default: - Do not restart any service.
//
ServiceRestartHandles *[]InitServiceRestartHandle `field:"optional" json:"serviceRestartHandles" yaml:"serviceRestartHandles"`
// Command to determine whether this command should be run.
//
// If the test passes (exits with error code of 0), the command is run.
// Default: - Always run the command.
//
TestCmd *string `field:"optional" json:"testCmd" yaml:"testCmd"`
// The duration to wait after a command has finished in case the command causes a reboot.
//
// Set this value to `InitCommandWaitDuration.none()` if you do not want to wait for every command;
// `InitCommandWaitDuration.forever()` directs cfn-init to exit and resume only after the reboot is complete.
//
// For Windows systems only.
// Default: - 60 seconds.
//
WaitAfterCompletion InitCommandWaitDuration `field:"optional" json:"waitAfterCompletion" yaml:"waitAfterCompletion"`
}
Options for InitCommand.
Example:
handle := ec2.NewInitServiceRestartHandle()
ec2.CloudFormationInit_FromElements(ec2.InitCommand_ShellCommand(jsii.String("/usr/bin/custom-nginx-install.sh"), &InitCommandOptions{
ServiceRestartHandles: []initServiceRestartHandle{
handle,
},
}), ec2.InitService_Enable(jsii.String("nginx"), &InitServiceOptions{
ServiceRestartHandle: handle,
}))
type InitCommandWaitDuration ¶
type InitCommandWaitDuration interface {
}
Represents a duration to wait after a command has finished, in case of a reboot (Windows only).
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" initCommandWaitDuration := awscdk.Aws_ec2.InitCommandWaitDuration_Forever()
func InitCommandWaitDuration_Forever ¶
func InitCommandWaitDuration_Forever() InitCommandWaitDuration
cfn-init will exit and resume only after a reboot.
func InitCommandWaitDuration_None ¶
func InitCommandWaitDuration_None() InitCommandWaitDuration
Do not wait for this command.
func InitCommandWaitDuration_Of ¶
func InitCommandWaitDuration_Of(duration awscdk.Duration) InitCommandWaitDuration
Wait for a specified duration after a command.
type InitConfig ¶
type InitConfig interface {
// Add one or more elements to the config.
Add(elements ...InitElement)
// Whether this configset has elements or not.
IsEmpty() *bool
}
A collection of configuration elements.
Example:
var vpc vpc
var instanceType instanceType
var machineImage iMachineImage
ec2.NewInstance(this, jsii.String("Instance"), &InstanceProps{
Vpc: Vpc,
InstanceType: InstanceType,
MachineImage: MachineImage,
// Showing the most complex setup, if you have simpler requirements
// you can use `CloudFormationInit.fromElements()`.
Init: ec2.CloudFormationInit_FromConfigSets(&ConfigSetProps{
ConfigSets: map[string][]*string{
// Applies the configs below in this order
"default": []*string{
jsii.String("yumPreinstall"),
jsii.String("config"),
},
},
Configs: map[string]initConfig{
"yumPreinstall": ec2.NewInitConfig([]InitElement{
ec2.InitPackage_yum(jsii.String("git")),
}),
"config": ec2.NewInitConfig([]InitElement{
ec2.InitFile_fromObject(jsii.String("/etc/stack.json"), map[string]interface{}{
"stackId": awscdk.*stack_of(this).stackId,
"stackName": awscdk.*stack_of(this).stackName,
"region": awscdk.*stack_of(this).region,
}),
ec2.InitGroup_fromName(jsii.String("my-group")),
ec2.InitUser_fromName(jsii.String("my-user")),
ec2.InitPackage_rpm(jsii.String("http://mirrors.ukfast.co.uk/sites/dl.fedoraproject.org/pub/epel/8/Everything/x86_64/Packages/r/rubygem-git-1.5.0-2.el8.noarch.rpm")),
}),
},
}),
InitOptions: &ApplyCloudFormationInitOptions{
// Optional, which configsets to activate (['default'] by default)
ConfigSets: []*string{
jsii.String("default"),
},
// Optional, how long the installation is expected to take (5 minutes by default)
Timeout: awscdk.Duration_Minutes(jsii.Number(30)),
// Optional, whether to include the --url argument when running cfn-init and cfn-signal commands (false by default)
IncludeUrl: jsii.Boolean(true),
// Optional, whether to include the --role argument when running cfn-init and cfn-signal commands (false by default)
IncludeRole: jsii.Boolean(true),
},
})
func NewInitConfig ¶
func NewInitConfig(elements *[]InitElement) InitConfig
type InitElement ¶
type InitElement interface {
// Returns the init element type for this element.
ElementType() *string
}
Base class for all CloudFormation Init elements.
Example:
var myBucket bucket
handle := ec2.NewInitServiceRestartHandle()
ec2.CloudFormationInit_FromElements(ec2.InitFile_FromString(jsii.String("/etc/nginx/nginx.conf"), jsii.String("..."), &InitFileOptions{
ServiceRestartHandles: []initServiceRestartHandle{
handle,
},
}), ec2.InitSource_FromS3Object(jsii.String("/var/www/html"), myBucket, jsii.String("html.zip"), &InitSourceOptions{
ServiceRestartHandles: []*initServiceRestartHandle{
handle,
},
}), ec2.InitService_Enable(jsii.String("nginx"), &InitServiceOptions{
ServiceRestartHandle: handle,
}))
type InitFile ¶
type InitFile interface {
InitElement
// Returns the init element type for this element.
ElementType() *string
}
Create files on the EC2 instance.
Example:
var vpc vpc
var instanceType instanceType
ec2.NewInstance(this, jsii.String("Instance"), &InstanceProps{
Vpc: Vpc,
InstanceType: InstanceType,
MachineImage: ec2.MachineImage_LatestAmazonLinux2023(),
Init: ec2.CloudFormationInit_FromElements(ec2.InitService_SystemdConfigFile(jsii.String("simpleserver"), &SystemdConfigFileOptions{
Command: jsii.String("/usr/bin/python3 -m http.server 8080"),
Cwd: jsii.String("/var/www/html"),
}), ec2.InitService_Enable(jsii.String("simpleserver"), &InitServiceOptions{
ServiceManager: ec2.ServiceManager_SYSTEMD,
}), ec2.InitFile_FromString(jsii.String("/var/www/html/index.html"), jsii.String("Hello! It's working!"))),
})
func InitFile_FromAsset ¶
func InitFile_FromAsset(targetFileName *string, path *string, options *InitFileAssetOptions) InitFile
Create an asset from the given file.
This is appropriate for files that are too large to embed into the template.
func InitFile_FromExistingAsset ¶
func InitFile_FromExistingAsset(targetFileName *string, asset awss3assets.Asset, options *InitFileOptions) InitFile
Use a file from an asset at instance startup time.
func InitFile_FromFileInline ¶
func InitFile_FromFileInline(targetFileName *string, sourceFileName *string, options *InitFileOptions) InitFile
Read a file from disk and use its contents.
The file will be embedded in the template, so care should be taken to not exceed the template size.
If options.base64encoded is set to true, this will base64-encode the file's contents.
func InitFile_FromObject ¶
func InitFile_FromObject(fileName *string, obj *map[string]interface{}, options *InitFileOptions) InitFile
Use a JSON-compatible object as the file content, write it to a JSON file.
May contain tokens.
func InitFile_FromS3Object ¶
func InitFile_FromS3Object(fileName *string, bucket awss3.IBucket, key *string, options *InitFileOptions) InitFile
Download a file from an S3 bucket at instance startup time.
func InitFile_FromString ¶
func InitFile_FromString(fileName *string, content *string, options *InitFileOptions) InitFile
Use a literal string as the file content.
func InitFile_FromUrl ¶
func InitFile_FromUrl(fileName *string, url *string, options *InitFileOptions) InitFile
Download from a URL at instance startup time.
func InitFile_Symlink ¶
func InitFile_Symlink(fileName *string, target *string, options *InitFileOptions) InitFile
Write a symlink with the given symlink target.
func InitService_SystemdConfigFile ¶ added in v2.70.0
func InitService_SystemdConfigFile(serviceName *string, options *SystemdConfigFileOptions) InitFile
Install a systemd-compatible config file for the given service.
This is a helper function to create a simple systemd configuration file that will allow running a service on the machine using `InitService.enable()`.
Systemd allows many configuration options; this function does not pretend to expose all of them. If you need advanced configuration options, you can use `InitFile` to create exactly the configuration file you need at `/etc/systemd/system/${serviceName}.service`.
type InitFileAssetOptions ¶
type InitFileAssetOptions struct {
// True if the inlined content (from a string or file) should be treated as base64 encoded.
//
// Only applicable for inlined string and file content.
// Default: false.
//
Base64Encoded *bool `field:"optional" json:"base64Encoded" yaml:"base64Encoded"`
// The name of the owning group for this file.
//
// Not supported for Windows systems.
// Default: 'root'.
//
Group *string `field:"optional" json:"group" yaml:"group"`
// A six-digit octal value representing the mode for this file.
//
// Use the first three digits for symlinks and the last three digits for
// setting permissions. To create a symlink, specify 120xxx, where xxx
// defines the permissions of the target file. To specify permissions for a
// file, use the last three digits, such as 000644.
//
// Not supported for Windows systems.
// Default: '000644'.
//
Mode *string `field:"optional" json:"mode" yaml:"mode"`
// The name of the owning user for this file.
//
// Not supported for Windows systems.
// Default: 'root'.
//
Owner *string `field:"optional" json:"owner" yaml:"owner"`
// Restart the given service after this file has been written.
// Default: - Do not restart any service.
//
ServiceRestartHandles *[]InitServiceRestartHandle `field:"optional" json:"serviceRestartHandles" yaml:"serviceRestartHandles"`
// Specify a custom hash for this asset.
//
// If `assetHashType` is set it must
// be set to `AssetHashType.CUSTOM`. For consistency, this custom hash will
// be SHA256 hashed and encoded as hex. The resulting hash will be the asset
// hash.
//
// NOTE: the hash is used in order to identify a specific revision of the asset, and
// used for optimizing and caching deployment activities related to this asset such as
// packaging, uploading to Amazon S3, etc. If you chose to customize the hash, you will
// need to make sure it is updated every time the asset changes, or otherwise it is
// possible that some deployments will not be invalidated.
// Default: - based on `assetHashType`.
//
AssetHash *string `field:"optional" json:"assetHash" yaml:"assetHash"`
// Specifies the type of hash to calculate for this asset.
//
// If `assetHash` is configured, this option must be `undefined` or
// `AssetHashType.CUSTOM`.
// Default: - the default is `AssetHashType.SOURCE`, but if `assetHash` is
// explicitly specified this value defaults to `AssetHashType.CUSTOM`.
//
AssetHashType awscdk.AssetHashType `field:"optional" json:"assetHashType" yaml:"assetHashType"`
// Bundle the asset by executing a command in a Docker container or a custom bundling provider.
//
// The asset path will be mounted at `/asset-input`. The Docker
// container is responsible for putting content at `/asset-output`.
// The content at `/asset-output` will be zipped and used as the
// final asset.
// Default: - uploaded as-is to S3 if the asset is a regular file or a .zip file,
// archived into a .zip file and uploaded to S3 otherwise
//
Bundling *awscdk.BundlingOptions `field:"optional" json:"bundling" yaml:"bundling"`
// File paths matching the patterns will be excluded.
//
// See `ignoreMode` to set the matching behavior.
// Has no effect on Assets bundled using the `bundling` property.
// Default: - nothing is excluded.
//
Exclude *[]*string `field:"optional" json:"exclude" yaml:"exclude"`
// A strategy for how to handle symlinks.
// Default: SymlinkFollowMode.NEVER
//
FollowSymlinks awscdk.SymlinkFollowMode `field:"optional" json:"followSymlinks" yaml:"followSymlinks"`
// The ignore behavior to use for `exclude` patterns.
// Default: IgnoreMode.GLOB
//
IgnoreMode awscdk.IgnoreMode `field:"optional" json:"ignoreMode" yaml:"ignoreMode"`
// Whether or not the asset needs to exist beyond deployment time;
//
// i.e.
// are copied over to a different location and not needed afterwards.
// Setting this property to true has an impact on the lifecycle of the asset,
// because we will assume that it is safe to delete after the CloudFormation
// deployment succeeds.
//
// For example, Lambda Function assets are copied over to Lambda during
// deployment. Therefore, it is not necessary to store the asset in S3, so
// we consider those deployTime assets.
// Default: false.
//
DeployTime *bool `field:"optional" json:"deployTime" yaml:"deployTime"`
// A list of principals that should be able to read this asset from S3.
//
// You can use `asset.grantRead(principal)` to grant read permissions later.
// Default: - No principals that can read file asset.
//
Readers *[]awsiam.IGrantable `field:"optional" json:"readers" yaml:"readers"`
}
Additional options for creating an InitFile from an asset.
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"
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
var dockerImage dockerImage
var grantable iGrantable
var initServiceRestartHandle initServiceRestartHandle
var localBundling iLocalBundling
initFileAssetOptions := &InitFileAssetOptions{
AssetHash: jsii.String("assetHash"),
AssetHashType: cdk.AssetHashType_SOURCE,
Base64Encoded: jsii.Boolean(false),
Bundling: &BundlingOptions{
Image: dockerImage,
// the properties below are optional
BundlingFileAccess: cdk.BundlingFileAccess_VOLUME_COPY,
Command: []*string{
jsii.String("command"),
},
Entrypoint: []*string{
jsii.String("entrypoint"),
},
Environment: map[string]*string{
"environmentKey": jsii.String("environment"),
},
Local: localBundling,
Network: jsii.String("network"),
OutputType: cdk.BundlingOutput_ARCHIVED,
Platform: jsii.String("platform"),
SecurityOpt: jsii.String("securityOpt"),
User: jsii.String("user"),
Volumes: []dockerVolume{
&dockerVolume{
ContainerPath: jsii.String("containerPath"),
HostPath: jsii.String("hostPath"),
// the properties below are optional
Consistency: cdk.DockerVolumeConsistency_CONSISTENT,
},
},
VolumesFrom: []*string{
jsii.String("volumesFrom"),
},
WorkingDirectory: jsii.String("workingDirectory"),
},
DeployTime: jsii.Boolean(false),
Exclude: []*string{
jsii.String("exclude"),
},
FollowSymlinks: cdk.SymlinkFollowMode_NEVER,
Group: jsii.String("group"),
IgnoreMode: cdk.IgnoreMode_GLOB,
Mode: jsii.String("mode"),
Owner: jsii.String("owner"),
Readers: []*iGrantable{
grantable,
},
ServiceRestartHandles: []*initServiceRestartHandle{
initServiceRestartHandle,
},
}
type InitFileOptions ¶
type InitFileOptions struct {
// True if the inlined content (from a string or file) should be treated as base64 encoded.
//
// Only applicable for inlined string and file content.
// Default: false.
//
Base64Encoded *bool `field:"optional" json:"base64Encoded" yaml:"base64Encoded"`
// The name of the owning group for this file.
//
// Not supported for Windows systems.
// Default: 'root'.
//
Group *string `field:"optional" json:"group" yaml:"group"`
// A six-digit octal value representing the mode for this file.
//
// Use the first three digits for symlinks and the last three digits for
// setting permissions. To create a symlink, specify 120xxx, where xxx
// defines the permissions of the target file. To specify permissions for a
// file, use the last three digits, such as 000644.
//
// Not supported for Windows systems.
// Default: '000644'.
//
Mode *string `field:"optional" json:"mode" yaml:"mode"`
// The name of the owning user for this file.
//
// Not supported for Windows systems.
// Default: 'root'.
//
Owner *string `field:"optional" json:"owner" yaml:"owner"`
// Restart the given service after this file has been written.
// Default: - Do not restart any service.
//
ServiceRestartHandles *[]InitServiceRestartHandle `field:"optional" json:"serviceRestartHandles" yaml:"serviceRestartHandles"`
}
Options for InitFile.
Example:
var myBucket bucket
handle := ec2.NewInitServiceRestartHandle()
ec2.CloudFormationInit_FromElements(ec2.InitFile_FromString(jsii.String("/etc/nginx/nginx.conf"), jsii.String("..."), &InitFileOptions{
ServiceRestartHandles: []initServiceRestartHandle{
handle,
},
}), ec2.InitSource_FromS3Object(jsii.String("/var/www/html"), myBucket, jsii.String("html.zip"), &InitSourceOptions{
ServiceRestartHandles: []*initServiceRestartHandle{
handle,
},
}), ec2.InitService_Enable(jsii.String("nginx"), &InitServiceOptions{
ServiceRestartHandle: handle,
}))
type InitGroup ¶
type InitGroup interface {
InitElement
// Returns the init element type for this element.
ElementType() *string
}
Create Linux/UNIX groups and assign group IDs.
Not supported for Windows systems.
Example:
var vpc vpc
var instanceType instanceType
var machineImage iMachineImage
ec2.NewInstance(this, jsii.String("Instance"), &InstanceProps{
Vpc: Vpc,
InstanceType: InstanceType,
MachineImage: MachineImage,
// Showing the most complex setup, if you have simpler requirements
// you can use `CloudFormationInit.fromElements()`.
Init: ec2.CloudFormationInit_FromConfigSets(&ConfigSetProps{
ConfigSets: map[string][]*string{
// Applies the configs below in this order
"default": []*string{
jsii.String("yumPreinstall"),
jsii.String("config"),
},
},
Configs: map[string]initConfig{
"yumPreinstall": ec2.NewInitConfig([]InitElement{
ec2.InitPackage_yum(jsii.String("git")),
}),
"config": ec2.NewInitConfig([]InitElement{
ec2.InitFile_fromObject(jsii.String("/etc/stack.json"), map[string]interface{}{
"stackId": awscdk.*stack_of(this).stackId,
"stackName": awscdk.*stack_of(this).stackName,
"region": awscdk.*stack_of(this).region,
}),
ec2.InitGroup_fromName(jsii.String("my-group")),
ec2.InitUser_fromName(jsii.String("my-user")),
ec2.InitPackage_rpm(jsii.String("http://mirrors.ukfast.co.uk/sites/dl.fedoraproject.org/pub/epel/8/Everything/x86_64/Packages/r/rubygem-git-1.5.0-2.el8.noarch.rpm")),
}),
},
}),
InitOptions: &ApplyCloudFormationInitOptions{
// Optional, which configsets to activate (['default'] by default)
ConfigSets: []*string{
jsii.String("default"),
},
// Optional, how long the installation is expected to take (5 minutes by default)
Timeout: awscdk.Duration_Minutes(jsii.Number(30)),
// Optional, whether to include the --url argument when running cfn-init and cfn-signal commands (false by default)
IncludeUrl: jsii.Boolean(true),
// Optional, whether to include the --role argument when running cfn-init and cfn-signal commands (false by default)
IncludeRole: jsii.Boolean(true),
},
})
func InitGroup_FromName ¶
Create a group from its name, and optionally, group id.
func NewInitGroup ¶
type InitPackage ¶
type InitPackage interface {
InitElement
// Returns the init element type for this element.
ElementType() *string
RenderPackageVersions() interface{}
}
A package to be installed during cfn-init time.
Example:
var vpc vpc
var instanceType instanceType
var machineImage iMachineImage
ec2.NewInstance(this, jsii.String("Instance"), &InstanceProps{
Vpc: Vpc,
InstanceType: InstanceType,
MachineImage: MachineImage,
// Showing the most complex setup, if you have simpler requirements
// you can use `CloudFormationInit.fromElements()`.
Init: ec2.CloudFormationInit_FromConfigSets(&ConfigSetProps{
ConfigSets: map[string][]*string{
// Applies the configs below in this order
"default": []*string{
jsii.String("yumPreinstall"),
jsii.String("config"),
},
},
Configs: map[string]initConfig{
"yumPreinstall": ec2.NewInitConfig([]InitElement{
ec2.InitPackage_yum(jsii.String("git")),
}),
"config": ec2.NewInitConfig([]InitElement{
ec2.InitFile_fromObject(jsii.String("/etc/stack.json"), map[string]interface{}{
"stackId": awscdk.*stack_of(this).stackId,
"stackName": awscdk.*stack_of(this).stackName,
"region": awscdk.*stack_of(this).region,
}),
ec2.InitGroup_fromName(jsii.String("my-group")),
ec2.InitUser_fromName(jsii.String("my-user")),
ec2.InitPackage_rpm(jsii.String("http://mirrors.ukfast.co.uk/sites/dl.fedoraproject.org/pub/epel/8/Everything/x86_64/Packages/r/rubygem-git-1.5.0-2.el8.noarch.rpm")),
}),
},
}),
InitOptions: &ApplyCloudFormationInitOptions{
// Optional, which configsets to activate (['default'] by default)
ConfigSets: []*string{
jsii.String("default"),
},
// Optional, how long the installation is expected to take (5 minutes by default)
Timeout: awscdk.Duration_Minutes(jsii.Number(30)),
// Optional, whether to include the --url argument when running cfn-init and cfn-signal commands (false by default)
IncludeUrl: jsii.Boolean(true),
// Optional, whether to include the --role argument when running cfn-init and cfn-signal commands (false by default)
IncludeRole: jsii.Boolean(true),
},
})
func InitPackage_Apt ¶
func InitPackage_Apt(packageName *string, options *NamedPackageOptions) InitPackage
Install a package using APT.
func InitPackage_Msi ¶
func InitPackage_Msi(location *string, options *LocationPackageOptions) InitPackage
Install an MSI package from an HTTP URL or a location on disk.
func InitPackage_Python ¶
func InitPackage_Python(packageName *string, options *NamedPackageOptions) InitPackage
Install a package from PyPI.
func InitPackage_Rpm ¶
func InitPackage_Rpm(location *string, options *LocationPackageOptions) InitPackage
Install an RPM from an HTTP URL or a location on disk.
func InitPackage_RubyGem ¶
func InitPackage_RubyGem(gemName *string, options *NamedPackageOptions) InitPackage
Install a package from RubyGems.
func InitPackage_Yum ¶
func InitPackage_Yum(packageName *string, options *NamedPackageOptions) InitPackage
Install a package using Yum.
func NewInitPackage ¶
func NewInitPackage(type_ *string, versions *[]*string, packageName *string, serviceHandles *[]InitServiceRestartHandle) InitPackage
type InitService ¶
type InitService interface {
InitElement
// Returns the init element type for this element.
ElementType() *string
}
A services that be enabled, disabled or restarted when the instance is launched.
Example:
var myBucket bucket
handle := ec2.NewInitServiceRestartHandle()
ec2.CloudFormationInit_FromElements(ec2.InitFile_FromString(jsii.String("/etc/nginx/nginx.conf"), jsii.String("..."), &InitFileOptions{
ServiceRestartHandles: []initServiceRestartHandle{
handle,
},
}), ec2.InitSource_FromS3Object(jsii.String("/var/www/html"), myBucket, jsii.String("html.zip"), &InitSourceOptions{
ServiceRestartHandles: []*initServiceRestartHandle{
handle,
},
}), ec2.InitService_Enable(jsii.String("nginx"), &InitServiceOptions{
ServiceRestartHandle: handle,
}))
func InitService_Disable ¶
func InitService_Disable(serviceName *string) InitService
Disable and stop the given service.
func InitService_Enable ¶
func InitService_Enable(serviceName *string, options *InitServiceOptions) InitService
Enable and start the given service, optionally restarting it.
type InitServiceOptions ¶
type InitServiceOptions struct {
// Enable or disable this service.
//
// Set to true to ensure that the service will be started automatically upon boot.
//
// Set to false to ensure that the service will not be started automatically upon boot.
// Default: - true if used in `InitService.enable()`, no change to service
// state if used in `InitService.fromOptions()`.
//
Enabled *bool `field:"optional" json:"enabled" yaml:"enabled"`
// Make sure this service is running or not running after cfn-init finishes.
//
// Set to true to ensure that the service is running after cfn-init finishes.
//
// Set to false to ensure that the service is not running after cfn-init finishes.
// Default: - same value as `enabled`.
//
EnsureRunning *bool `field:"optional" json:"ensureRunning" yaml:"ensureRunning"`
// What service manager to use.
//
// This needs to match the actual service manager on your Operating System.
// For example, Amazon Linux 1 uses SysVinit, but Amazon Linux 2 uses Systemd.
// Default: ServiceManager.SYSVINIT for Linux images, ServiceManager.WINDOWS for Windows images
//
ServiceManager ServiceManager `field:"optional" json:"serviceManager" yaml:"serviceManager"`
// Restart service when the actions registered into the restartHandle have been performed.
//
// Register actions into the restartHandle by passing it to `InitFile`, `InitCommand`,
// `InitPackage` and `InitSource` objects.
// Default: - No files trigger restart.
//
ServiceRestartHandle InitServiceRestartHandle `field:"optional" json:"serviceRestartHandle" yaml:"serviceRestartHandle"`
}
Options for an InitService.
Example:
var myBucket bucket
handle := ec2.NewInitServiceRestartHandle()
ec2.CloudFormationInit_FromElements(ec2.InitFile_FromString(jsii.String("/etc/nginx/nginx.conf"), jsii.String("..."), &InitFileOptions{
ServiceRestartHandles: []initServiceRestartHandle{
handle,
},
}), ec2.InitSource_FromS3Object(jsii.String("/var/www/html"), myBucket, jsii.String("html.zip"), &InitSourceOptions{
ServiceRestartHandles: []*initServiceRestartHandle{
handle,
},
}), ec2.InitService_Enable(jsii.String("nginx"), &InitServiceOptions{
ServiceRestartHandle: handle,
}))
type InitServiceRestartHandle ¶
type InitServiceRestartHandle interface {
}
An object that represents reasons to restart an InitService.
Pass an instance of this object to the `InitFile`, `InitCommand`, `InitSource` and `InitPackage` objects, and finally to an `InitService` itself to cause the actions (files, commands, sources, and packages) to trigger a restart of the service.
For example, the following will run a custom command to install Nginx, and trigger the nginx service to be restarted after the command has run.
```ts const handle = new ec2.InitServiceRestartHandle(); ec2.CloudFormationInit.fromElements(
ec2.InitCommand.shellCommand('/usr/bin/custom-nginx-install.sh', { serviceRestartHandles: [handle] }),
ec2.InitService.enable('nginx', { serviceRestartHandle: handle }),
); ```.
Example:
var myBucket bucket
handle := ec2.NewInitServiceRestartHandle()
ec2.CloudFormationInit_FromElements(ec2.InitFile_FromString(jsii.String("/etc/nginx/nginx.conf"), jsii.String("..."), &InitFileOptions{
ServiceRestartHandles: []initServiceRestartHandle{
handle,
},
}), ec2.InitSource_FromS3Object(jsii.String("/var/www/html"), myBucket, jsii.String("html.zip"), &InitSourceOptions{
ServiceRestartHandles: []*initServiceRestartHandle{
handle,
},
}), ec2.InitService_Enable(jsii.String("nginx"), &InitServiceOptions{
ServiceRestartHandle: handle,
}))
func NewInitServiceRestartHandle ¶
func NewInitServiceRestartHandle() InitServiceRestartHandle
type InitSource ¶
type InitSource interface {
InitElement
// Returns the init element type for this element.
ElementType() *string
}
Extract an archive into a directory.
Example:
var myBucket bucket
handle := ec2.NewInitServiceRestartHandle()
ec2.CloudFormationInit_FromElements(ec2.InitFile_FromString(jsii.String("/etc/nginx/nginx.conf"), jsii.String("..."), &InitFileOptions{
ServiceRestartHandles: []initServiceRestartHandle{
handle,
},
}), ec2.InitSource_FromS3Object(jsii.String("/var/www/html"), myBucket, jsii.String("html.zip"), &InitSourceOptions{
ServiceRestartHandles: []*initServiceRestartHandle{
handle,
},
}), ec2.InitService_Enable(jsii.String("nginx"), &InitServiceOptions{
ServiceRestartHandle: handle,
}))
func InitSource_FromAsset ¶
func InitSource_FromAsset(targetDirectory *string, path *string, options *InitSourceAssetOptions) InitSource
Create an InitSource from an asset created from the given path.
func InitSource_FromExistingAsset ¶
func InitSource_FromExistingAsset(targetDirectory *string, asset awss3assets.Asset, options *InitSourceOptions) InitSource
Extract a directory from an existing directory asset.
func InitSource_FromGitHub ¶
func InitSource_FromGitHub(targetDirectory *string, owner *string, repo *string, refSpec *string, options *InitSourceOptions) InitSource
Extract a GitHub branch into a given directory.
func InitSource_FromS3Object ¶
func InitSource_FromS3Object(targetDirectory *string, bucket awss3.IBucket, key *string, options *InitSourceOptions) InitSource
Extract an archive stored in an S3 bucket into the given directory.
func InitSource_FromUrl ¶
func InitSource_FromUrl(targetDirectory *string, url *string, options *InitSourceOptions) InitSource
Retrieve a URL and extract it into the given directory.
type InitSourceAssetOptions ¶
type InitSourceAssetOptions struct {
// Restart the given services after this archive has been extracted.
// Default: - Do not restart any service.
//
ServiceRestartHandles *[]InitServiceRestartHandle `field:"optional" json:"serviceRestartHandles" yaml:"serviceRestartHandles"`
// Specify a custom hash for this asset.
//
// If `assetHashType` is set it must
// be set to `AssetHashType.CUSTOM`. For consistency, this custom hash will
// be SHA256 hashed and encoded as hex. The resulting hash will be the asset
// hash.
//
// NOTE: the hash is used in order to identify a specific revision of the asset, and
// used for optimizing and caching deployment activities related to this asset such as
// packaging, uploading to Amazon S3, etc. If you chose to customize the hash, you will
// need to make sure it is updated every time the asset changes, or otherwise it is
// possible that some deployments will not be invalidated.
// Default: - based on `assetHashType`.
//
AssetHash *string `field:"optional" json:"assetHash" yaml:"assetHash"`
// Specifies the type of hash to calculate for this asset.
//
// If `assetHash` is configured, this option must be `undefined` or
// `AssetHashType.CUSTOM`.
// Default: - the default is `AssetHashType.SOURCE`, but if `assetHash` is
// explicitly specified this value defaults to `AssetHashType.CUSTOM`.
//
AssetHashType awscdk.AssetHashType `field:"optional" json:"assetHashType" yaml:"assetHashType"`
// Bundle the asset by executing a command in a Docker container or a custom bundling provider.
//
// The asset path will be mounted at `/asset-input`. The Docker
// container is responsible for putting content at `/asset-output`.
// The content at `/asset-output` will be zipped and used as the
// final asset.
// Default: - uploaded as-is to S3 if the asset is a regular file or a .zip file,
// archived into a .zip file and uploaded to S3 otherwise
//
Bundling *awscdk.BundlingOptions `field:"optional" json:"bundling" yaml:"bundling"`
// File paths matching the patterns will be excluded.
//
// See `ignoreMode` to set the matching behavior.
// Has no effect on Assets bundled using the `bundling` property.
// Default: - nothing is excluded.
//
Exclude *[]*string `field:"optional" json:"exclude" yaml:"exclude"`
// A strategy for how to handle symlinks.
// Default: SymlinkFollowMode.NEVER
//
FollowSymlinks awscdk.SymlinkFollowMode `field:"optional" json:"followSymlinks" yaml:"followSymlinks"`
// The ignore behavior to use for `exclude` patterns.
// Default: IgnoreMode.GLOB
//
IgnoreMode awscdk.IgnoreMode `field:"optional" json:"ignoreMode" yaml:"ignoreMode"`
// Whether or not the asset needs to exist beyond deployment time;
//
// i.e.
// are copied over to a different location and not needed afterwards.
// Setting this property to true has an impact on the lifecycle of the asset,
// because we will assume that it is safe to delete after the CloudFormation
// deployment succeeds.
//
// For example, Lambda Function assets are copied over to Lambda during
// deployment. Therefore, it is not necessary to store the asset in S3, so
// we consider those deployTime assets.
// Default: false.
//
DeployTime *bool `field:"optional" json:"deployTime" yaml:"deployTime"`
// A list of principals that should be able to read this asset from S3.
//
// You can use `asset.grantRead(principal)` to grant read permissions later.
// Default: - No principals that can read file asset.
//
Readers *[]awsiam.IGrantable `field:"optional" json:"readers" yaml:"readers"`
}
Additional options for an InitSource that builds an asset from local files.
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"
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
var dockerImage dockerImage
var grantable iGrantable
var initServiceRestartHandle initServiceRestartHandle
var localBundling iLocalBundling
initSourceAssetOptions := &InitSourceAssetOptions{
AssetHash: jsii.String("assetHash"),
AssetHashType: cdk.AssetHashType_SOURCE,
Bundling: &BundlingOptions{
Image: dockerImage,
// the properties below are optional
BundlingFileAccess: cdk.BundlingFileAccess_VOLUME_COPY,
Command: []*string{
jsii.String("command"),
},
Entrypoint: []*string{
jsii.String("entrypoint"),
},
Environment: map[string]*string{
"environmentKey": jsii.String("environment"),
},
Local: localBundling,
Network: jsii.String("network"),
OutputType: cdk.BundlingOutput_ARCHIVED,
Platform: jsii.String("platform"),
SecurityOpt: jsii.String("securityOpt"),
User: jsii.String("user"),
Volumes: []dockerVolume{
&dockerVolume{
ContainerPath: jsii.String("containerPath"),
HostPath: jsii.String("hostPath"),
// the properties below are optional
Consistency: cdk.DockerVolumeConsistency_CONSISTENT,
},
},
VolumesFrom: []*string{
jsii.String("volumesFrom"),
},
WorkingDirectory: jsii.String("workingDirectory"),
},
DeployTime: jsii.Boolean(false),
Exclude: []*string{
jsii.String("exclude"),
},
FollowSymlinks: cdk.SymlinkFollowMode_NEVER,
IgnoreMode: cdk.IgnoreMode_GLOB,
Readers: []*iGrantable{
grantable,
},
ServiceRestartHandles: []*initServiceRestartHandle{
initServiceRestartHandle,
},
}
type InitSourceOptions ¶
type InitSourceOptions struct {
// Restart the given services after this archive has been extracted.
// Default: - Do not restart any service.
//
ServiceRestartHandles *[]InitServiceRestartHandle `field:"optional" json:"serviceRestartHandles" yaml:"serviceRestartHandles"`
}
Additional options for an InitSource.
Example:
var myBucket bucket
handle := ec2.NewInitServiceRestartHandle()
ec2.CloudFormationInit_FromElements(ec2.InitFile_FromString(jsii.String("/etc/nginx/nginx.conf"), jsii.String("..."), &InitFileOptions{
ServiceRestartHandles: []initServiceRestartHandle{
handle,
},
}), ec2.InitSource_FromS3Object(jsii.String("/var/www/html"), myBucket, jsii.String("html.zip"), &InitSourceOptions{
ServiceRestartHandles: []*initServiceRestartHandle{
handle,
},
}), ec2.InitService_Enable(jsii.String("nginx"), &InitServiceOptions{
ServiceRestartHandle: handle,
}))
type InitUser ¶
type InitUser interface {
InitElement
// Returns the init element type for this element.
ElementType() *string
}
Create Linux/UNIX users and to assign user IDs.
Users are created as non-interactive system users with a shell of /sbin/nologin. This is by design and cannot be modified.
Not supported for Windows systems.
Example:
var vpc vpc
var instanceType instanceType
var machineImage iMachineImage
ec2.NewInstance(this, jsii.String("Instance"), &InstanceProps{
Vpc: Vpc,
InstanceType: InstanceType,
MachineImage: MachineImage,
// Showing the most complex setup, if you have simpler requirements
// you can use `CloudFormationInit.fromElements()`.
Init: ec2.CloudFormationInit_FromConfigSets(&ConfigSetProps{
ConfigSets: map[string][]*string{
// Applies the configs below in this order
"default": []*string{
jsii.String("yumPreinstall"),
jsii.String("config"),
},
},
Configs: map[string]initConfig{
"yumPreinstall": ec2.NewInitConfig([]InitElement{
ec2.InitPackage_yum(jsii.String("git")),
}),
"config": ec2.NewInitConfig([]InitElement{
ec2.InitFile_fromObject(jsii.String("/etc/stack.json"), map[string]interface{}{
"stackId": awscdk.*stack_of(this).stackId,
"stackName": awscdk.*stack_of(this).stackName,
"region": awscdk.*stack_of(this).region,
}),
ec2.InitGroup_fromName(jsii.String("my-group")),
ec2.InitUser_fromName(jsii.String("my-user")),
ec2.InitPackage_rpm(jsii.String("http://mirrors.ukfast.co.uk/sites/dl.fedoraproject.org/pub/epel/8/Everything/x86_64/Packages/r/rubygem-git-1.5.0-2.el8.noarch.rpm")),
}),
},
}),
InitOptions: &ApplyCloudFormationInitOptions{
// Optional, which configsets to activate (['default'] by default)
ConfigSets: []*string{
jsii.String("default"),
},
// Optional, how long the installation is expected to take (5 minutes by default)
Timeout: awscdk.Duration_Minutes(jsii.Number(30)),
// Optional, whether to include the --url argument when running cfn-init and cfn-signal commands (false by default)
IncludeUrl: jsii.Boolean(true),
// Optional, whether to include the --role argument when running cfn-init and cfn-signal commands (false by default)
IncludeRole: jsii.Boolean(true),
},
})
func InitUser_FromName ¶
func InitUser_FromName(userName *string, options *InitUserOptions) InitUser
Create a user from user name.
func NewInitUser ¶
func NewInitUser(userName *string, userOptions *InitUserOptions) InitUser
type InitUserOptions ¶
type InitUserOptions struct {
// A list of group names.
//
// The user will be added to each group in the list.
// Default: the user is not associated with any groups.
//
Groups *[]*string `field:"optional" json:"groups" yaml:"groups"`
// The user's home directory.
// Default: assigned by the OS.
//
HomeDir *string `field:"optional" json:"homeDir" yaml:"homeDir"`
// A user ID.
//
// The creation process fails if the user name exists with a different user ID.
// If the user ID is already assigned to an existing user the operating system may
// reject the creation request.
// Default: assigned by the OS.
//
UserId *float64 `field:"optional" json:"userId" yaml:"userId"`
}
Optional parameters used when creating a user.
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"
initUserOptions := &InitUserOptions{
Groups: []*string{
jsii.String("groups"),
},
HomeDir: jsii.String("homeDir"),
UserId: jsii.Number(123),
}
type Instance ¶
type Instance interface {
awscdk.Resource
IInstance
// Allows specify security group connections for the instance.
Connections() Connections
// The environment this resource belongs to.
//
// For resources that are created and managed by the CDK
// (generally, those created by creating new class instances like Role, Bucket, etc.),
// this is always the same as the environment of the stack they belong to;
// however, for imported resources
// (those obtained from static methods like fromRoleArn, fromBucketName, etc.),
// that might be different than the stack they were imported into.
Env() *awscdk.ResourceEnvironment
// The principal to grant permissions to.
GrantPrincipal() awsiam.IPrincipal
// the underlying instance resource.
Instance() CfnInstance
// The availability zone the instance was launched in.
InstanceAvailabilityZone() *string
// The instance's ID.
InstanceId() *string
// Private DNS name for this instance.
InstancePrivateDnsName() *string
// Private IP for this instance.
InstancePrivateIp() *string
// Publicly-routable DNS name for this instance.
//
// (May be an empty string if the instance does not have a public name).
InstancePublicDnsName() *string
// Publicly-routable IP address for this instance.
//
// (May be an empty string if the instance does not have a public IP).
InstancePublicIp() *string
// The tree node.
Node() constructs.Node
// The type of OS the instance is running.
OsType() OperatingSystemType
// Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
//
// This value will resolve to one of the following:
// - a concrete value (e.g. `"my-awesome-bucket"`)
// - `undefined`, when a name should be generated by CloudFormation
// - a concrete name generated automatically during synthesis, in
// cross-environment scenarios.
PhysicalName() *string
// The IAM role assumed by the instance.
Role() awsiam.IRole
// The stack in which this resource is defined.
Stack() awscdk.Stack
// UserData for the instance.
UserData() UserData
// Add the security group to the instance.
AddSecurityGroup(securityGroup ISecurityGroup)
// Adds a statement to the IAM role assumed by the instance.
AddToRolePolicy(statement awsiam.PolicyStatement)
// Add command to the startup script of the instance.
//
// The command must be in the scripting language supported by the instance's OS (i.e. Linux/Windows).
AddUserData(commands ...*string)
// Use a CloudFormation Init configuration at instance startup.
//
// This does the following:
//
// - Attaches the CloudFormation Init metadata to the Instance resource.
// - Add commands to the instance UserData to run `cfn-init` and `cfn-signal`.
// - Update the instance's CreationPolicy to wait for the `cfn-signal` commands.
ApplyCloudFormationInit(init CloudFormationInit, options *ApplyCloudFormationInitOptions)
// Apply the given removal policy to this resource.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
GeneratePhysicalName() *string
// Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`).
//
// Normally, this token will resolve to `arnAttr`, but if the resource is
// referenced across environments, `arnComponents` will be used to synthesize
// a concrete ARN with the resource's physical name. Make sure to reference
// `this.physicalName` in `arnComponents`.
GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
// Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`).
//
// Normally, this token will resolve to `nameAttr`, but if the resource is
// referenced across environments, it will be resolved to `this.physicalName`,
// which will be a concrete name.
GetResourceNameAttribute(nameAttr *string) *string
// Returns a string representation of this construct.
ToString() *string
}
This represents a single EC2 instance.
Example:
var vpc iVpc
lb := elb.NewLoadBalancer(this, jsii.String("LB"), &LoadBalancerProps{
Vpc: Vpc,
InternetFacing: jsii.Boolean(true),
})
// instance to add as the target for load balancer.
instance := ec2.NewInstance(this, jsii.String("targetInstance"), &InstanceProps{
Vpc: vpc,
InstanceType: ec2.InstanceType_Of(ec2.InstanceClass_BURSTABLE2, ec2.InstanceSize_MICRO),
MachineImage: ec2.NewAmazonLinuxImage(&AmazonLinuxImageProps{
Generation: ec2.AmazonLinuxGeneration_AMAZON_LINUX_2,
}),
})
lb.AddTarget(elb.NewInstanceTarget(instance))
func NewInstance ¶
func NewInstance(scope constructs.Construct, id *string, props *InstanceProps) Instance
type InstanceArchitecture ¶
type InstanceArchitecture string
Identifies an instance's CPU architecture.
const ( // ARM64 architecture. InstanceArchitecture_ARM_64 InstanceArchitecture = "ARM_64" // x86-64 architecture. InstanceArchitecture_X86_64 InstanceArchitecture = "X86_64" )
type InstanceClass ¶
type InstanceClass string
What class and generation of instance to use.
We have both symbolic and concrete enums for every type.
The first are for people that want to specify by purpose, the second one are for people who already know exactly what 'R4' means.
Example:
var vpc vpc
instance := rds.NewDatabaseInstance(this, jsii.String("Instance"), &DatabaseInstanceProps{
Engine: rds.DatabaseInstanceEngine_OracleSe2(&OracleSe2InstanceEngineProps{
Version: rds.OracleEngineVersion_VER_19_0_0_0_2020_04_R1(),
}),
// optional, defaults to m5.large
InstanceType: ec2.InstanceType_Of(ec2.InstanceClass_BURSTABLE3, ec2.InstanceSize_SMALL),
Credentials: rds.Credentials_FromGeneratedSecret(jsii.String("syscdk")),
// Optional - will default to 'admin' username and generated password
Vpc: Vpc,
VpcSubnets: &SubnetSelection{
SubnetType: ec2.SubnetType_PRIVATE_WITH_EGRESS,
},
})
const ( // Standard instances, 3rd generation. InstanceClass_STANDARD3 InstanceClass = "STANDARD3" // Standard instances, 3rd generation. InstanceClass_M3 InstanceClass = "M3" // Standard instances, 4th generation. InstanceClass_STANDARD4 InstanceClass = "STANDARD4" // Standard instances, 4th generation. InstanceClass_M4 InstanceClass = "M4" // Standard instances, 5th generation. InstanceClass_STANDARD5 InstanceClass = "STANDARD5" // Standard instances, 5th generation. InstanceClass_M5 InstanceClass = "M5" // Standard instances with local NVME drive, 5th generation. InstanceClass_STANDARD5_NVME_DRIVE InstanceClass = "STANDARD5_NVME_DRIVE" // Standard instances with local NVME drive, 5th generation. InstanceClass_M5D InstanceClass = "M5D" // Standard instances based on AMD EPYC, 5th generation. InstanceClass_STANDARD5_AMD InstanceClass = "STANDARD5_AMD" // Standard instances based on AMD EPYC, 5th generation. InstanceClass_M5A InstanceClass = "M5A" // Standard instances based on AMD EPYC with local NVME drive, 5th generation. InstanceClass_STANDARD5_AMD_NVME_DRIVE InstanceClass = "STANDARD5_AMD_NVME_DRIVE" // Standard instances based on AMD EPYC with local NVME drive, 5th generation. InstanceClass_M5AD InstanceClass = "M5AD" // Standard instances for high performance computing, 5th generation. InstanceClass_STANDARD5_HIGH_PERFORMANCE InstanceClass = "STANDARD5_HIGH_PERFORMANCE" // Standard instances for high performance computing, 5th generation. InstanceClass_M5N InstanceClass = "M5N" // Standard instances with local NVME drive for high performance computing, 5th generation. InstanceClass_STANDARD5_NVME_DRIVE_HIGH_PERFORMANCE InstanceClass = "STANDARD5_NVME_DRIVE_HIGH_PERFORMANCE" // Standard instances with local NVME drive for high performance computing, 5th generation. InstanceClass_M5DN InstanceClass = "M5DN" // Standard instances with high memory and compute capacity based on Intel Xeon Scalable (Cascade Lake) processors, 5nd generation. InstanceClass_STANDARD5_HIGH_COMPUTE InstanceClass = "STANDARD5_HIGH_COMPUTE" // Standard instances with high memory and compute capacity based on Intel Xeon Scalable (Cascade Lake) processors, 5nd generation. InstanceClass_M5ZN InstanceClass = "M5ZN" // Memory optimized instances, 3rd generation. InstanceClass_MEMORY3 InstanceClass = "MEMORY3" // Memory optimized instances, 3rd generation. InstanceClass_R3 InstanceClass = "R3" // Memory optimized instances, 4th generation. InstanceClass_MEMORY4 InstanceClass = "MEMORY4" // Memory optimized instances, 4th generation. InstanceClass_R4 InstanceClass = "R4" // Memory optimized instances, 5th generation. InstanceClass_MEMORY5 InstanceClass = "MEMORY5" // Memory optimized instances, 5th generation. InstanceClass_R5 InstanceClass = "R5" // Memory optimized instances based on AMD EPYC, 6th generation. InstanceClass_MEMORY6_AMD InstanceClass = "MEMORY6_AMD" // Memory optimized instances based on AMD EPYC, 6th generation. InstanceClass_R6A InstanceClass = "R6A" // Memory optimized instances, 6th generation with Intel Xeon Scalable processors (3rd generation processors code named Ice Lake). InstanceClass_MEMORY6_INTEL InstanceClass = "MEMORY6_INTEL" // Memory optimized instances, 6th generation with Intel Xeon Scalable processors (3rd generation processors code named Ice Lake). InstanceClass_R6I InstanceClass = "R6I" // Memory optimized instances with local NVME drive, 6th generation with Intel Xeon Scalable processors (3rd generation processors code named Ice Lake). InstanceClass_MEMORY6_INTEL_NVME_DRIVE InstanceClass = "MEMORY6_INTEL_NVME_DRIVE" // Memory optimized instances with local NVME drive, 6th generation with Intel Xeon Scalable processors (3rd generation processors code named Ice Lake). InstanceClass_R6ID InstanceClass = "R6ID" // Memory optimized instances for high performance computing powered by Intel Xeon Scalable processors (code named Ice Lake), 6th generation. InstanceClass_MEMORY6_INTEL_HIGH_PERFORMANCE InstanceClass = "MEMORY6_INTEL_HIGH_PERFORMANCE" // Memory optimized instances for high performance computing powered by Intel Xeon Scalable processors (code named Ice Lake), 6th generation. InstanceClass_R6IN InstanceClass = "R6IN" // Memory optimized instances with local NVME drive for high performance computing powered by Intel Xeon Scalable processors (code named Ice Lake), 6th generation. InstanceClass_MEMORY6_INTEL_NVME_DRIVE_HIGH_PERFORMANCE InstanceClass = "MEMORY6_INTEL_NVME_DRIVE_HIGH_PERFORMANCE" // Memory optimized instances with local NVME drive for high performance computing powered by Intel Xeon Scalable processors (code named Ice Lake), 6th generation. InstanceClass_R6IDN InstanceClass = "R6IDN" // Memory optimized instances for high performance computing, 5th generation. InstanceClass_MEMORY5_HIGH_PERFORMANCE InstanceClass = "MEMORY5_HIGH_PERFORMANCE" // Memory optimized instances for high performance computing, 5th generation. InstanceClass_R5N InstanceClass = "R5N" // Memory optimized instances with local NVME drive, 5th generation. InstanceClass_MEMORY5_NVME_DRIVE InstanceClass = "MEMORY5_NVME_DRIVE" // Memory optimized instances with local NVME drive, 5th generation. InstanceClass_R5D InstanceClass = "R5D" // Memory optimized instances with local NVME drive for high performance computing, 5th generation. InstanceClass_MEMORY5_NVME_DRIVE_HIGH_PERFORMANCE InstanceClass = "MEMORY5_NVME_DRIVE_HIGH_PERFORMANCE" // Memory optimized instances with local NVME drive for high performance computing, 5th generation. InstanceClass_R5DN InstanceClass = "R5DN" // Memory optimized instances based on AMD EPYC, 5th generation. InstanceClass_MEMORY5_AMD InstanceClass = "MEMORY5_AMD" // Memory optimized instances based on AMD EPYC, 5th generation. InstanceClass_R5A InstanceClass = "R5A" // Memory optimized instances based on AMD EPYC with local NVME drive, 5th generation. InstanceClass_MEMORY5_AMD_NVME_DRIVE InstanceClass = "MEMORY5_AMD_NVME_DRIVE" // Memory optimized instances based on AMD EPYC with local NVME drive, 5th generation. InstanceClass_R5AD InstanceClass = "R5AD" // High memory instances (3TB) based on Intel Xeon Platinum 8176M (Skylake) processors, 1st generation. InstanceClass_HIGH_MEMORY_3TB_1 InstanceClass = "HIGH_MEMORY_3TB_1" // High memory instances (3TB) based on Intel Xeon Platinum 8176M (Skylake) processors, 1st generation. InstanceClass_U_3TB1 InstanceClass = "U_3TB1" // High memory instances (6TB) based on Intel Xeon Platinum 8176M (Skylake) processors, 1st generation. InstanceClass_HIGH_MEMORY_6TB_1 InstanceClass = "HIGH_MEMORY_6TB_1" // High memory instances (6TB) based on Intel Xeon Platinum 8176M (Skylake) processors, 1st generation. InstanceClass_U_6TB1 InstanceClass = "U_6TB1" // High memory instances (9TB) based on Intel Xeon Platinum 8176M (Skylake) processors, 1st generation. InstanceClass_HIGH_MEMORY_9TB_1 InstanceClass = "HIGH_MEMORY_9TB_1" // High memory instances (9TB) based on Intel Xeon Platinum 8176M (Skylake) processors, 1st generation. InstanceClass_U_9TB1 InstanceClass = "U_9TB1" // High memory instances (12TB) based on Intel Xeon Platinum 8176M (Skylake) processors, 1st generation. InstanceClass_HIGH_MEMORY_12TB_1 InstanceClass = "HIGH_MEMORY_12TB_1" // High memory instances (12TB) based on Intel Xeon Platinum 8176M (Skylake) processors, 1st generation. InstanceClass_U_12TB1 InstanceClass = "U_12TB1" // High memory instances (18TB) based on Intel Xeon Scalable (Cascade Lake) processors, 1st generation. InstanceClass_HIGH_MEMORY_18TB_1 InstanceClass = "HIGH_MEMORY_18TB_1" // High memory instances (18TB) based on Intel Xeon Scalable (Cascade Lake) processors, 1st generation. InstanceClass_U_18TB1 InstanceClass = "U_18TB1" // High memory instances (24TB) based on Intel Xeon Scalable (Cascade Lake) processors, 1st generation. InstanceClass_HIGH_MEMORY_24TB_1 InstanceClass = "HIGH_MEMORY_24TB_1" // High memory instances (24TB) based on Intel Xeon Scalable (Cascade Lake) processors, 1st generation. InstanceClass_U_24TB1 InstanceClass = "U_24TB1" // Memory optimized instances that are also EBS-optimized, 5th generation. InstanceClass_MEMORY5_EBS_OPTIMIZED InstanceClass = "MEMORY5_EBS_OPTIMIZED" // Memory optimized instances that are also EBS-optimized, 5th generation. InstanceClass_R5B InstanceClass = "R5B" // Memory optimized instances, 6th generation with Graviton2 processors. InstanceClass_MEMORY6_GRAVITON InstanceClass = "MEMORY6_GRAVITON" // Memory optimized instances, 6th generation with Graviton2 processors. InstanceClass_R6G InstanceClass = "R6G" // Memory optimized instances, 6th generation with Graviton2 processors and local NVME drive. InstanceClass_MEMORY6_GRAVITON2_NVME_DRIVE InstanceClass = "MEMORY6_GRAVITON2_NVME_DRIVE" // Memory optimized instances, 6th generation with Graviton2 processors and local NVME drive. InstanceClass_R6GD InstanceClass = "R6GD" // Memory optimized instances, 7th generation with Graviton3 processors. // // This instance class is currently only available in US East (Ohio), US East (N. Virginia), US West (Oregon), and Europe (Ireland). InstanceClass_MEMORY7_GRAVITON InstanceClass = "MEMORY7_GRAVITON" // Memory optimized instances, 7th generation with Graviton3 processors. // // This instance class is currently only available in US East (Ohio), US East (N. Virginia), US West (Oregon), and Europe (Ireland). InstanceClass_R7G InstanceClass = "R7G" // Memory optimized instances, 7th generation with Graviton3 processors and local NVME drive. // // This instance class is currently only available in US East (Ohio), US East (N. Virginia), US West (Oregon), and Europe (Ireland). InstanceClass_MEMORY7_GRAVITON3_NVME_DRIVE InstanceClass = "MEMORY7_GRAVITON3_NVME_DRIVE" // Memory optimized instances, 7th generation with Graviton3 processors and local NVME drive. // // This instance class is currently only available in US East (Ohio), US East (N. Virginia), US West (Oregon), and Europe (Ireland). InstanceClass_R7GD InstanceClass = "R7GD" // Memory optimized instances based on Intel Xeon Scalable (Sapphire Rapids) processors, 7th generation w/ 3.2GHz turbo frequency. InstanceClass_MEMORY7_INTEL_BASE InstanceClass = "MEMORY7_INTEL_BASE" // Memory optimized instances based on Intel Xeon Scalable (Sapphire Rapids) processors, 7th generation w/ 3.2GHz turbo frequency. InstanceClass_R7I InstanceClass = "R7I" // Memory optimized instances based on Intel Xeon Scalable (Sapphire Rapids) processors, 7th generation, with sustained 3.9GHz turbo frequency. InstanceClass_MEMORY7_INTEL InstanceClass = "MEMORY7_INTEL" // Memory optimized instances based on Intel Xeon Scalable (Sapphire Rapids) processors, 7th generation, with sustained 3.9GHz turbo frequency. InstanceClass_R7IZ InstanceClass = "R7IZ" // Memory optimized instances based on 4th generation AMD EPYC (codename Genoa), 7th generation. InstanceClass_MEMORY7_AMD InstanceClass = "MEMORY7_AMD" // Memory optimized instances based on 4th generation AMD EPYC (codename Genoa), 7th generation. InstanceClass_R7A InstanceClass = "R7A" // Memory optimized instances with Graviton4 processors. InstanceClass_MEMORY8_GRAVITON InstanceClass = "MEMORY8_GRAVITON" // Memory optimized instances with Graviton4 processors. InstanceClass_R8G InstanceClass = "R8G" // Compute optimized instances, 3rd generation. InstanceClass_COMPUTE3 InstanceClass = "COMPUTE3" // Compute optimized instances, 3rd generation. InstanceClass_C3 InstanceClass = "C3" // Compute optimized instances, 4th generation. InstanceClass_COMPUTE4 InstanceClass = "COMPUTE4" // Compute optimized instances, 4th generation. InstanceClass_C4 InstanceClass = "C4" // Compute optimized instances, 5th generation. InstanceClass_COMPUTE5 InstanceClass = "COMPUTE5" // Compute optimized instances, 5th generation. InstanceClass_C5 InstanceClass = "C5" // Compute optimized instances with local NVME drive, 5th generation. InstanceClass_COMPUTE5_NVME_DRIVE InstanceClass = "COMPUTE5_NVME_DRIVE" // Compute optimized instances with local NVME drive, 5th generation. InstanceClass_C5D InstanceClass = "C5D" // Compute optimized instances based on AMD EPYC, 5th generation. InstanceClass_COMPUTE5_AMD InstanceClass = "COMPUTE5_AMD" // Compute optimized instances based on AMD EPYC, 5th generation. InstanceClass_C5A InstanceClass = "C5A" // Compute optimized instances with local NVME drive based on AMD EPYC, 5th generation. InstanceClass_COMPUTE5_AMD_NVME_DRIVE InstanceClass = "COMPUTE5_AMD_NVME_DRIVE" // Compute optimized instances with local NVME drive based on AMD EPYC, 5th generation. InstanceClass_C5AD InstanceClass = "C5AD" // Compute optimized instances for high performance computing, 5th generation. InstanceClass_COMPUTE5_HIGH_PERFORMANCE InstanceClass = "COMPUTE5_HIGH_PERFORMANCE" // Compute optimized instances for high performance computing, 5th generation. InstanceClass_C5N InstanceClass = "C5N" // Compute optimized instances, 6th generation. InstanceClass_COMPUTE6_INTEL InstanceClass = "COMPUTE6_INTEL" // Compute optimized instances, 6th generation. InstanceClass_C6I InstanceClass = "C6I" // Compute optimized instances with local NVME drive, 6th generation. InstanceClass_COMPUTE6_INTEL_NVME_DRIVE InstanceClass = "COMPUTE6_INTEL_NVME_DRIVE" // Compute optimized instances with local NVME drive, 6th generation. InstanceClass_C6ID InstanceClass = "C6ID" // Compute optimized instances for high performance computing, 6th generation. InstanceClass_COMPUTE6_INTEL_HIGH_PERFORMANCE InstanceClass = "COMPUTE6_INTEL_HIGH_PERFORMANCE" // Compute optimized instances for high performance computing, 6th generation. InstanceClass_C6IN InstanceClass = "C6IN" // Compute optimized instances based on AMD EPYC (codename Milan), 6th generation. InstanceClass_COMPUTE6_AMD InstanceClass = "COMPUTE6_AMD" // Compute optimized instances based on AMD EPYC (codename Milan), 6th generation. InstanceClass_C6A InstanceClass = "C6A" // Compute optimized instances for high performance computing, 6th generation with Graviton2 processors. InstanceClass_COMPUTE6_GRAVITON2 InstanceClass = "COMPUTE6_GRAVITON2" // Compute optimized instances for high performance computing, 6th generation with Graviton2 processors. InstanceClass_C6G InstanceClass = "C6G" // Compute optimized instances for high performance computing, 7th generation with Graviton3 processors. InstanceClass_COMPUTE7_GRAVITON3 InstanceClass = "COMPUTE7_GRAVITON3" // Compute optimized instances for high performance computing, 7th generation with Graviton3 processors. InstanceClass_C7G InstanceClass = "C7G" // Compute optimized instances for high performance computing, 6th generation with Graviton2 processors and local NVME drive. InstanceClass_COMPUTE6_GRAVITON2_NVME_DRIVE InstanceClass = "COMPUTE6_GRAVITON2_NVME_DRIVE" // Compute optimized instances for high performance computing, 6th generation with Graviton2 processors and local NVME drive. InstanceClass_C6GD InstanceClass = "C6GD" // Compute optimized instances for high performance computing, 7th generation with Graviton3 processors and local NVME drive. // // This instance class is currently only available in US East (Ohio), US East (N. Virginia), US West (Oregon), and Europe (Ireland). InstanceClass_COMPUTE7_GRAVITON3_NVME_DRIVE InstanceClass = "COMPUTE7_GRAVITON3_NVME_DRIVE" // Compute optimized instances for high performance computing, 7th generation with Graviton3 processors and local NVME drive. // // This instance class is currently only available in US East (Ohio), US East (N. Virginia), US West (Oregon), and Europe (Ireland). InstanceClass_C7GD InstanceClass = "C7GD" // Compute optimized instances for high performance computing, 6th generation with Graviton2 processors and high network bandwidth capabilities. InstanceClass_COMPUTE6_GRAVITON2_HIGH_NETWORK_BANDWIDTH InstanceClass = "COMPUTE6_GRAVITON2_HIGH_NETWORK_BANDWIDTH" // Compute optimized instances for high performance computing, 6th generation with Graviton2 processors and high network bandwidth capabilities. InstanceClass_C6GN InstanceClass = "C6GN" // Compute optimized instances for high performance computing, 7th generation with Graviton3 processors and high network bandwidth capabilities. InstanceClass_COMPUTE7_GRAVITON3_HIGH_NETWORK_BANDWIDTH InstanceClass = "COMPUTE7_GRAVITON3_HIGH_NETWORK_BANDWIDTH" // Compute optimized instances for high performance computing, 7th generation with Graviton3 processors and high network bandwidth capabilities. InstanceClass_C7GN InstanceClass = "C7GN" // Compute optimized instances based on Intel Xeon Scalable (Sapphire Rapids) processors, 7th generation. InstanceClass_COMPUTE7_INTEL InstanceClass = "COMPUTE7_INTEL" // Compute optimized instances based on Intel Xeon Scalable (Sapphire Rapids) processors, 7th generation. InstanceClass_C7I InstanceClass = "C7I" // Compute optimized instances based on 4th generation AMD EPYC (codename Genoa), 7th generation. InstanceClass_COMPUTE7_AMD InstanceClass = "COMPUTE7_AMD" // Compute optimized instances based on 4th generation AMD EPYC (codename Genoa), 7th generation. InstanceClass_C7A InstanceClass = "C7A" // Storage-optimized instances, 2nd generation. InstanceClass_STORAGE2 InstanceClass = "STORAGE2" // Storage-optimized instances, 2nd generation. InstanceClass_D2 InstanceClass = "D2" // Storage-optimized instances, 3rd generation. InstanceClass_STORAGE3 InstanceClass = "STORAGE3" // Storage-optimized instances, 3rd generation. InstanceClass_D3 InstanceClass = "D3" // Storage-optimized instances, 3rd generation. InstanceClass_STORAGE3_ENHANCED_NETWORK InstanceClass = "STORAGE3_ENHANCED_NETWORK" // Storage-optimized instances, 3rd generation. InstanceClass_D3EN InstanceClass = "D3EN" // Storage/compute balanced instances, 1st generation. InstanceClass_STORAGE_COMPUTE_1 InstanceClass = "STORAGE_COMPUTE_1" // Storage/compute balanced instances, 1st generation. InstanceClass_H1 InstanceClass = "H1" // High performance computing powered by AWS Trainium. InstanceClass_TRAINING_ACCELERATOR1 InstanceClass = "TRAINING_ACCELERATOR1" // High performance computing powered by AWS Trainium. InstanceClass_TRN1 InstanceClass = "TRN1" // Network-optimized high performance computing powered by AWS Trainium. InstanceClass_TRAINING_ACCELERATOR1_ENHANCED_NETWORK InstanceClass = "TRAINING_ACCELERATOR1_ENHANCED_NETWORK" // Network-optimized high performance computing powered by AWS Trainium. InstanceClass_TRN1N InstanceClass = "TRN1N" // I/O-optimized instances, 3rd generation. InstanceClass_IO3 InstanceClass = "IO3" // I/O-optimized instances, 3rd generation. InstanceClass_I3 InstanceClass = "I3" // I/O-optimized instances with local NVME drive, 3rd generation. InstanceClass_IO3_DENSE_NVME_DRIVE InstanceClass = "IO3_DENSE_NVME_DRIVE" // I/O-optimized instances with local NVME drive, 3rd generation. InstanceClass_I3EN InstanceClass = "I3EN" // I/O-optimized instances with local NVME drive powered by Intel Xeon Scalable processors (code named Ice Lake), 4th generation. InstanceClass_IO4_INTEL InstanceClass = "IO4_INTEL" // I/O-optimized instances with local NVME drive powered by Intel Xeon Scalable processors (code named Ice Lake), 4th generation. InstanceClass_I4I InstanceClass = "I4I" // Storage optimized instances powered by Graviton2 processor, 4th generation. InstanceClass_STORAGE4_GRAVITON InstanceClass = "STORAGE4_GRAVITON" // Storage optimized instances powered by Graviton2 processor, 4th generation. InstanceClass_I4G InstanceClass = "I4G" // Storage optimized instances powered by Graviton2 processor, 4th generation. InstanceClass_STORAGE4_GRAVITON_NETWORK_OPTIMIZED InstanceClass = "STORAGE4_GRAVITON_NETWORK_OPTIMIZED" // Storage optimized instances powered by Graviton2 processor, 4th generation. InstanceClass_IM4GN InstanceClass = "IM4GN" // Storage optimized instances powered by Graviton2 processor, 4th generation. InstanceClass_STORAGE4_GRAVITON_NETWORK_STORAGE_OPTIMIZED InstanceClass = "STORAGE4_GRAVITON_NETWORK_STORAGE_OPTIMIZED" // Storage optimized instances powered by Graviton2 processor, 4th generation. InstanceClass_IS4GEN InstanceClass = "IS4GEN" // Burstable instances, 2nd generation. InstanceClass_BURSTABLE2 InstanceClass = "BURSTABLE2" // Burstable instances, 2nd generation. InstanceClass_T2 InstanceClass = "T2" // Burstable instances, 3rd generation. InstanceClass_BURSTABLE3 InstanceClass = "BURSTABLE3" // Burstable instances, 3rd generation. InstanceClass_T3 InstanceClass = "T3" // Burstable instances based on AMD EPYC, 3rd generation. InstanceClass_BURSTABLE3_AMD InstanceClass = "BURSTABLE3_AMD" // Burstable instances based on AMD EPYC, 3rd generation. InstanceClass_T3A InstanceClass = "T3A" // Burstable instances, 4th generation with Graviton2 processors. InstanceClass_BURSTABLE4_GRAVITON InstanceClass = "BURSTABLE4_GRAVITON" // Burstable instances, 4th generation with Graviton2 processors. InstanceClass_T4G InstanceClass = "T4G" // Memory-intensive instances, 1st generation. InstanceClass_MEMORY_INTENSIVE_1 InstanceClass = "MEMORY_INTENSIVE_1" // Memory-intensive instances, 1st generation. InstanceClass_X1 InstanceClass = "X1" // Memory-intensive instances, extended, 1st generation. InstanceClass_MEMORY_INTENSIVE_1_EXTENDED InstanceClass = "MEMORY_INTENSIVE_1_EXTENDED" // Memory-intensive instances, extended, 1st generation. InstanceClass_X1E InstanceClass = "X1E" // Memory-intensive instances, 2nd generation with Graviton2 processors. // // This instance type can be used only in RDS. It is not supported in EC2. InstanceClass_MEMORY_INTENSIVE_2_GRAVITON2 InstanceClass = "MEMORY_INTENSIVE_2_GRAVITON2" // Memory-intensive instances, 2nd generation with Graviton2 processors. // // This instance type can be used only in RDS. It is not supported in EC2. InstanceClass_X2G InstanceClass = "X2G" // Memory-intensive instances, 2nd generation with Graviton2 processors and local NVME drive. InstanceClass_MEMORY_INTENSIVE_2_GRAVITON2_NVME_DRIVE InstanceClass = "MEMORY_INTENSIVE_2_GRAVITON2_NVME_DRIVE" // Memory-intensive instances, 2nd generation with Graviton2 processors and local NVME drive. InstanceClass_X2GD InstanceClass = "X2GD" // Memory-intensive instances with higher network bandwith, local NVME drive, and extended memory. // // Intel Xeon Scalable (Ice Lake) processors. InstanceClass_MEMORY_INTENSIVE_2_XT_INTEL InstanceClass = "MEMORY_INTENSIVE_2_XT_INTEL" // Memory-intensive instances with higher network bandwith, local NVME drive, and extended memory. // // Intel Xeon Scalable (Ice Lake) processors. InstanceClass_X2IEDN InstanceClass = "X2IEDN" // Memory-intensive instances with higher network bandwith and local NVME drive, Intel Xeon Scalable (Ice Lake) processors. InstanceClass_MEMORY_INTENSIVE_2_INTEL InstanceClass = "MEMORY_INTENSIVE_2_INTEL" // Memory-intensive instances with higher network bandwith and local NVME drive, Intel Xeon Scalable (Ice Lake) processors. InstanceClass_X2IDN InstanceClass = "X2IDN" // Memory-intensive instances with higher network bandwith and single-threaded performance, Intel Xeon Scalable (Cascade Lake) processors. InstanceClass_MEMORY_INTENSIVE_2_XTZ_INTEL InstanceClass = "MEMORY_INTENSIVE_2_XTZ_INTEL" // Memory-intensive instances with higher network bandwith and single-threaded performance, Intel Xeon Scalable (Cascade Lake) processors. InstanceClass_X2IEZN InstanceClass = "X2IEZN" // Instances with customizable hardware acceleration, 1st generation. InstanceClass_FPGA1 InstanceClass = "FPGA1" // Instances with customizable hardware acceleration, 1st generation. InstanceClass_F1 InstanceClass = "F1" // Graphics-optimized instances, 3rd generation. InstanceClass_GRAPHICS3_SMALL InstanceClass = "GRAPHICS3_SMALL" // Graphics-optimized instances, 3rd generation. InstanceClass_G3S InstanceClass = "G3S" // Graphics-optimized instances, 3rd generation. InstanceClass_GRAPHICS3 InstanceClass = "GRAPHICS3" // Graphics-optimized instances, 3rd generation. InstanceClass_G3 InstanceClass = "G3" // Graphics-optimized instances with NVME drive for high performance computing, 4th generation. InstanceClass_GRAPHICS4_NVME_DRIVE_HIGH_PERFORMANCE InstanceClass = "GRAPHICS4_NVME_DRIVE_HIGH_PERFORMANCE" // Graphics-optimized instances with NVME drive for high performance computing, 4th generation. InstanceClass_G4DN InstanceClass = "G4DN" // Graphics-optimized instances based on AMD EPYC And Radeon Pro GPU (NAVI) with local NVME drive, 4th generation. InstanceClass_GRAPHICS4_AMD_NVME_DRIVE InstanceClass = "GRAPHICS4_AMD_NVME_DRIVE" // Graphics-optimized instances based on AMD EPYC And Radeon Pro GPU (NAVI) with local NVME drive, 4th generation. InstanceClass_G4AD InstanceClass = "G4AD" // Graphics-optimized instances, 5th generation. InstanceClass_GRAPHICS5 InstanceClass = "GRAPHICS5" // Graphics-optimized instances, 5th generation. InstanceClass_G5 InstanceClass = "G5" // Graphics-optimized instances powered by AWS Graviton2 Processors and NVIDIA T4G Tensor Core GPUs, 5th generation. InstanceClass_GRAPHICS5_GRAVITON2 InstanceClass = "GRAPHICS5_GRAVITON2" // Graphics-optimized instances powered by AWS Graviton2 Processors and NVIDIA T4G Tensor Core GPUs, 5th generation. InstanceClass_G5G InstanceClass = "G5G" // Graphics-optimized instances, 6th generation. InstanceClass_GRAPHICS6 InstanceClass = "GRAPHICS6" // Graphics-optimized instances, 6th generation. InstanceClass_G6 InstanceClass = "G6" // Parallel-processing optimized instances, 2nd generation. InstanceClass_PARALLEL2 InstanceClass = "PARALLEL2" // Parallel-processing optimized instances, 2nd generation. InstanceClass_P2 InstanceClass = "P2" // Parallel-processing optimized instances, 3rd generation. InstanceClass_PARALLEL3 InstanceClass = "PARALLEL3" // Parallel-processing optimized instances, 3rd generation. InstanceClass_P3 InstanceClass = "P3" // Parallel-processing optimized instances with local NVME drive for high performance computing, 3rd generation. InstanceClass_PARALLEL3_NVME_DRIVE_HIGH_PERFORMANCE InstanceClass = "PARALLEL3_NVME_DRIVE_HIGH_PERFORMANCE" // Parallel-processing optimized instances with local NVME drive for high performance computing, 3rd generation. InstanceClass_P3DN InstanceClass = "P3DN" // Parallel-processing optimized instances with local NVME drive, extended, 4th generation (in developer preview). InstanceClass_PARALLEL4_NVME_DRIVE_EXTENDED InstanceClass = "PARALLEL4_NVME_DRIVE_EXTENDED" // Parallel-processing optimized instances with local NVME drive, extended, 4th generation (in developer preview). InstanceClass_P4DE InstanceClass = "P4DE" // Parallel-processing optimized instances, 4th generation. InstanceClass_PARALLEL4 InstanceClass = "PARALLEL4" // Parallel-processing optimized instances, 4th generation. InstanceClass_P4D InstanceClass = "P4D" // Parallel-processing optimized instances, 5th generation. InstanceClass_PARALLEL5 InstanceClass = "PARALLEL5" // Parallel-processing optimized instances, 5th generation. InstanceClass_P5 InstanceClass = "P5" // Arm processor based instances, 1st generation. InstanceClass_ARM1 InstanceClass = "ARM1" // Arm processor based instances, 1st generation. InstanceClass_A1 InstanceClass = "A1" // Arm processor based instances, 2nd generation. InstanceClass_STANDARD6_GRAVITON InstanceClass = "STANDARD6_GRAVITON" // Arm processor based instances, 2nd generation. InstanceClass_M6G InstanceClass = "M6G" // Standard instances based on Intel (Ice Lake), 6th generation. InstanceClass_STANDARD6_INTEL InstanceClass = "STANDARD6_INTEL" // Standard instances based on Intel (Ice Lake), 6th generation. InstanceClass_M6I InstanceClass = "M6I" // Standard instances based on Intel (Ice Lake) with local NVME drive, 6th generation. InstanceClass_STANDARD6_INTEL_NVME_DRIVE InstanceClass = "STANDARD6_INTEL_NVME_DRIVE" // Standard instances based on Intel (Ice Lake) with local NVME drive, 6th generation. InstanceClass_M6ID InstanceClass = "M6ID" // Standard instances for high performance computing powered by Intel Xeon Scalable processors (code named Ice Lake), 6th generation. InstanceClass_STANDARD6_INTEL_HIGH_PERFORMANCE InstanceClass = "STANDARD6_INTEL_HIGH_PERFORMANCE" // Standard instances for high performance computing powered by Intel Xeon Scalable processors (code named Ice Lake), 6th generation. InstanceClass_M6IN InstanceClass = "M6IN" // Standard instances with local NVME drive for high performance computing powered by Intel Xeon Scalable processors (code named Ice Lake), 6th generation. InstanceClass_STANDARD6_INTEL_NVME_DRIVE_HIGH_PERFORMANCE InstanceClass = "STANDARD6_INTEL_NVME_DRIVE_HIGH_PERFORMANCE" // Standard instances with local NVME drive for high performance computing powered by Intel Xeon Scalable processors (code named Ice Lake), 6th generation. InstanceClass_M6IDN InstanceClass = "M6IDN" // Standard instances based on 3rd Gen AMD EPYC processors, 6th generation. InstanceClass_STANDARD6_AMD InstanceClass = "STANDARD6_AMD" // Standard instances based on 3rd Gen AMD EPYC processors, 6th generation. InstanceClass_M6A InstanceClass = "M6A" // Standard instances, 6th generation with Graviton2 processors and local NVME drive. InstanceClass_STANDARD6_GRAVITON2_NVME_DRIVE InstanceClass = "STANDARD6_GRAVITON2_NVME_DRIVE" // Standard instances, 6th generation with Graviton2 processors and local NVME drive. InstanceClass_M6GD InstanceClass = "M6GD" // Standard instances, 7th generation with Graviton3 processors. // // This instance class is currently only available in US East (Ohio), US East (N. Virginia), US West (Oregon), and Europe (Ireland). InstanceClass_STANDARD7_GRAVITON InstanceClass = "STANDARD7_GRAVITON" // Standard instances, 7th generation with Graviton3 processors. // // This instance class is currently only available in US East (Ohio), US East (N. Virginia), US West (Oregon), and Europe (Ireland). InstanceClass_M7G InstanceClass = "M7G" // Standard instances, 7th generation with Graviton3 processors and local NVME drive. // // This instance class is currently only available in US East (Ohio), US East (N. Virginia), US West (Oregon), and Europe (Ireland). InstanceClass_STANDARD7_GRAVITON3_NVME_DRIVE InstanceClass = "STANDARD7_GRAVITON3_NVME_DRIVE" // Standard instances, 7th generation with Graviton3 processors and local NVME drive. // // This instance class is currently only available in US East (Ohio), US East (N. Virginia), US West (Oregon), and Europe (Ireland). InstanceClass_M7GD InstanceClass = "M7GD" // Standard instances with high memory and compute capacity based on Intel Xeon Scalable (Sapphire Rapids) processors, 7th generation. InstanceClass_STANDARD7_INTEL InstanceClass = "STANDARD7_INTEL" // Standard instances with high memory and compute capacity based on Intel Xeon Scalable (Sapphire Rapids) processors, 7th generation. InstanceClass_M7I InstanceClass = "M7I" // Flexible instances with high memory and compute capacity based on Intel Xeon Scalable (Sapphire Rapids) processors, 7th generation The M7i-Flex instances deliver a baseline of 40% CPU performance, and can scale up to full CPU performance 95% of the time. InstanceClass_STANDARD7_INTEL_FLEX InstanceClass = "STANDARD7_INTEL_FLEX" // Flexible instances with high memory and compute capacity based on Intel Xeon Scalable (Sapphire Rapids) processors, 7th generation The M7i-Flex instances deliver a baseline of 40% CPU performance, and can scale up to full CPU performance 95% of the time. InstanceClass_M7I_FLEX InstanceClass = "M7I_FLEX" // Standard instances based on 4th generation AMD EPYC (codename Genoa), 7th generation. InstanceClass_STANDARD7_AMD InstanceClass = "STANDARD7_AMD" // Standard instances based on 4th generation AMD EPYC (codename Genoa), 7th generation. InstanceClass_M7A InstanceClass = "M7A" // High memory and compute capacity instances, 1st generation. InstanceClass_HIGH_COMPUTE_MEMORY1 InstanceClass = "HIGH_COMPUTE_MEMORY1" // High memory and compute capacity instances, 1st generation. InstanceClass_Z1D InstanceClass = "Z1D" // Inferentia Chips based instances for machine learning inference applications, 1st generation. InstanceClass_INFERENCE1 InstanceClass = "INFERENCE1" // Inferentia Chips based instances for machine learning inference applications, 1st generation. InstanceClass_INF1 InstanceClass = "INF1" // Inferentia Chips based instances for machine learning inference applications, 2nd generation. InstanceClass_INFERENCE2 InstanceClass = "INFERENCE2" // Inferentia Chips based instances for machine learning inference applications, 2nd generation. InstanceClass_INF2 InstanceClass = "INF2" // Macintosh instances built on Apple Mac mini computers, 1st generation with Intel procesors. InstanceClass_MACINTOSH1_INTEL InstanceClass = "MACINTOSH1_INTEL" // Macintosh instances built on Apple Mac mini computers, 1st generation with Intel procesors. InstanceClass_MAC1 InstanceClass = "MAC1" // Macintosh instances built on Apple Mac mini 2020 computers, 2nd generation with Apple silicon M1 processors. InstanceClass_MACINTOSH2_M1 InstanceClass = "MACINTOSH2_M1" // Macintosh instances built on Apple Mac mini 2020 computers, 2nd generation with Apple silicon M1 processors. InstanceClass_MAC2 InstanceClass = "MAC2" // Macintosh instances built on Apple Mac mini 2023 computers, 2nd generation with Apple silicon M2 processors. InstanceClass_MACINTOSH2_M2 InstanceClass = "MACINTOSH2_M2" // Macintosh instances built on Apple Mac mini 2023 computers, 2nd generation with Apple silicon M2 processors. InstanceClass_MAC2_M2 InstanceClass = "MAC2_M2" // Macintosh instances built on Apple Mac mini 2023 computers, 2nd generation with Apple silicon M2 Pro processors. InstanceClass_MACINTOSH2_M2_PRO InstanceClass = "MACINTOSH2_M2_PRO" // Macintosh instances built on Apple Mac mini 2023 computers, 2nd generation with Apple silicon M2 Pro processors. InstanceClass_MAC2_M2PRO InstanceClass = "MAC2_M2PRO" // Macintosh instances built on 2022 Mac Studio hardware powered by Apple silicon M1 Ultra processors. InstanceClass_MACINTOSH2_M1_ULTRA InstanceClass = "MACINTOSH2_M1_ULTRA" // Macintosh instances built on 2022 Mac Studio hardware powered by Apple silicon M1 Ultra processors. InstanceClass_MAC2_M1ULTRA InstanceClass = "MAC2_M1ULTRA" // Multi-stream video transcoding instances for resolutions up to 4K UHD, 1st generation. InstanceClass_VIDEO_TRANSCODING1 InstanceClass = "VIDEO_TRANSCODING1" // Multi-stream video transcoding instances for resolutions up to 4K UHD, 1st generation. InstanceClass_VT1 InstanceClass = "VT1" // High performance computing based on AMD EPYC, 6th generation. InstanceClass_HIGH_PERFORMANCE_COMPUTING6_AMD InstanceClass = "HIGH_PERFORMANCE_COMPUTING6_AMD" // High performance computing based on AMD EPYC, 6th generation. InstanceClass_HPC6A InstanceClass = "HPC6A" // High performance computing with local NVME drive based on 6th generation with Intel Xeon Scalable processors (3rd generation processors code named Ice Lake), 6th generation. InstanceClass_HIGH_PERFORMANCE_COMPUTING6_INTEL_NVME_DRIVE InstanceClass = "HIGH_PERFORMANCE_COMPUTING6_INTEL_NVME_DRIVE" // High performance computing with local NVME drive based on 6th generation with Intel Xeon Scalable processors (3rd generation processors code named Ice Lake), 6th generation. InstanceClass_HPC6ID InstanceClass = "HPC6ID" // High performance computing based on AMD EPYC, 7th generation. InstanceClass_HIGH_PERFORMANCE_COMPUTING7_AMD InstanceClass = "HIGH_PERFORMANCE_COMPUTING7_AMD" // High performance computing based on AMD EPYC, 7th generation. InstanceClass_HPC7A InstanceClass = "HPC7A" // High performance computing based on Graviton, 7th generation. InstanceClass_HIGH_PERFORMANCE_COMPUTING7_GRAVITON InstanceClass = "HIGH_PERFORMANCE_COMPUTING7_GRAVITON" // High performance computing based on Graviton, 7th generation. InstanceClass_HPC7G InstanceClass = "HPC7G" // Deep learning instances powered by Gaudi accelerators from Habana Labs (an Intel company), 1st generation. InstanceClass_DEEP_LEARNING1 InstanceClass = "DEEP_LEARNING1" // Deep learning instances powered by Gaudi accelerators from Habana Labs (an Intel company), 1st generation. InstanceClass_DL1 InstanceClass = "DL1" // Deep learning instances powered by Qualcomm AI 100 Standard accelerators, 2nd generation. InstanceClass_DEEP_LEARNING2_QUALCOMM InstanceClass = "DEEP_LEARNING2_QUALCOMM" // Deep learning instances powered by Qualcomm AI 100 Standard accelerators, 2nd generation. InstanceClass_DL2Q InstanceClass = "DL2Q" )
type InstanceInitiatedShutdownBehavior ¶
type InstanceInitiatedShutdownBehavior string
Provides the options for specifying the instance initiated shutdown behavior.
Example:
var vpc vpc
ec2.NewInstance(this, jsii.String("Instance"), &InstanceProps{
Vpc: Vpc,
InstanceType: ec2.InstanceType_Of(ec2.InstanceClass_T3, ec2.InstanceSize_NANO),
MachineImage: ec2.NewAmazonLinuxImage(&AmazonLinuxImageProps{
Generation: ec2.AmazonLinuxGeneration_AMAZON_LINUX_2,
}),
InstanceInitiatedShutdownBehavior: ec2.InstanceInitiatedShutdownBehavior_TERMINATE,
})
const ( // The instance will stop when it initiates a shutdown. InstanceInitiatedShutdownBehavior_STOP InstanceInitiatedShutdownBehavior = "STOP" // The instance will be terminated when it initiates a shutdown. InstanceInitiatedShutdownBehavior_TERMINATE InstanceInitiatedShutdownBehavior = "TERMINATE" )
type InstanceProps ¶
type InstanceProps struct {
// Type of instance to launch.
InstanceType InstanceType `field:"required" json:"instanceType" yaml:"instanceType"`
// AMI to launch.
MachineImage IMachineImage `field:"required" json:"machineImage" yaml:"machineImage"`
// VPC to launch the instance in.
Vpc IVpc `field:"required" json:"vpc" yaml:"vpc"`
// Whether the instance could initiate IPv6 connections to anywhere by default.
//
// This property is only used when you do not provide a security group.
// Default: false.
//
AllowAllIpv6Outbound *bool `field:"optional" json:"allowAllIpv6Outbound" yaml:"allowAllIpv6Outbound"`
// Whether the instance could initiate connections to anywhere by default.
//
// This property is only used when you do not provide a security group.
// Default: true.
//
AllowAllOutbound *bool `field:"optional" json:"allowAllOutbound" yaml:"allowAllOutbound"`
// Whether to associate a public IP address to the primary network interface attached to this instance.
//
// You cannot specify this property and `ipv6AddressCount` at the same time.
// Default: - public IP address is automatically assigned based on default behavior.
//
AssociatePublicIpAddress *bool `field:"optional" json:"associatePublicIpAddress" yaml:"associatePublicIpAddress"`
// In which AZ to place the instance within the VPC.
// Default: - Random zone.
//
AvailabilityZone *string `field:"optional" json:"availabilityZone" yaml:"availabilityZone"`
// Specifies how block devices are exposed to the instance. You can specify virtual devices and EBS volumes.
//
// Each instance that is launched has an associated root device volume,
// either an Amazon EBS volume or an instance store volume.
// You can use block device mappings to specify additional EBS volumes or
// instance store volumes to attach to an instance when it is launched.
// See: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html
//
// Default: - Uses the block device mapping of the AMI.
//
BlockDevices *[]*BlockDevice `field:"optional" json:"blockDevices" yaml:"blockDevices"`
// Specifying the CPU credit type for burstable EC2 instance types (T2, T3, T3a, etc).
//
// The unlimited CPU credit option is not supported for T3 instances with a dedicated host.
// Default: - T2 instances are standard, while T3, T4g, and T3a instances are unlimited.
//
CreditSpecification CpuCredits `field:"optional" json:"creditSpecification" yaml:"creditSpecification"`
// Whether "Detailed Monitoring" is enabled for this instance Keep in mind that Detailed Monitoring results in extra charges.
// See: http://aws.amazon.com/cloudwatch/pricing/
//
// Default: - false.
//
DetailedMonitoring *bool `field:"optional" json:"detailedMonitoring" yaml:"detailedMonitoring"`
// Indicates whether the instance is optimized for Amazon EBS I/O.
//
// This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance.
// This optimization isn't available with all instance types.
// Additional usage charges apply when using an EBS-optimized instance.
// Default: false.
//
EbsOptimized *bool `field:"optional" json:"ebsOptimized" yaml:"ebsOptimized"`
// Whether the instance is enabled for AWS Nitro Enclaves.
//
// Nitro Enclaves requires a Nitro-based virtualized parent instance with specific Intel/AMD with at least 4 vCPUs
// or Graviton with at least 2 vCPUs instance types and Linux/Windows host OS,
// while the enclave itself supports only Linux OS.
//
// You can't set both `enclaveEnabled` and `hibernationEnabled` to true on the same instance.
// See: https://docs.aws.amazon.com/enclaves/latest/user/nitro-enclave.html#nitro-enclave-reqs
//
// Default: - false.
//
EnclaveEnabled *bool `field:"optional" json:"enclaveEnabled" yaml:"enclaveEnabled"`
// Whether the instance is enabled for hibernation.
//
// You can't set both `enclaveEnabled` and `hibernationEnabled` to true on the same instance.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-hibernationoptions.html
//
// Default: - false.
//
HibernationEnabled *bool `field:"optional" json:"hibernationEnabled" yaml:"hibernationEnabled"`
// Apply the given CloudFormation Init configuration to the instance at startup.
// Default: - no CloudFormation init.
//
Init CloudFormationInit `field:"optional" json:"init" yaml:"init"`
// Use the given options for applying CloudFormation Init.
//
// Describes the configsets to use and the timeout to wait.
// Default: - default options.
//
InitOptions *ApplyCloudFormationInitOptions `field:"optional" json:"initOptions" yaml:"initOptions"`
// Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
// See: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/terminating-instances.html#Using_ChangingInstanceInitiatedShutdownBehavior
//
// Default: InstanceInitiatedShutdownBehavior.STOP
//
InstanceInitiatedShutdownBehavior InstanceInitiatedShutdownBehavior `field:"optional" json:"instanceInitiatedShutdownBehavior" yaml:"instanceInitiatedShutdownBehavior"`
// The name of the instance.
// Default: - CDK generated name.
//
InstanceName *string `field:"optional" json:"instanceName" yaml:"instanceName"`
// The number of IPv6 addresses to associate with the primary network interface.
//
// Amazon EC2 chooses the IPv6 addresses from the range of your subnet.
//
// You cannot specify this property and `associatePublicIpAddress` at the same time.
// Default: - For instances associated with an IPv6 subnet, use 1; otherwise, use 0.
//
Ipv6AddressCount *float64 `field:"optional" json:"ipv6AddressCount" yaml:"ipv6AddressCount"`
// Name of SSH keypair to grant access to instance.
// Default: - No SSH access will be possible.
//
// Deprecated: - Use `keyPair` instead - https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2-readme.html#using-an-existing-ec2-key-pair
KeyName *string `field:"optional" json:"keyName" yaml:"keyName"`
// The SSH keypair to grant access to the instance.
// Default: - No SSH access will be possible.
//
KeyPair IKeyPair `field:"optional" json:"keyPair" yaml:"keyPair"`
// The placement group that you want to launch the instance into.
// Default: - no placement group will be used for this instance.
//
PlacementGroup IPlacementGroup `field:"optional" json:"placementGroup" yaml:"placementGroup"`
// Defines a private IP address to associate with an instance.
//
// Private IP should be available within the VPC that the instance is build within.
// Default: - no association.
//
PrivateIpAddress *string `field:"optional" json:"privateIpAddress" yaml:"privateIpAddress"`
// Propagate the EC2 instance tags to the EBS volumes.
// Default: - false.
//
PropagateTagsToVolumeOnCreation *bool `field:"optional" json:"propagateTagsToVolumeOnCreation" yaml:"propagateTagsToVolumeOnCreation"`
// Whether IMDSv2 should be required on this instance.
// Default: - false.
//
RequireImdsv2 *bool `field:"optional" json:"requireImdsv2" yaml:"requireImdsv2"`
// The length of time to wait for the resourceSignalCount.
//
// The maximum value is 43200 (12 hours).
// Default: Duration.minutes(5)
//
ResourceSignalTimeout awscdk.Duration `field:"optional" json:"resourceSignalTimeout" yaml:"resourceSignalTimeout"`
// An IAM role to associate with the instance profile assigned to this Auto Scaling Group.
//
// The role must be assumable by the service principal `ec2.amazonaws.com`:
//
// Example:
// role := iam.NewRole(this, jsii.String("MyRole"), &RoleProps{
// AssumedBy: iam.NewServicePrincipal(jsii.String("ec2.amazonaws.com")),
// })
//
// Default: - A role will automatically be created, it can be accessed via the `role` property.
//
Role awsiam.IRole `field:"optional" json:"role" yaml:"role"`
// Security Group to assign to this instance.
// Default: - create new security group.
//
SecurityGroup ISecurityGroup `field:"optional" json:"securityGroup" yaml:"securityGroup"`
// Specifies whether to enable an instance launched in a VPC to perform NAT.
//
// This controls whether source/destination checking is enabled on the instance.
// A value of true means that checking is enabled, and false means that checking is disabled.
// The value must be false for the instance to perform NAT.
// Default: true.
//
SourceDestCheck *bool `field:"optional" json:"sourceDestCheck" yaml:"sourceDestCheck"`
// Add SSM session permissions to the instance role.
//
// Setting this to `true` adds the necessary permissions to connect
// to the instance using SSM Session Manager. You can do this
// from the AWS Console.
//
// NOTE: Setting this flag to `true` may not be enough by itself.
// You must also use an AMI that comes with the SSM Agent, or install
// the SSM Agent yourself. See
// [Working with SSM Agent](https://docs.aws.amazon.com/systems-manager/latest/userguide/ssm-agent.html)
// in the SSM Developer Guide.
// Default: false.
//
SsmSessionPermissions *bool `field:"optional" json:"ssmSessionPermissions" yaml:"ssmSessionPermissions"`
// Specific UserData to use.
//
// The UserData may still be mutated after creation.
// Default: - A UserData object appropriate for the MachineImage's
// Operating System is created.
//
UserData UserData `field:"optional" json:"userData" yaml:"userData"`
// Changes to the UserData force replacement.
//
// Depending the EC2 instance type, changing UserData either
// restarts the instance or replaces the instance.
//
// - Instance store-backed instances are replaced.
// - EBS-backed instances are restarted.
//
// By default, restarting does not execute the new UserData so you
// will need a different mechanism to ensure the instance is restarted.
//
// Setting this to `true` will make the instance's Logical ID depend on the
// UserData, which will cause CloudFormation to replace it if the UserData
// changes.
// Default: - true if `initOptions` is specified, false otherwise.
//
UserDataCausesReplacement *bool `field:"optional" json:"userDataCausesReplacement" yaml:"userDataCausesReplacement"`
// Where to place the instance within the VPC.
// Default: - Private subnets.
//
VpcSubnets *SubnetSelection `field:"optional" json:"vpcSubnets" yaml:"vpcSubnets"`
}
Properties of an EC2 Instance.
Example:
var vpc iVpc
lb := elb.NewLoadBalancer(this, jsii.String("LB"), &LoadBalancerProps{
Vpc: Vpc,
InternetFacing: jsii.Boolean(true),
})
// instance to add as the target for load balancer.
instance := ec2.NewInstance(this, jsii.String("targetInstance"), &InstanceProps{
Vpc: vpc,
InstanceType: ec2.InstanceType_Of(ec2.InstanceClass_BURSTABLE2, ec2.InstanceSize_MICRO),
MachineImage: ec2.NewAmazonLinuxImage(&AmazonLinuxImageProps{
Generation: ec2.AmazonLinuxGeneration_AMAZON_LINUX_2,
}),
})
lb.AddTarget(elb.NewInstanceTarget(instance))
type InstanceRequireImdsv2Aspect ¶
type InstanceRequireImdsv2Aspect interface {
awscdk.IAspect
SuppressWarnings() *bool
// All aspects can visit an IConstruct.
Visit(node constructs.IConstruct)
// Adds a warning annotation to a node, unless `suppressWarnings` is true.
Warn(node constructs.IConstruct, message *string)
}
Aspect that applies IMDS configuration on EC2 Instance constructs.
This aspect configures IMDS on an EC2 instance by creating a Launch Template with the IMDS configuration and associating that Launch Template with the instance. If an Instance is already associated with a Launch Template, a warning will (optionally) be added to the construct node and it will be skipped.
To cover Instances already associated with Launch Templates, use `LaunchTemplateImdsAspect`.
Example:
aspect := ec2.NewInstanceRequireImdsv2Aspect() awscdk.Aspects_Of(this).Add(aspect)
func NewInstanceRequireImdsv2Aspect ¶
func NewInstanceRequireImdsv2Aspect(props *InstanceRequireImdsv2AspectProps) InstanceRequireImdsv2Aspect
type InstanceRequireImdsv2AspectProps ¶
type InstanceRequireImdsv2AspectProps struct {
// Whether warnings that would be raised when an Instance is associated with an existing Launch Template should be suppressed or not.
//
// You can set this to `true` if `LaunchTemplateImdsAspect` is being used alongside this Aspect to
// suppress false-positive warnings because any Launch Templates associated with Instances will still be covered.
// Default: - false.
//
SuppressLaunchTemplateWarning *bool `field:"optional" json:"suppressLaunchTemplateWarning" yaml:"suppressLaunchTemplateWarning"`
// Whether warning annotations from this Aspect should be suppressed or not.
// Default: - false.
//
SuppressWarnings *bool `field:"optional" json:"suppressWarnings" yaml:"suppressWarnings"`
}
Properties for `InstanceRequireImdsv2Aspect`.
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"
instanceRequireImdsv2AspectProps := &InstanceRequireImdsv2AspectProps{
SuppressLaunchTemplateWarning: jsii.Boolean(false),
SuppressWarnings: jsii.Boolean(false),
}
type InstanceSize ¶
type InstanceSize string
What size of instance to use.
Example:
var vpc vpc
cluster := rds.NewDatabaseCluster(this, jsii.String("Database"), &DatabaseClusterProps{
Engine: rds.DatabaseClusterEngine_AuroraMysql(&AuroraMysqlClusterEngineProps{
Version: rds.AuroraMysqlEngineVersion_VER_3_01_0(),
}),
Writer: rds.ClusterInstance_Provisioned(jsii.String("Instance"), &ProvisionedClusterInstanceProps{
InstanceType: ec2.InstanceType_Of(ec2.InstanceClass_BURSTABLE3, ec2.InstanceSize_SMALL),
}),
Readers: []iClusterInstance{
rds.ClusterInstance_*Provisioned(jsii.String("reader")),
},
InstanceUpdateBehaviour: rds.InstanceUpdateBehaviour_ROLLING,
// Optional - defaults to rds.InstanceUpdateBehaviour.BULK
Vpc: Vpc,
})
const ( // Instance size NANO (nano). InstanceSize_NANO InstanceSize = "NANO" // Instance size MICRO (micro). InstanceSize_MICRO InstanceSize = "MICRO" // Instance size SMALL (small). InstanceSize_SMALL InstanceSize = "SMALL" // Instance size MEDIUM (medium). InstanceSize_MEDIUM InstanceSize = "MEDIUM" // Instance size LARGE (large). InstanceSize_LARGE InstanceSize = "LARGE" // Instance size XLARGE (xlarge). InstanceSize_XLARGE InstanceSize = "XLARGE" // Instance size XLARGE2 (2xlarge). InstanceSize_XLARGE2 InstanceSize = "XLARGE2" // Instance size XLARGE3 (3xlarge). InstanceSize_XLARGE3 InstanceSize = "XLARGE3" // Instance size XLARGE4 (4xlarge). InstanceSize_XLARGE4 InstanceSize = "XLARGE4" // Instance size XLARGE6 (6xlarge). InstanceSize_XLARGE6 InstanceSize = "XLARGE6" // Instance size XLARGE8 (8xlarge). InstanceSize_XLARGE8 InstanceSize = "XLARGE8" // Instance size XLARGE9 (9xlarge). InstanceSize_XLARGE9 InstanceSize = "XLARGE9" // Instance size XLARGE10 (10xlarge). InstanceSize_XLARGE10 InstanceSize = "XLARGE10" // Instance size XLARGE12 (12xlarge). InstanceSize_XLARGE12 InstanceSize = "XLARGE12" // Instance size XLARGE16 (16xlarge). InstanceSize_XLARGE16 InstanceSize = "XLARGE16" // Instance size XLARGE18 (18xlarge). InstanceSize_XLARGE18 InstanceSize = "XLARGE18" // Instance size XLARGE24 (24xlarge). InstanceSize_XLARGE24 InstanceSize = "XLARGE24" // Instance size XLARGE32 (32xlarge). InstanceSize_XLARGE32 InstanceSize = "XLARGE32" // Instance size XLARGE48 (48xlarge). InstanceSize_XLARGE48 InstanceSize = "XLARGE48" // Instance size XLARGE56 (56xlarge). InstanceSize_XLARGE56 InstanceSize = "XLARGE56" // Instance size XLARGE96 (96xlarge). InstanceSize_XLARGE96 InstanceSize = "XLARGE96" // Instance size XLARGE112 (112xlarge). InstanceSize_XLARGE112 InstanceSize = "XLARGE112" // Instance size METAL (metal). InstanceSize_METAL InstanceSize = "METAL" // Instance size XLARGE16METAL (metal-16xl). InstanceSize_XLARGE16METAL InstanceSize = "XLARGE16METAL" // Instance size XLARGE24METAL (metal-24xl). InstanceSize_XLARGE24METAL InstanceSize = "XLARGE24METAL" // Instance size XLARGE32METAL (metal-32xl). InstanceSize_XLARGE32METAL InstanceSize = "XLARGE32METAL" // Instance size XLARGE48METAL (metal-48xl). InstanceSize_XLARGE48METAL InstanceSize = "XLARGE48METAL" )
type InstanceType ¶
type InstanceType interface {
// The instance's CPU architecture.
Architecture() InstanceArchitecture
// Return whether this instance type is a burstable instance type.
IsBurstable() *bool
SameInstanceClassAs(other InstanceType) *bool
// Return the instance type as a dotted string.
ToString() *string
}
Instance type for EC2 instances.
This class takes a literal string, good if you already know the identifier of the type you want.
Example:
var vpc vpc
cluster := docdb.NewDatabaseCluster(this, jsii.String("Database"), &DatabaseClusterProps{
MasterUser: &Login{
Username: jsii.String("myuser"),
},
InstanceType: ec2.InstanceType_Of(ec2.InstanceClass_MEMORY5, ec2.InstanceSize_LARGE),
VpcSubnets: &SubnetSelection{
SubnetType: ec2.SubnetType_PUBLIC,
},
Vpc: Vpc,
CaCertificate: docdb.CaCertificate_RDS_CA_RSA4096_G1(),
})
func InstanceType_Of ¶
func InstanceType_Of(instanceClass InstanceClass, instanceSize InstanceSize) InstanceType
Instance type for EC2 instances.
This class takes a combination of a class and size.
Be aware that not all combinations of class and size are available, and not all classes are available in all regions.
func NewInstanceType ¶
func NewInstanceType(instanceTypeIdentifier *string) InstanceType
type InterfaceVpcEndpoint ¶
type InterfaceVpcEndpoint interface {
VpcEndpoint
IInterfaceVpcEndpoint
// Access to network connections.
Connections() Connections
// The environment this resource belongs to.
//
// For resources that are created and managed by the CDK
// (generally, those created by creating new class instances like Role, Bucket, etc.),
// this is always the same as the environment of the stack they belong to;
// however, for imported resources
// (those obtained from static methods like fromRoleArn, fromBucketName, etc.),
// that might be different than the stack they were imported into.
Env() *awscdk.ResourceEnvironment
// The tree node.
Node() constructs.Node
// Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
//
// This value will resolve to one of the following:
// - a concrete value (e.g. `"my-awesome-bucket"`)
// - `undefined`, when a name should be generated by CloudFormation
// - a concrete name generated automatically during synthesis, in
// cross-environment scenarios.
PhysicalName() *string
PolicyDocument() awsiam.PolicyDocument
SetPolicyDocument(val awsiam.PolicyDocument)
// The stack in which this resource is defined.
Stack() awscdk.Stack
// The date and time the interface VPC endpoint was created.
VpcEndpointCreationTimestamp() *string
// The DNS entries for the interface VPC endpoint.
//
// Each entry is a combination of the hosted zone ID and the DNS name.
// The entries are ordered as follows: regional public DNS, zonal public DNS, private DNS, and wildcard DNS.
// This order is not enforced for AWS Marketplace services.
//
// The following is an example. In the first entry, the hosted zone ID is Z1HUB23UULQXV
// and the DNS name is vpce-01abc23456de78f9g-12abccd3.ec2.us-east-1.vpce.amazonaws.com.
//
// ["Z1HUB23UULQXV:vpce-01abc23456de78f9g-12abccd3.ec2.us-east-1.vpce.amazonaws.com",
// "Z1HUB23UULQXV:vpce-01abc23456de78f9g-12abccd3-us-east-1a.ec2.us-east-1.vpce.amazonaws.com",
// "Z1C12344VYDITB0:ec2.us-east-1.amazonaws.com"]
//
// If you update the PrivateDnsEnabled or SubnetIds properties, the DNS entries in the list will change.
VpcEndpointDnsEntries() *[]*string
// The interface VPC endpoint identifier.
VpcEndpointId() *string
// One or more network interfaces for the interface VPC endpoint.
VpcEndpointNetworkInterfaceIds() *[]*string
// Adds a statement to the policy document of the VPC endpoint. The statement must have a Principal.
//
// Not all interface VPC endpoints support policy. For more information
// see https://docs.aws.amazon.com/vpc/latest/userguide/vpce-interface.html
AddToPolicy(statement awsiam.PolicyStatement)
// Apply the given removal policy to this resource.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
GeneratePhysicalName() *string
// Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`).
//
// Normally, this token will resolve to `arnAttr`, but if the resource is
// referenced across environments, `arnComponents` will be used to synthesize
// a concrete ARN with the resource's physical name. Make sure to reference
// `this.physicalName` in `arnComponents`.
GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
// Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`).
//
// Normally, this token will resolve to `nameAttr`, but if the resource is
// referenced across environments, it will be resolved to `this.physicalName`,
// which will be a concrete name.
GetResourceNameAttribute(nameAttr *string) *string
// Returns a string representation of this construct.
ToString() *string
}
A interface VPC endpoint.
Example:
var vpc vpc
ec2.NewInterfaceVpcEndpoint(this, jsii.String("VPC Endpoint"), &InterfaceVpcEndpointProps{
Vpc: Vpc,
Service: ec2.NewInterfaceVpcEndpointService(jsii.String("com.amazonaws.vpce.us-east-1.vpce-svc-uuddlrlrbastrtsvc"), jsii.Number(443)),
// Choose which availability zones to place the VPC endpoint in, based on
// available AZs
Subnets: &SubnetSelection{
AvailabilityZones: []*string{
jsii.String("us-east-1a"),
jsii.String("us-east-1c"),
},
},
})
func NewInterfaceVpcEndpoint ¶
func NewInterfaceVpcEndpoint(scope constructs.Construct, id *string, props *InterfaceVpcEndpointProps) InterfaceVpcEndpoint
type InterfaceVpcEndpointAttributes ¶
type InterfaceVpcEndpointAttributes struct {
// The port of the service of the interface VPC endpoint.
Port *float64 `field:"required" json:"port" yaml:"port"`
// The interface VPC endpoint identifier.
VpcEndpointId *string `field:"required" json:"vpcEndpointId" yaml:"vpcEndpointId"`
// The security groups associated with the interface VPC endpoint.
//
// If you wish to manage the network connections associated with this endpoint,
// you will need to specify its security groups.
SecurityGroups *[]ISecurityGroup `field:"optional" json:"securityGroups" yaml:"securityGroups"`
}
Construction properties for an ImportedInterfaceVpcEndpoint.
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"
var securityGroup securityGroup
interfaceVpcEndpointAttributes := &InterfaceVpcEndpointAttributes{
Port: jsii.Number(123),
VpcEndpointId: jsii.String("vpcEndpointId"),
// the properties below are optional
SecurityGroups: []iSecurityGroup{
securityGroup,
},
}
type InterfaceVpcEndpointAwsService ¶
type InterfaceVpcEndpointAwsService interface {
IInterfaceVpcEndpointService
// The name of the service.
//
// e.g. com.amazonaws.us-east-1.ecs
Name() *string
// The port of the service.
Port() *float64
// Whether Private DNS is supported by default.
PrivateDnsDefault() *bool
// The short name of the service.
//
// e.g. ecs
ShortName() *string
}
An AWS service for an interface VPC endpoint.
Example:
// Add gateway endpoints when creating the VPC
vpc := ec2.NewVpc(this, jsii.String("MyVpc"), &VpcProps{
GatewayEndpoints: map[string]gatewayVpcEndpointOptions{
"S3": &gatewayVpcEndpointOptions{
"service": ec2.GatewayVpcEndpointAwsService_S3(),
},
},
})
// Alternatively gateway endpoints can be added on the VPC
dynamoDbEndpoint := vpc.addGatewayEndpoint(jsii.String("DynamoDbEndpoint"), &gatewayVpcEndpointOptions{
Service: ec2.GatewayVpcEndpointAwsService_DYNAMODB(),
})
// This allows to customize the endpoint policy
dynamoDbEndpoint.AddToPolicy(
iam.NewPolicyStatement(&PolicyStatementProps{
// Restrict to listing and describing tables
Principals: []iPrincipal{
iam.NewAnyPrincipal(),
},
Actions: []*string{
jsii.String("dynamodb:DescribeTable"),
jsii.String("dynamodb:ListTables"),
},
Resources: []*string{
jsii.String("*"),
},
}))
// Add an interface endpoint
vpc.addInterfaceEndpoint(jsii.String("EcrDockerEndpoint"), &InterfaceVpcEndpointOptions{
Service: ec2.InterfaceVpcEndpointAwsService_ECR_DOCKER(),
})
func InterfaceVpcEndpointAwsService_ACCESS_ANALYZER ¶ added in v2.47.0
func InterfaceVpcEndpointAwsService_ACCESS_ANALYZER() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_ACCOUNT_MANAGEMENT ¶ added in v2.47.0
func InterfaceVpcEndpointAwsService_ACCOUNT_MANAGEMENT() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_AIRFLOW_API ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_AIRFLOW_API() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_AIRFLOW_API_FIPS ¶ added in v2.157.0
func InterfaceVpcEndpointAwsService_AIRFLOW_API_FIPS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_AIRFLOW_ENV ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_AIRFLOW_ENV() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_AIRFLOW_ENV_FIPS ¶ added in v2.157.0
func InterfaceVpcEndpointAwsService_AIRFLOW_ENV_FIPS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_AIRFLOW_OPS ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_AIRFLOW_OPS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_APIGATEWAY ¶
func InterfaceVpcEndpointAwsService_APIGATEWAY() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_APPCONFIG ¶ added in v2.133.0
func InterfaceVpcEndpointAwsService_APPCONFIG() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_APPCONFIGDATA ¶ added in v2.133.0
func InterfaceVpcEndpointAwsService_APPCONFIGDATA() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_APPLICATION_AUTOSCALING ¶ added in v2.35.0
func InterfaceVpcEndpointAwsService_APPLICATION_AUTOSCALING() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_APPLICATION_MIGRATION_SERVICE ¶ added in v2.47.0
func InterfaceVpcEndpointAwsService_APPLICATION_MIGRATION_SERVICE() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_APPSTREAM_API ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_APPSTREAM_API() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_APPSTREAM_STREAMING ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_APPSTREAM_STREAMING() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_APP_MESH ¶ added in v2.47.0
func InterfaceVpcEndpointAwsService_APP_MESH() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_APP_MESH_ENVOY_MANAGEMENT ¶ added in v2.134.0
func InterfaceVpcEndpointAwsService_APP_MESH_ENVOY_MANAGEMENT() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_APP_MESH_OPS ¶ added in v2.134.0
func InterfaceVpcEndpointAwsService_APP_MESH_OPS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_APP_RUNNER ¶ added in v2.47.0
func InterfaceVpcEndpointAwsService_APP_RUNNER() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_APP_RUNNER_REQUESTS ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_APP_RUNNER_REQUESTS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_APP_SYNC ¶ added in v2.81.0
func InterfaceVpcEndpointAwsService_APP_SYNC() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_ATHENA ¶
func InterfaceVpcEndpointAwsService_ATHENA() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_AUDIT_MANAGER ¶ added in v2.47.0
func InterfaceVpcEndpointAwsService_AUDIT_MANAGER() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_AUTOSCALING ¶ added in v2.35.0
func InterfaceVpcEndpointAwsService_AUTOSCALING() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_AUTOSCALING_PLANS ¶ added in v2.35.0
func InterfaceVpcEndpointAwsService_AUTOSCALING_PLANS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_B2B_DATA_INTERCHANGE ¶ added in v2.134.0
func InterfaceVpcEndpointAwsService_B2B_DATA_INTERCHANGE() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_BACKUP ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_BACKUP() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_BACKUP_GATEWAY ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_BACKUP_GATEWAY() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_BATCH ¶ added in v2.35.0
func InterfaceVpcEndpointAwsService_BATCH() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_BEDROCK ¶ added in v2.134.0
func InterfaceVpcEndpointAwsService_BEDROCK() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_BEDROCK_AGENT ¶ added in v2.134.0
func InterfaceVpcEndpointAwsService_BEDROCK_AGENT() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_BEDROCK_AGENT_RUNTIME ¶ added in v2.134.0
func InterfaceVpcEndpointAwsService_BEDROCK_AGENT_RUNTIME() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_BEDROCK_RUNTIME ¶ added in v2.134.0
func InterfaceVpcEndpointAwsService_BEDROCK_RUNTIME() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_BILLING_AND_COST_MANAGEMENT_FREETIER ¶ added in v2.154.0
func InterfaceVpcEndpointAwsService_BILLING_AND_COST_MANAGEMENT_FREETIER() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_BILLING_AND_COST_MANAGEMENT_TAX ¶ added in v2.154.0
func InterfaceVpcEndpointAwsService_BILLING_AND_COST_MANAGEMENT_TAX() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_BILLING_CONDUCTOR ¶ added in v2.47.0
func InterfaceVpcEndpointAwsService_BILLING_CONDUCTOR() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_BRAKET ¶ added in v2.47.0
func InterfaceVpcEndpointAwsService_BRAKET() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_CLEAN_ROOMS ¶ added in v2.134.0
func InterfaceVpcEndpointAwsService_CLEAN_ROOMS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_CLEAN_ROOMS_ML ¶ added in v2.154.0
func InterfaceVpcEndpointAwsService_CLEAN_ROOMS_ML() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_CLOUDFORMATION ¶
func InterfaceVpcEndpointAwsService_CLOUDFORMATION() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_CLOUDHSM ¶ added in v2.47.0
func InterfaceVpcEndpointAwsService_CLOUDHSM() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_CLOUDTRAIL ¶
func InterfaceVpcEndpointAwsService_CLOUDTRAIL() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_CLOUDWATCH ¶
func InterfaceVpcEndpointAwsService_CLOUDWATCH() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_CLOUDWATCH_APPLICATION_INSIGHTS ¶ added in v2.157.0
func InterfaceVpcEndpointAwsService_CLOUDWATCH_APPLICATION_INSIGHTS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_CLOUDWATCH_APPLICATION_SIGNALS ¶ added in v2.154.0
func InterfaceVpcEndpointAwsService_CLOUDWATCH_APPLICATION_SIGNALS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_CLOUDWATCH_EVENTS ¶
func InterfaceVpcEndpointAwsService_CLOUDWATCH_EVENTS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_CLOUDWATCH_EVIDENTLY ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_CLOUDWATCH_EVIDENTLY() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_CLOUDWATCH_EVIDENTLY_DATAPLANE ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_CLOUDWATCH_EVIDENTLY_DATAPLANE() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_CLOUDWATCH_LOGS ¶
func InterfaceVpcEndpointAwsService_CLOUDWATCH_LOGS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_CLOUDWATCH_MONITORING ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_CLOUDWATCH_MONITORING() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_CLOUDWATCH_NETWORK_MONITOR ¶ added in v2.134.0
func InterfaceVpcEndpointAwsService_CLOUDWATCH_NETWORK_MONITOR() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_CLOUDWATCH_RUM ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_CLOUDWATCH_RUM() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_CLOUDWATCH_RUM_DATAPLANE ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_CLOUDWATCH_RUM_DATAPLANE() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_CLOUDWATCH_SYNTHETICS ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_CLOUDWATCH_SYNTHETICS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_CLOUD_CONTROL_API ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_CLOUD_CONTROL_API() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_CLOUD_CONTROL_API_FIPS ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_CLOUD_CONTROL_API_FIPS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_CLOUD_DIRECTORY ¶ added in v2.47.0
func InterfaceVpcEndpointAwsService_CLOUD_DIRECTORY() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_CLOUD_MAP_DATA_SERVICE_DISCOVERY ¶ added in v2.134.0
func InterfaceVpcEndpointAwsService_CLOUD_MAP_DATA_SERVICE_DISCOVERY() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_CLOUD_MAP_DATA_SERVICE_DISCOVERY_FIPS ¶ added in v2.134.0
func InterfaceVpcEndpointAwsService_CLOUD_MAP_DATA_SERVICE_DISCOVERY_FIPS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_CLOUD_MAP_SERVICE_DISCOVERY ¶ added in v2.134.0
func InterfaceVpcEndpointAwsService_CLOUD_MAP_SERVICE_DISCOVERY() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_CLOUD_MAP_SERVICE_DISCOVERY_FIPS ¶ added in v2.134.0
func InterfaceVpcEndpointAwsService_CLOUD_MAP_SERVICE_DISCOVERY_FIPS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_CODEARTIFACT_API ¶ added in v2.35.0
func InterfaceVpcEndpointAwsService_CODEARTIFACT_API() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_CODEARTIFACT_REPOSITORIES ¶ added in v2.35.0
func InterfaceVpcEndpointAwsService_CODEARTIFACT_REPOSITORIES() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_CODEBUILD ¶
func InterfaceVpcEndpointAwsService_CODEBUILD() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_CODEBUILD_FIPS ¶
func InterfaceVpcEndpointAwsService_CODEBUILD_FIPS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_CODECATALYST ¶ added in v2.135.0
func InterfaceVpcEndpointAwsService_CODECATALYST() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_CODECATALYST_GIT ¶ added in v2.134.0
func InterfaceVpcEndpointAwsService_CODECATALYST_GIT() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_CODECATALYST_PACKAGES ¶ added in v2.134.0
func InterfaceVpcEndpointAwsService_CODECATALYST_PACKAGES() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_CODECOMMIT ¶
func InterfaceVpcEndpointAwsService_CODECOMMIT() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_CODECOMMIT_FIPS ¶
func InterfaceVpcEndpointAwsService_CODECOMMIT_FIPS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_CODECOMMIT_GIT ¶
func InterfaceVpcEndpointAwsService_CODECOMMIT_GIT() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_CODECOMMIT_GIT_FIPS ¶
func InterfaceVpcEndpointAwsService_CODECOMMIT_GIT_FIPS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_CODEDEPLOY ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_CODEDEPLOY() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_CODEDEPLOY_COMMANDS_SECURE ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_CODEDEPLOY_COMMANDS_SECURE() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_CODEGURU_PROFILER ¶
func InterfaceVpcEndpointAwsService_CODEGURU_PROFILER() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_CODEGURU_REVIEWER ¶
func InterfaceVpcEndpointAwsService_CODEGURU_REVIEWER() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_CODEPIPELINE ¶
func InterfaceVpcEndpointAwsService_CODEPIPELINE() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_CODESTAR_CONNECTIONS ¶ added in v2.47.0
func InterfaceVpcEndpointAwsService_CODESTAR_CONNECTIONS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_CODEWHISPERER ¶ added in v2.134.0
func InterfaceVpcEndpointAwsService_CODEWHISPERER() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_CODE_CONNECTIONS ¶ added in v2.154.0
func InterfaceVpcEndpointAwsService_CODE_CONNECTIONS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_COMPREHEND ¶ added in v2.47.0
func InterfaceVpcEndpointAwsService_COMPREHEND() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_COMPREHEND_MEDICAL ¶ added in v2.47.0
func InterfaceVpcEndpointAwsService_COMPREHEND_MEDICAL() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_CONFIG ¶
func InterfaceVpcEndpointAwsService_CONFIG() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_CONNECT_APP_INTEGRATIONS ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_CONNECT_APP_INTEGRATIONS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_CONNECT_CASES ¶ added in v2.72.0
func InterfaceVpcEndpointAwsService_CONNECT_CASES() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_CONNECT_CONNECT_CAMPAIGNS ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_CONNECT_CONNECT_CAMPAIGNS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_CONNECT_PROFILE ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_CONNECT_PROFILE() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_CONNECT_VOICEID ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_CONNECT_VOICEID() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_CONNECT_WISDOM ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_CONNECT_WISDOM() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_CONTROL_CATALOG ¶ added in v2.154.0
func InterfaceVpcEndpointAwsService_CONTROL_CATALOG() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_COST_EXPLORER ¶ added in v2.154.0
func InterfaceVpcEndpointAwsService_COST_EXPLORER() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_DATABASE_MIGRATION_SERVICE ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_DATABASE_MIGRATION_SERVICE() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_DATABASE_MIGRATION_SERVICE_FIPS ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_DATABASE_MIGRATION_SERVICE_FIPS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_DATASYNC ¶ added in v2.47.0
func InterfaceVpcEndpointAwsService_DATASYNC() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_DATAZONE ¶ added in v2.134.0
func InterfaceVpcEndpointAwsService_DATAZONE() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_DATA_EXCHANGE ¶ added in v2.47.0
func InterfaceVpcEndpointAwsService_DATA_EXCHANGE() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_DATA_EXPORTS ¶ added in v2.154.0
func InterfaceVpcEndpointAwsService_DATA_EXPORTS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_DEADLINE_CLOUD_MANAGEMENT ¶ added in v2.154.0
func InterfaceVpcEndpointAwsService_DEADLINE_CLOUD_MANAGEMENT() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_DEADLINE_CLOUD_SCHEDULING ¶ added in v2.154.0
func InterfaceVpcEndpointAwsService_DEADLINE_CLOUD_SCHEDULING() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_DEVOPS_GURU ¶ added in v2.47.0
func InterfaceVpcEndpointAwsService_DEVOPS_GURU() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_DIRECTORY_SERVICE ¶ added in v2.134.0
func InterfaceVpcEndpointAwsService_DIRECTORY_SERVICE() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_EBS_DIRECT ¶ added in v2.47.0
func InterfaceVpcEndpointAwsService_EBS_DIRECT() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_EC2 ¶
func InterfaceVpcEndpointAwsService_EC2() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_EC2_MESSAGES ¶
func InterfaceVpcEndpointAwsService_EC2_MESSAGES() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_ECR ¶
func InterfaceVpcEndpointAwsService_ECR() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_ECR_DOCKER ¶
func InterfaceVpcEndpointAwsService_ECR_DOCKER() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_ECS ¶
func InterfaceVpcEndpointAwsService_ECS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_ECS_AGENT ¶
func InterfaceVpcEndpointAwsService_ECS_AGENT() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_ECS_TELEMETRY ¶
func InterfaceVpcEndpointAwsService_ECS_TELEMETRY() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_EKS ¶ added in v2.72.0
func InterfaceVpcEndpointAwsService_EKS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_EKS_AUTH ¶ added in v2.134.0
func InterfaceVpcEndpointAwsService_EKS_AUTH() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_ELASTICACHE ¶ added in v2.47.0
func InterfaceVpcEndpointAwsService_ELASTICACHE() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_ELASTICACHE_FIPS ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_ELASTICACHE_FIPS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_ELASTIC_BEANSTALK ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_ELASTIC_BEANSTALK() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_ELASTIC_BEANSTALK_HEALTH ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_ELASTIC_BEANSTALK_HEALTH() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_ELASTIC_DISASTER_RECOVERY ¶ added in v2.72.0
func InterfaceVpcEndpointAwsService_ELASTIC_DISASTER_RECOVERY() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_ELASTIC_FILESYSTEM ¶
func InterfaceVpcEndpointAwsService_ELASTIC_FILESYSTEM() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_ELASTIC_FILESYSTEM_FIPS ¶
func InterfaceVpcEndpointAwsService_ELASTIC_FILESYSTEM_FIPS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_ELASTIC_INFERENCE_RUNTIME ¶
func InterfaceVpcEndpointAwsService_ELASTIC_INFERENCE_RUNTIME() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_ELASTIC_LOAD_BALANCING ¶
func InterfaceVpcEndpointAwsService_ELASTIC_LOAD_BALANCING() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_ELEMENTAL_MEDIACONNECT ¶ added in v2.134.0
func InterfaceVpcEndpointAwsService_ELEMENTAL_MEDIACONNECT() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_EMAIL_SMTP ¶ added in v2.47.0
func InterfaceVpcEndpointAwsService_EMAIL_SMTP() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_EMR ¶ added in v2.47.0
func InterfaceVpcEndpointAwsService_EMR() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_EMR_EKS ¶ added in v2.47.0
func InterfaceVpcEndpointAwsService_EMR_EKS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_EMR_SERVERLESS ¶ added in v2.47.0
func InterfaceVpcEndpointAwsService_EMR_SERVERLESS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_EMR_SERVERLESS_LIVY ¶ added in v2.157.0
func InterfaceVpcEndpointAwsService_EMR_SERVERLESS_LIVY() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_EMR_WAL ¶ added in v2.134.0
func InterfaceVpcEndpointAwsService_EMR_WAL() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_ENTITY_RESOLUTION ¶ added in v2.134.0
func InterfaceVpcEndpointAwsService_ENTITY_RESOLUTION() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_EVENTBRIDGE ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_EVENTBRIDGE() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_EVENTBRIDGE_SCHEMA_REGISTRY ¶ added in v2.154.0
func InterfaceVpcEndpointAwsService_EVENTBRIDGE_SCHEMA_REGISTRY() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_FAULT_INJECTION_SIMULATOR ¶ added in v2.47.0
func InterfaceVpcEndpointAwsService_FAULT_INJECTION_SIMULATOR() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_FINSPACE ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_FINSPACE() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_FINSPACE_API ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_FINSPACE_API() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_FORECAST ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_FORECAST() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_FORECAST_FIPS ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_FORECAST_FIPS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_FORECAST_QUERY ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_FORECAST_QUERY() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_FORECAST_QUERY_FIPS ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_FORECAST_QUERY_FIPS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_FRAUD_DETECTOR ¶ added in v2.47.0
func InterfaceVpcEndpointAwsService_FRAUD_DETECTOR() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_FSX ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_FSX() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_FSX_FIPS ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_FSX_FIPS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_GLUE ¶
func InterfaceVpcEndpointAwsService_GLUE() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_GLUE_DATABREW ¶ added in v2.47.0
func InterfaceVpcEndpointAwsService_GLUE_DATABREW() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_GRAFANA ¶ added in v2.47.0
func InterfaceVpcEndpointAwsService_GRAFANA() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_GRAFANA_WORKSPACE ¶ added in v2.72.0
func InterfaceVpcEndpointAwsService_GRAFANA_WORKSPACE() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_GROUNDSTATION ¶ added in v2.47.0
func InterfaceVpcEndpointAwsService_GROUNDSTATION() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_GUARDDUTY_DATA ¶ added in v2.134.0
func InterfaceVpcEndpointAwsService_GUARDDUTY_DATA() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_GUARDDUTY_DATA_FIPS ¶ added in v2.134.0
func InterfaceVpcEndpointAwsService_GUARDDUTY_DATA_FIPS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_HEALTHLAKE ¶ added in v2.47.0
func InterfaceVpcEndpointAwsService_HEALTHLAKE() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_HEALTH_IMAGING ¶ added in v2.134.0
func InterfaceVpcEndpointAwsService_HEALTH_IMAGING() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_HEALTH_IMAGING_DICOM ¶ added in v2.154.0
func InterfaceVpcEndpointAwsService_HEALTH_IMAGING_DICOM() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_HEALTH_IMAGING_RUNTIME ¶ added in v2.134.0
func InterfaceVpcEndpointAwsService_HEALTH_IMAGING_RUNTIME() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_IAM ¶ added in v2.159.0
func InterfaceVpcEndpointAwsService_IAM() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_IAM_IDENTITY_CENTER ¶ added in v2.47.0
func InterfaceVpcEndpointAwsService_IAM_IDENTITY_CENTER() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_IAM_ROLES_ANYWHERE ¶ added in v2.47.0
func InterfaceVpcEndpointAwsService_IAM_ROLES_ANYWHERE() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_IMAGE_BUILDER ¶ added in v2.47.0
func InterfaceVpcEndpointAwsService_IMAGE_BUILDER() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_INSPECTOR ¶ added in v2.47.0
func InterfaceVpcEndpointAwsService_INSPECTOR() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_INSPECTOR_SCAN ¶ added in v2.134.0
func InterfaceVpcEndpointAwsService_INSPECTOR_SCAN() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_IOT_CORE ¶ added in v2.47.0
func InterfaceVpcEndpointAwsService_IOT_CORE() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_IOT_CORE_CREDENTIALS ¶ added in v2.134.0
func InterfaceVpcEndpointAwsService_IOT_CORE_CREDENTIALS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_IOT_CORE_DEVICE_ADVISOR ¶ added in v2.72.0
func InterfaceVpcEndpointAwsService_IOT_CORE_DEVICE_ADVISOR() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_IOT_CORE_FLEETHUB_API ¶ added in v2.134.0
func InterfaceVpcEndpointAwsService_IOT_CORE_FLEETHUB_API() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_IOT_CORE_FOR_LORAWAN ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_IOT_CORE_FOR_LORAWAN() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_IOT_FLEETWISE ¶ added in v2.134.0
func InterfaceVpcEndpointAwsService_IOT_FLEETWISE() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_IOT_GREENGRASS ¶ added in v2.47.0
func InterfaceVpcEndpointAwsService_IOT_GREENGRASS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_IOT_LORAWAN_CUPS ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_IOT_LORAWAN_CUPS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_IOT_LORAWAN_LNS ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_IOT_LORAWAN_LNS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_IOT_ROBORUNNER ¶ added in v2.72.0
func InterfaceVpcEndpointAwsService_IOT_ROBORUNNER() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_IOT_SITEWISE_API ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_IOT_SITEWISE_API() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_IOT_SITEWISE_DATA ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_IOT_SITEWISE_DATA() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_IOT_TWINMAKER_API ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_IOT_TWINMAKER_API() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_IOT_TWINMAKER_DATA ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_IOT_TWINMAKER_DATA() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_KENDRA ¶ added in v2.72.0
func InterfaceVpcEndpointAwsService_KENDRA() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_KENDRA_RANKING ¶ added in v2.72.0
func InterfaceVpcEndpointAwsService_KENDRA_RANKING() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_KEYSPACES ¶
func InterfaceVpcEndpointAwsService_KEYSPACES() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_KEYSPACES_FIPS ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_KEYSPACES_FIPS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_KINESIS_FIREHOSE ¶
func InterfaceVpcEndpointAwsService_KINESIS_FIREHOSE() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_KINESIS_STREAMS ¶
func InterfaceVpcEndpointAwsService_KINESIS_STREAMS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_KINESIS_STREAMS_FIPS ¶ added in v2.157.0
func InterfaceVpcEndpointAwsService_KINESIS_STREAMS_FIPS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_KMS ¶
func InterfaceVpcEndpointAwsService_KMS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_KMS_FIPS ¶ added in v2.72.0
func InterfaceVpcEndpointAwsService_KMS_FIPS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_LAKE_FORMATION ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_LAKE_FORMATION() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_LAMBDA ¶
func InterfaceVpcEndpointAwsService_LAMBDA() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_LAUNCH_WIZARD ¶ added in v2.159.0
func InterfaceVpcEndpointAwsService_LAUNCH_WIZARD() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_LEX_MODELS ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_LEX_MODELS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_LEX_RUNTIME ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_LEX_RUNTIME() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_LICENSE_MANAGER ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_LICENSE_MANAGER() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_LICENSE_MANAGER_FIPS ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_LICENSE_MANAGER_FIPS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_LICENSE_MANAGER_LINUX_SUBSCRIPTIONS ¶ added in v2.154.0
func InterfaceVpcEndpointAwsService_LICENSE_MANAGER_LINUX_SUBSCRIPTIONS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_LICENSE_MANAGER_LINUX_SUBSCRIPTIONS_FIPS ¶ added in v2.154.0
func InterfaceVpcEndpointAwsService_LICENSE_MANAGER_LINUX_SUBSCRIPTIONS_FIPS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_LICENSE_MANAGER_USER_SUBSCRIPTIONS ¶ added in v2.134.0
func InterfaceVpcEndpointAwsService_LICENSE_MANAGER_USER_SUBSCRIPTIONS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_LOOKOUT_EQUIPMENT ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_LOOKOUT_EQUIPMENT() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_LOOKOUT_METRICS ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_LOOKOUT_METRICS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_LOOKOUT_VISION ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_LOOKOUT_VISION() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_MACIE ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_MACIE() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_MAINFRAME_MODERNIZATION ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_MAINFRAME_MODERNIZATION() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_MAINFRAME_MODERNIZATION_APP_TEST ¶ added in v2.154.0
func InterfaceVpcEndpointAwsService_MAINFRAME_MODERNIZATION_APP_TEST() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_MANAGED_BLOCKCHAIN_BITCOIN_MAINNET ¶ added in v2.134.0
func InterfaceVpcEndpointAwsService_MANAGED_BLOCKCHAIN_BITCOIN_MAINNET() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_MANAGED_BLOCKCHAIN_BITCOIN_TESTNET ¶ added in v2.134.0
func InterfaceVpcEndpointAwsService_MANAGED_BLOCKCHAIN_BITCOIN_TESTNET() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_MANAGED_BLOCKCHAIN_QUERY ¶ added in v2.134.0
func InterfaceVpcEndpointAwsService_MANAGED_BLOCKCHAIN_QUERY() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_MANAGEMENT_CONSOLE ¶ added in v2.134.0
func InterfaceVpcEndpointAwsService_MANAGEMENT_CONSOLE() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_MANAGEMENT_CONSOLE_SIGNIN ¶ added in v2.134.0
func InterfaceVpcEndpointAwsService_MANAGEMENT_CONSOLE_SIGNIN() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_MEMORY_DB ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_MEMORY_DB() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_MEMORY_DB_FIPS ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_MEMORY_DB_FIPS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_MIGRATIONHUB_ORCHESTRATOR ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_MIGRATIONHUB_ORCHESTRATOR() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_MIGRATIONHUB_REFACTOR_SPACES ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_MIGRATIONHUB_REFACTOR_SPACES() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_MIGRATIONHUB_STRATEGY ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_MIGRATIONHUB_STRATEGY() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_NEPTUNE_ANALYTICS ¶ added in v2.134.0
func InterfaceVpcEndpointAwsService_NEPTUNE_ANALYTICS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_NETWORK_FIREWALL ¶ added in v2.159.0
func InterfaceVpcEndpointAwsService_NETWORK_FIREWALL() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_NETWORK_FIREWALL_FIPS ¶ added in v2.159.0
func InterfaceVpcEndpointAwsService_NETWORK_FIREWALL_FIPS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_NIMBLE_STUDIO ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_NIMBLE_STUDIO() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_OMICS_ANALYTICS ¶ added in v2.72.0
func InterfaceVpcEndpointAwsService_OMICS_ANALYTICS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_OMICS_CONTROL_STORAGE ¶ added in v2.72.0
func InterfaceVpcEndpointAwsService_OMICS_CONTROL_STORAGE() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_OMICS_STORAGE ¶ added in v2.72.0
func InterfaceVpcEndpointAwsService_OMICS_STORAGE() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_OMICS_TAGS ¶ added in v2.72.0
func InterfaceVpcEndpointAwsService_OMICS_TAGS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_OMICS_WORKFLOWS ¶ added in v2.72.0
func InterfaceVpcEndpointAwsService_OMICS_WORKFLOWS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_ORGANIZATIONS ¶ added in v2.134.0
func InterfaceVpcEndpointAwsService_ORGANIZATIONS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_ORGANIZATIONS_FIPS ¶ added in v2.134.0
func InterfaceVpcEndpointAwsService_ORGANIZATIONS_FIPS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_OUTPOSTS ¶ added in v2.154.0
func InterfaceVpcEndpointAwsService_OUTPOSTS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_PANORAMA ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_PANORAMA() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_PARALLEL_COMPUTING_SERVICE ¶ added in v2.157.0
func InterfaceVpcEndpointAwsService_PARALLEL_COMPUTING_SERVICE() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_PARALLEL_COMPUTING_SERVICE_FIPS ¶ added in v2.157.0
func InterfaceVpcEndpointAwsService_PARALLEL_COMPUTING_SERVICE_FIPS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_PAYMENT_CRYPTOGRAPHY_CONTROLPLANE ¶ added in v2.134.0
func InterfaceVpcEndpointAwsService_PAYMENT_CRYPTOGRAPHY_CONTROLPLANE() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_PAYMENT_CRYTOGRAPHY_DATAPLANE ¶ added in v2.134.0
func InterfaceVpcEndpointAwsService_PAYMENT_CRYTOGRAPHY_DATAPLANE() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_PERSONALIZE ¶ added in v2.134.0
func InterfaceVpcEndpointAwsService_PERSONALIZE() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_PERSONALIZE_EVENTS ¶ added in v2.134.0
func InterfaceVpcEndpointAwsService_PERSONALIZE_EVENTS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_PERSONALIZE_RUNTIME ¶ added in v2.134.0
func InterfaceVpcEndpointAwsService_PERSONALIZE_RUNTIME() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_PINPOINT ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_PINPOINT() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_PINPOINT_SMS_VOICE_V2 ¶ added in v2.134.0
func InterfaceVpcEndpointAwsService_PINPOINT_SMS_VOICE_V2() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_PINPOINT_V1 ¶ added in v2.134.0
func InterfaceVpcEndpointAwsService_PINPOINT_V1() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_PIPES ¶ added in v2.154.0
func InterfaceVpcEndpointAwsService_PIPES() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_PIPES_DATA ¶ added in v2.144.0
func InterfaceVpcEndpointAwsService_PIPES_DATA() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_PIPES_FIPS ¶ added in v2.154.0
func InterfaceVpcEndpointAwsService_PIPES_FIPS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_POLLY ¶ added in v2.72.0
func InterfaceVpcEndpointAwsService_POLLY() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_PRIVATE_5G ¶ added in v2.72.0
func InterfaceVpcEndpointAwsService_PRIVATE_5G() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_PRIVATE_CERTIFICATE_AUTHORITY ¶ added in v2.47.0
func InterfaceVpcEndpointAwsService_PRIVATE_CERTIFICATE_AUTHORITY() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_PRIVATE_CERTIFICATE_AUTHORITY_CONNECTOR_AD ¶ added in v2.134.0
func InterfaceVpcEndpointAwsService_PRIVATE_CERTIFICATE_AUTHORITY_CONNECTOR_AD() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_PRIVATE_CERTIFICATE_AUTHORITY_CONNECTOR_SCEP ¶ added in v2.159.0
func InterfaceVpcEndpointAwsService_PRIVATE_CERTIFICATE_AUTHORITY_CONNECTOR_SCEP() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_PROMETHEUS ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_PROMETHEUS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_PROMETHEUS_WORKSPACES ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_PROMETHEUS_WORKSPACES() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_PROTON ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_PROTON() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_QLDB ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_QLDB() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_QUICKSIGHT_WEBSITE ¶ added in v2.154.0
func InterfaceVpcEndpointAwsService_QUICKSIGHT_WEBSITE() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_Q_BUSSINESS ¶ added in v2.154.0
func InterfaceVpcEndpointAwsService_Q_BUSSINESS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_Q_DEVELOPER ¶ added in v2.157.0
func InterfaceVpcEndpointAwsService_Q_DEVELOPER() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_Q_DEVELOPER_CODE_WHISPERER ¶ added in v2.154.0
func InterfaceVpcEndpointAwsService_Q_DEVELOPER_CODE_WHISPERER() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_Q_DEVELOPER_QAPPS ¶ added in v2.154.0
func InterfaceVpcEndpointAwsService_Q_DEVELOPER_QAPPS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_Q_USER_SUBSCRIPTIONS ¶ added in v2.157.0
func InterfaceVpcEndpointAwsService_Q_USER_SUBSCRIPTIONS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_RDS ¶
func InterfaceVpcEndpointAwsService_RDS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_RDS_DATA ¶
func InterfaceVpcEndpointAwsService_RDS_DATA() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_RDS_PERFORMANCE_INSIGHTS ¶ added in v2.157.0
func InterfaceVpcEndpointAwsService_RDS_PERFORMANCE_INSIGHTS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_RDS_PERFORMANCE_INSIGHTS_FIPS ¶ added in v2.157.0
func InterfaceVpcEndpointAwsService_RDS_PERFORMANCE_INSIGHTS_FIPS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_RECYCLE_BIN ¶ added in v2.157.0
func InterfaceVpcEndpointAwsService_RECYCLE_BIN() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_REDSHIFT ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_REDSHIFT() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_REDSHIFT_DATA ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_REDSHIFT_DATA() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_REDSHIFT_DATA_FIPS ¶ added in v2.154.0
func InterfaceVpcEndpointAwsService_REDSHIFT_DATA_FIPS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_REDSHIFT_FIPS ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_REDSHIFT_FIPS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_REDSHIFT_SERVERLESS ¶ added in v2.157.0
func InterfaceVpcEndpointAwsService_REDSHIFT_SERVERLESS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_REDSHIFT_SERVERLESS_FIPS ¶ added in v2.157.0
func InterfaceVpcEndpointAwsService_REDSHIFT_SERVERLESS_FIPS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_REKOGNITION ¶
func InterfaceVpcEndpointAwsService_REKOGNITION() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_REKOGNITION_FIPS ¶
func InterfaceVpcEndpointAwsService_REKOGNITION_FIPS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_REKOGNITION_STREAMING ¶ added in v2.134.0
func InterfaceVpcEndpointAwsService_REKOGNITION_STREAMING() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_REKOGNITION_STREAMING_FIPS ¶ added in v2.134.0
func InterfaceVpcEndpointAwsService_REKOGNITION_STREAMING_FIPS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_REPOST_SPACE ¶ added in v2.134.0
func InterfaceVpcEndpointAwsService_REPOST_SPACE() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_RESOURCE_ACCESS_MANAGER ¶ added in v2.159.0
func InterfaceVpcEndpointAwsService_RESOURCE_ACCESS_MANAGER() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_ROBOMAKER ¶ added in v2.47.0
func InterfaceVpcEndpointAwsService_ROBOMAKER() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_S3 ¶ added in v2.35.0
func InterfaceVpcEndpointAwsService_S3() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_S3_MULTI_REGION_ACCESS_POINTS ¶ added in v2.72.0
func InterfaceVpcEndpointAwsService_S3_MULTI_REGION_ACCESS_POINTS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_S3_OUTPOSTS ¶ added in v2.47.0
func InterfaceVpcEndpointAwsService_S3_OUTPOSTS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_SAGEMAKER_API ¶
func InterfaceVpcEndpointAwsService_SAGEMAKER_API() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_SAGEMAKER_FEATURESTORE_RUNTIME ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_SAGEMAKER_FEATURESTORE_RUNTIME() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_SAGEMAKER_GEOSPATIAL ¶ added in v2.134.0
func InterfaceVpcEndpointAwsService_SAGEMAKER_GEOSPATIAL() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_SAGEMAKER_METRICS ¶ added in v2.72.0
func InterfaceVpcEndpointAwsService_SAGEMAKER_METRICS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_SAGEMAKER_NOTEBOOK ¶
func InterfaceVpcEndpointAwsService_SAGEMAKER_NOTEBOOK() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_SAGEMAKER_RUNTIME ¶
func InterfaceVpcEndpointAwsService_SAGEMAKER_RUNTIME() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_SAGEMAKER_RUNTIME_FIPS ¶
func InterfaceVpcEndpointAwsService_SAGEMAKER_RUNTIME_FIPS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_SAGEMAKER_STUDIO ¶ added in v2.41.0
func InterfaceVpcEndpointAwsService_SAGEMAKER_STUDIO() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_SECRETS_MANAGER ¶
func InterfaceVpcEndpointAwsService_SECRETS_MANAGER() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_SECURITYHUB ¶ added in v2.44.0
func InterfaceVpcEndpointAwsService_SECURITYHUB() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_SERVER_MIGRATION_SERVICE ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_SERVER_MIGRATION_SERVICE() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_SERVER_MIGRATION_SERVICE_AWSCONNECTOR ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_SERVER_MIGRATION_SERVICE_AWSCONNECTOR() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_SERVER_MIGRATION_SERVICE_FIPS ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_SERVER_MIGRATION_SERVICE_FIPS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_SERVICE_CATALOG ¶
func InterfaceVpcEndpointAwsService_SERVICE_CATALOG() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_SERVICE_CATALOG_APPREGISTRY ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_SERVICE_CATALOG_APPREGISTRY() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_SES ¶ added in v2.47.0
func InterfaceVpcEndpointAwsService_SES() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_SIMSPACE_WEAVER ¶ added in v2.134.0
func InterfaceVpcEndpointAwsService_SIMSPACE_WEAVER() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_SNOW_DEVICE_MANAGEMENT ¶ added in v2.47.0
func InterfaceVpcEndpointAwsService_SNOW_DEVICE_MANAGEMENT() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_SNS ¶
func InterfaceVpcEndpointAwsService_SNS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_SQS ¶
func InterfaceVpcEndpointAwsService_SQS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_SSM ¶
func InterfaceVpcEndpointAwsService_SSM() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_SSM_CONTACTS ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_SSM_CONTACTS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_SSM_FIPS ¶ added in v2.157.0
func InterfaceVpcEndpointAwsService_SSM_FIPS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_SSM_INCIDENTS ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_SSM_INCIDENTS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_SSM_MESSAGES ¶
func InterfaceVpcEndpointAwsService_SSM_MESSAGES() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_SSM_QUICK_SETUP ¶ added in v2.157.0
func InterfaceVpcEndpointAwsService_SSM_QUICK_SETUP() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_STEP_FUNCTIONS ¶
func InterfaceVpcEndpointAwsService_STEP_FUNCTIONS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_STEP_FUNCTIONS_SYNC ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_STEP_FUNCTIONS_SYNC() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_STORAGE_GATEWAY ¶
func InterfaceVpcEndpointAwsService_STORAGE_GATEWAY() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_STS ¶
func InterfaceVpcEndpointAwsService_STS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_SUPPLY_CHAIN ¶ added in v2.134.0
func InterfaceVpcEndpointAwsService_SUPPLY_CHAIN() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_SWF ¶ added in v2.134.0
func InterfaceVpcEndpointAwsService_SWF() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_SWF_FIPS ¶ added in v2.134.0
func InterfaceVpcEndpointAwsService_SWF_FIPS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_TELCO_NETWORK_BUILDER ¶ added in v2.134.0
func InterfaceVpcEndpointAwsService_TELCO_NETWORK_BUILDER() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_TEXTRACT ¶ added in v2.28.0
func InterfaceVpcEndpointAwsService_TEXTRACT() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_TEXTRACT_FIPS ¶ added in v2.28.0
func InterfaceVpcEndpointAwsService_TEXTRACT_FIPS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_TIMESTREAM_INFLUXDB ¶ added in v2.134.0
func InterfaceVpcEndpointAwsService_TIMESTREAM_INFLUXDB() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_TIMESTREAM_INFLUXDB_FIPS ¶ added in v2.157.0
func InterfaceVpcEndpointAwsService_TIMESTREAM_INFLUXDB_FIPS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_TRANSCRIBE ¶
func InterfaceVpcEndpointAwsService_TRANSCRIBE() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_TRANSCRIBE_STREAMING ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_TRANSCRIBE_STREAMING() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_TRANSFER ¶
func InterfaceVpcEndpointAwsService_TRANSFER() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_TRANSFER_SERVER ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_TRANSFER_SERVER() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_TRANSLATE ¶ added in v2.54.0
func InterfaceVpcEndpointAwsService_TRANSLATE() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_TRUSTED_ADVISOR ¶ added in v2.134.0
func InterfaceVpcEndpointAwsService_TRUSTED_ADVISOR() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_VERIFIED_PERMISSIONS ¶ added in v2.95.0
func InterfaceVpcEndpointAwsService_VERIFIED_PERMISSIONS() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_VPC_LATTICE ¶ added in v2.134.0
func InterfaceVpcEndpointAwsService_VPC_LATTICE() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_WELL_ARCHITECTED_TOOL ¶ added in v2.157.0
func InterfaceVpcEndpointAwsService_WELL_ARCHITECTED_TOOL() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_WORKSPACES ¶ added in v2.47.0
func InterfaceVpcEndpointAwsService_WORKSPACES() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_WORKSPACES_THIN_CLIENT ¶ added in v2.134.0
func InterfaceVpcEndpointAwsService_WORKSPACES_THIN_CLIENT() InterfaceVpcEndpointAwsService
func InterfaceVpcEndpointAwsService_XRAY ¶
func InterfaceVpcEndpointAwsService_XRAY() InterfaceVpcEndpointAwsService
func NewInterfaceVpcEndpointAwsService ¶
func NewInterfaceVpcEndpointAwsService(name *string, prefix *string, port *float64, props *InterfaceVpcEndpointAwsServiceProps) InterfaceVpcEndpointAwsService
type InterfaceVpcEndpointAwsServiceProps ¶ added in v2.135.0
type InterfaceVpcEndpointAwsServiceProps struct {
// If true, the service is a global endpoint and its name will not be prefixed with the stack's region.
// Default: false.
//
Global *bool `field:"optional" json:"global" yaml:"global"`
}
Optional properties for the InterfaceVpcEndpointAwsService class.
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"
interfaceVpcEndpointAwsServiceProps := &InterfaceVpcEndpointAwsServiceProps{
Global: jsii.Boolean(false),
}
type InterfaceVpcEndpointOptions ¶
type InterfaceVpcEndpointOptions struct {
// The service to use for this interface VPC endpoint.
Service IInterfaceVpcEndpointService `field:"required" json:"service" yaml:"service"`
// Limit to only those availability zones where the endpoint service can be created.
//
// Setting this to 'true' requires a lookup to be performed at synthesis time. Account
// and region must be set on the containing stack for this to work.
// Default: false.
//
LookupSupportedAzs *bool `field:"optional" json:"lookupSupportedAzs" yaml:"lookupSupportedAzs"`
// Whether to automatically allow VPC traffic to the endpoint.
//
// If enabled, all traffic to the endpoint from within the VPC will be
// automatically allowed. This is done based on the VPC's CIDR range.
// Default: true.
//
Open *bool `field:"optional" json:"open" yaml:"open"`
// Whether to associate a private hosted zone with the specified VPC.
//
// This
// allows you to make requests to the service using its default DNS hostname.
// Default: set by the instance of IInterfaceVpcEndpointService, or true if
// not defined by the instance of IInterfaceVpcEndpointService.
//
PrivateDnsEnabled *bool `field:"optional" json:"privateDnsEnabled" yaml:"privateDnsEnabled"`
// The security groups to associate with this interface VPC endpoint.
// Default: - a new security group is created.
//
SecurityGroups *[]ISecurityGroup `field:"optional" json:"securityGroups" yaml:"securityGroups"`
// The subnets in which to create an endpoint network interface.
//
// At most one
// per availability zone.
// Default: - private subnets.
//
Subnets *SubnetSelection `field:"optional" json:"subnets" yaml:"subnets"`
}
Options to add an interface endpoint to a VPC.
Example:
// Add gateway endpoints when creating the VPC
vpc := ec2.NewVpc(this, jsii.String("MyVpc"), &VpcProps{
GatewayEndpoints: map[string]gatewayVpcEndpointOptions{
"S3": &gatewayVpcEndpointOptions{
"service": ec2.GatewayVpcEndpointAwsService_S3(),
},
},
})
// Alternatively gateway endpoints can be added on the VPC
dynamoDbEndpoint := vpc.addGatewayEndpoint(jsii.String("DynamoDbEndpoint"), &gatewayVpcEndpointOptions{
Service: ec2.GatewayVpcEndpointAwsService_DYNAMODB(),
})
// This allows to customize the endpoint policy
dynamoDbEndpoint.AddToPolicy(
iam.NewPolicyStatement(&PolicyStatementProps{
// Restrict to listing and describing tables
Principals: []iPrincipal{
iam.NewAnyPrincipal(),
},
Actions: []*string{
jsii.String("dynamodb:DescribeTable"),
jsii.String("dynamodb:ListTables"),
},
Resources: []*string{
jsii.String("*"),
},
}))
// Add an interface endpoint
vpc.addInterfaceEndpoint(jsii.String("EcrDockerEndpoint"), &InterfaceVpcEndpointOptions{
Service: ec2.InterfaceVpcEndpointAwsService_ECR_DOCKER(),
})
type InterfaceVpcEndpointProps ¶
type InterfaceVpcEndpointProps struct {
// The service to use for this interface VPC endpoint.
Service IInterfaceVpcEndpointService `field:"required" json:"service" yaml:"service"`
// Limit to only those availability zones where the endpoint service can be created.
//
// Setting this to 'true' requires a lookup to be performed at synthesis time. Account
// and region must be set on the containing stack for this to work.
// Default: false.
//
LookupSupportedAzs *bool `field:"optional" json:"lookupSupportedAzs" yaml:"lookupSupportedAzs"`
// Whether to automatically allow VPC traffic to the endpoint.
//
// If enabled, all traffic to the endpoint from within the VPC will be
// automatically allowed. This is done based on the VPC's CIDR range.
// Default: true.
//
Open *bool `field:"optional" json:"open" yaml:"open"`
// Whether to associate a private hosted zone with the specified VPC.
//
// This
// allows you to make requests to the service using its default DNS hostname.
// Default: set by the instance of IInterfaceVpcEndpointService, or true if
// not defined by the instance of IInterfaceVpcEndpointService.
//
PrivateDnsEnabled *bool `field:"optional" json:"privateDnsEnabled" yaml:"privateDnsEnabled"`
// The security groups to associate with this interface VPC endpoint.
// Default: - a new security group is created.
//
SecurityGroups *[]ISecurityGroup `field:"optional" json:"securityGroups" yaml:"securityGroups"`
// The subnets in which to create an endpoint network interface.
//
// At most one
// per availability zone.
// Default: - private subnets.
//
Subnets *SubnetSelection `field:"optional" json:"subnets" yaml:"subnets"`
// The VPC network in which the interface endpoint will be used.
Vpc IVpc `field:"required" json:"vpc" yaml:"vpc"`
}
Construction properties for an InterfaceVpcEndpoint.
Example:
var vpc vpc
ec2.NewInterfaceVpcEndpoint(this, jsii.String("VPC Endpoint"), &InterfaceVpcEndpointProps{
Vpc: Vpc,
Service: ec2.NewInterfaceVpcEndpointService(jsii.String("com.amazonaws.vpce.us-east-1.vpce-svc-uuddlrlrbastrtsvc"), jsii.Number(443)),
// Choose which availability zones to place the VPC endpoint in, based on
// available AZs
Subnets: &SubnetSelection{
AvailabilityZones: []*string{
jsii.String("us-east-1a"),
jsii.String("us-east-1c"),
},
},
})
type InterfaceVpcEndpointService ¶
type InterfaceVpcEndpointService interface {
IInterfaceVpcEndpointService
// The name of the service.
Name() *string
// The port of the service.
Port() *float64
// Whether Private DNS is supported by default.
PrivateDnsDefault() *bool
}
A custom-hosted service for an interface VPC endpoint.
Example:
var vpc vpc
ec2.NewInterfaceVpcEndpoint(this, jsii.String("VPC Endpoint"), &InterfaceVpcEndpointProps{
Vpc: Vpc,
Service: ec2.NewInterfaceVpcEndpointService(jsii.String("com.amazonaws.vpce.us-east-1.vpce-svc-uuddlrlrbastrtsvc"), jsii.Number(443)),
// Choose which availability zones to place the VPC endpoint in, based on
// available AZs
Subnets: &SubnetSelection{
AvailabilityZones: []*string{
jsii.String("us-east-1a"),
jsii.String("us-east-1c"),
},
},
})
func NewInterfaceVpcEndpointService ¶
func NewInterfaceVpcEndpointService(name *string, port *float64) InterfaceVpcEndpointService
type IpAddresses ¶ added in v2.48.0
type IpAddresses interface {
}
An abstract Provider of IpAddresses.
Note this is specific to the IPv4 CIDR.
Example:
vpc := ec2.NewVpc(this, jsii.String("TheVPC"), &VpcProps{
// 'IpAddresses' configures the IP range and size of the entire VPC.
// The IP space will be divided based on configuration for the subnets.
IpAddresses: ec2.IpAddresses_Cidr(jsii.String("10.0.0.0/21")),
// 'maxAzs' configures the maximum number of availability zones to use.
// If you want to specify the exact availability zones you want the VPC
// to use, use `availabilityZones` instead.
MaxAzs: jsii.Number(3),
// 'subnetConfiguration' specifies the "subnet groups" to create.
// Every subnet group will have a subnet for each AZ, so this
// configuration will create `3 groups × 3 AZs = 9` subnets.
SubnetConfiguration: []subnetConfiguration{
&subnetConfiguration{
// 'subnetType' controls Internet access, as described above.
SubnetType: ec2.SubnetType_PUBLIC,
// 'name' is used to name this particular subnet group. You will have to
// use the name for subnet selection if you have more than one subnet
// group of the same type.
Name: jsii.String("Ingress"),
// 'cidrMask' specifies the IP addresses in the range of of individual
// subnets in the group. Each of the subnets in this group will contain
// `2^(32 address bits - 24 subnet bits) - 2 reserved addresses = 254`
// usable IP addresses.
//
// If 'cidrMask' is left out the available address space is evenly
// divided across the remaining subnet groups.
CidrMask: jsii.Number(24),
},
&subnetConfiguration{
CidrMask: jsii.Number(24),
Name: jsii.String("Application"),
SubnetType: ec2.SubnetType_PRIVATE_WITH_EGRESS,
},
&subnetConfiguration{
CidrMask: jsii.Number(28),
Name: jsii.String("Database"),
SubnetType: ec2.SubnetType_PRIVATE_ISOLATED,
// 'reserved' can be used to reserve IP address space. No resources will
// be created for this subnet, but the IP range will be kept available for
// future creation of this subnet, or even for future subdivision.
Reserved: jsii.Boolean(true),
},
},
})
type IpProtocol ¶ added in v2.121.0
type IpProtocol string
The types of IP addresses provisioned in the VPC.
Example:
import "github.com/aws/aws-cdk-go/awscdk"
// The VPC and subnet must have associated IPv6 CIDR blocks.
vpc := ec2.NewVpc(this, jsii.String("Vpc"), &VpcProps{
IpProtocol: ec2.IpProtocol_DUAL_STACK,
})
cluster := ecs.NewCluster(this, jsii.String("EcsCluster"), &ClusterProps{
Vpc: Vpc,
})
service := ecsPatterns.NewApplicationLoadBalancedFargateService(this, jsii.String("myService"), &ApplicationLoadBalancedFargateServiceProps{
Cluster: Cluster,
TaskImageOptions: &ApplicationLoadBalancedTaskImageOptions{
Image: ecs.ContainerImage_FromRegistry(jsii.String("amazon/amazon-ecs-sample")),
},
IpAddressType: elbv2.IpAddressType_DUAL_STACK,
})
applicationLoadBalancedEc2Service := ecsPatterns.NewApplicationLoadBalancedEc2Service(this, jsii.String("myService"), &ApplicationLoadBalancedEc2ServiceProps{
Cluster: Cluster,
TaskImageOptions: &ApplicationLoadBalancedTaskImageOptions{
Image: ecs.ContainerImage_*FromRegistry(jsii.String("amazon/amazon-ecs-sample")),
},
IpAddressType: elbv2.IpAddressType_DUAL_STACK,
})
const ( // The vpc will be configured with only IPv4 addresses. // // This is the default protocol if unset. IpProtocol_IPV4_ONLY IpProtocol = "IPV4_ONLY" // The vpc will have both IPv4 and IPv6 addresses. // // Unless specified, public IPv4 addresses will not be auto assigned, // an egress only internet gateway (EIGW) will be created and configured, // and NATs and internet gateways (IGW) will be configured with IPv6 addresses. IpProtocol_DUAL_STACK IpProtocol = "DUAL_STACK" )
type Ipv6Addresses ¶ added in v2.121.0
type Ipv6Addresses interface {
}
An abstract Provider of Ipv6Addresses.
Note this is specific to the IPv6 CIDR.
type KeyPair ¶ added in v2.116.0
type KeyPair interface {
awscdk.Resource
IKeyPair
// The environment this resource belongs to.
//
// For resources that are created and managed by the CDK
// (generally, those created by creating new class instances like Role, Bucket, etc.),
// this is always the same as the environment of the stack they belong to;
// however, for imported resources
// (those obtained from static methods like fromRoleArn, fromBucketName, etc.),
// that might be different than the stack they were imported into.
Env() *awscdk.ResourceEnvironment
// The format of the key pair.
Format() KeyPairFormat
// Whether the key material was imported.
//
// Keys with imported material do not have their private key material stored
// or returned automatically.
HasImportedMaterial() *bool
// The fingerprint of the key pair.
KeyPairFingerprint() *string
// The unique ID of the key pair.
KeyPairId() *string
// The unique name of the key pair.
KeyPairName() *string
// The tree node.
Node() constructs.Node
// Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
//
// This value will resolve to one of the following:
// - a concrete value (e.g. `"my-awesome-bucket"`)
// - `undefined`, when a name should be generated by CloudFormation
// - a concrete name generated automatically during synthesis, in
// cross-environment scenarios.
PhysicalName() *string
// The Systems Manager Parameter Store parameter with the pair's private key material.
PrivateKey() awsssm.IStringParameter
// The stack in which this resource is defined.
Stack() awscdk.Stack
// The type of the key pair.
Type() KeyPairType
// Apply the given removal policy to this resource.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
GeneratePhysicalName() *string
// Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`).
//
// Normally, this token will resolve to `arnAttr`, but if the resource is
// referenced across environments, `arnComponents` will be used to synthesize
// a concrete ARN with the resource's physical name. Make sure to reference
// `this.physicalName` in `arnComponents`.
GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
// Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`).
//
// Normally, this token will resolve to `nameAttr`, but if the resource is
// referenced across environments, it will be resolved to `this.physicalName`,
// which will be a concrete name.
GetResourceNameAttribute(nameAttr *string) *string
// Returns a string representation of this construct.
ToString() *string
}
An EC2 Key Pair.
Example:
keyPair := ec2.KeyPair_FromKeyPairAttributes(this, jsii.String("KeyPair"), &KeyPairAttributes{
KeyPairName: jsii.String("the-keypair-name"),
Type: ec2.KeyPairType_RSA,
})
func NewKeyPair ¶ added in v2.116.0
func NewKeyPair(scope constructs.Construct, id *string, props *KeyPairProps) KeyPair
type KeyPairAttributes ¶ added in v2.116.0
type KeyPairAttributes struct {
// The unique name of the key pair.
KeyPairName *string `field:"required" json:"keyPairName" yaml:"keyPairName"`
// The type of the key pair.
// Default: no type specified.
//
Type KeyPairType `field:"optional" json:"type" yaml:"type"`
}
Attributes of a Key Pair.
Example:
keyPair := ec2.KeyPair_FromKeyPairAttributes(this, jsii.String("KeyPair"), &KeyPairAttributes{
KeyPairName: jsii.String("the-keypair-name"),
Type: ec2.KeyPairType_RSA,
})
type KeyPairFormat ¶ added in v2.116.0
type KeyPairFormat string
The format of the Key Pair.
Example:
var vpc vpc
var instanceType instanceType
keyPair := ec2.NewKeyPair(this, jsii.String("KeyPair"), &KeyPairProps{
Type: ec2.KeyPairType_ED25519,
Format: ec2.KeyPairFormat_PEM,
})
instance := ec2.NewInstance(this, jsii.String("Instance"), &InstanceProps{
Vpc: Vpc,
InstanceType: InstanceType,
MachineImage: ec2.MachineImage_LatestAmazonLinux2023(),
// Use the custom key pair
KeyPair: KeyPair,
})
const ( // A PPK file, typically used with PuTTY. KeyPairFormat_PPK KeyPairFormat = "PPK" // A PEM file. KeyPairFormat_PEM KeyPairFormat = "PEM" )
type KeyPairProps ¶ added in v2.116.0
type KeyPairProps struct {
// The AWS account ID this resource belongs to.
// Default: - the resource is in the same account as the stack it belongs to.
//
Account *string `field:"optional" json:"account" yaml:"account"`
// ARN to deduce region and account from.
//
// The ARN is parsed and the account and region are taken from the ARN.
// This should be used for imported resources.
//
// Cannot be supplied together with either `account` or `region`.
// Default: - take environment from `account`, `region` parameters, or use Stack environment.
//
EnvironmentFromArn *string `field:"optional" json:"environmentFromArn" yaml:"environmentFromArn"`
// The value passed in by users to the physical name prop of the resource.
//
// - `undefined` implies that a physical name will be allocated by
// CloudFormation during deployment.
// - a concrete value implies a specific physical name
// - `PhysicalName.GENERATE_IF_NEEDED` is a marker that indicates that a physical will only be generated
// by the CDK if it is needed for cross-environment references. Otherwise, it will be allocated by CloudFormation.
// Default: - The physical name will be allocated by CloudFormation at deployment time.
//
PhysicalName *string `field:"optional" json:"physicalName" yaml:"physicalName"`
// The AWS region this resource belongs to.
// Default: - the resource is in the same region as the stack it belongs to.
//
Region *string `field:"optional" json:"region" yaml:"region"`
// The format of the key pair.
// Default: PEM.
//
Format KeyPairFormat `field:"optional" json:"format" yaml:"format"`
// A unique name for the key pair.
// Default: A generated name.
//
KeyPairName *string `field:"optional" json:"keyPairName" yaml:"keyPairName"`
// The public key material.
//
// If this is provided the key is considered "imported". For imported
// keys, it is assumed that you already have the private key material
// so the private key material will not be returned or stored in
// AWS Systems Manager Parameter Store.
// Default: a public and private key will be generated.
//
PublicKeyMaterial *string `field:"optional" json:"publicKeyMaterial" yaml:"publicKeyMaterial"`
// The type of key pair.
// Default: RSA (ignored if keyMaterial is provided).
//
Type KeyPairType `field:"optional" json:"type" yaml:"type"`
}
The properties of a Key Pair.
Example:
var vpc vpc
var instanceType instanceType
keyPair := ec2.NewKeyPair(this, jsii.String("KeyPair"), &KeyPairProps{
Type: ec2.KeyPairType_ED25519,
Format: ec2.KeyPairFormat_PEM,
})
instance := ec2.NewInstance(this, jsii.String("Instance"), &InstanceProps{
Vpc: Vpc,
InstanceType: InstanceType,
MachineImage: ec2.MachineImage_LatestAmazonLinux2023(),
// Use the custom key pair
KeyPair: KeyPair,
})
type KeyPairType ¶ added in v2.116.0
type KeyPairType string
The type of the key pair.
Example:
var vpc vpc
var instanceType instanceType
keyPair := ec2.NewKeyPair(this, jsii.String("KeyPair"), &KeyPairProps{
Type: ec2.KeyPairType_ED25519,
Format: ec2.KeyPairFormat_PEM,
})
instance := ec2.NewInstance(this, jsii.String("Instance"), &InstanceProps{
Vpc: Vpc,
InstanceType: InstanceType,
MachineImage: ec2.MachineImage_LatestAmazonLinux2023(),
// Use the custom key pair
KeyPair: KeyPair,
})
const ( // An RSA key. KeyPairType_RSA KeyPairType = "RSA" // An ED25519 key. // // Note that ED25519 keys are not supported for Windows instances. KeyPairType_ED25519 KeyPairType = "ED25519" )
type LaunchTemplate ¶
type LaunchTemplate interface {
awscdk.Resource
IConnectable
ILaunchTemplate
awsiam.IGrantable
// Allows specifying security group connections for the instance.
Connections() Connections
// The default version for the launch template.
DefaultVersionNumber() *string
// The environment this resource belongs to.
//
// For resources that are created and managed by the CDK
// (generally, those created by creating new class instances like Role, Bucket, etc.),
// this is always the same as the environment of the stack they belong to;
// however, for imported resources
// (those obtained from static methods like fromRoleArn, fromBucketName, etc.),
// that might be different than the stack they were imported into.
Env() *awscdk.ResourceEnvironment
// Principal to grant permissions to.
GrantPrincipal() awsiam.IPrincipal
// The AMI ID of the image to use.
ImageId() *string
// Type of instance to launch.
InstanceType() InstanceType
// The latest version of the launch template.
LatestVersionNumber() *string
// The identifier of the Launch Template.
//
// Exactly one of `launchTemplateId` and `launchTemplateName` will be set.
LaunchTemplateId() *string
// The name of the Launch Template.
//
// Exactly one of `launchTemplateId` and `launchTemplateName` will be set.
LaunchTemplateName() *string
// The tree node.
Node() constructs.Node
// The type of OS the instance is running.
OsType() OperatingSystemType
// Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
//
// This value will resolve to one of the following:
// - a concrete value (e.g. `"my-awesome-bucket"`)
// - `undefined`, when a name should be generated by CloudFormation
// - a concrete name generated automatically during synthesis, in
// cross-environment scenarios.
PhysicalName() *string
// IAM Role assumed by instances that are launched from this template.
Role() awsiam.IRole
// The stack in which this resource is defined.
Stack() awscdk.Stack
// TagManager for tagging support.
Tags() awscdk.TagManager
// UserData executed by instances that are launched from this template.
UserData() UserData
// The version number of this launch template to use.
VersionNumber() *string
// Add the security group to the instance.
AddSecurityGroup(securityGroup ISecurityGroup)
// Apply the given removal policy to this resource.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
GeneratePhysicalName() *string
// Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`).
//
// Normally, this token will resolve to `arnAttr`, but if the resource is
// referenced across environments, `arnComponents` will be used to synthesize
// a concrete ARN with the resource's physical name. Make sure to reference
// `this.physicalName` in `arnComponents`.
GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
// Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`).
//
// Normally, this token will resolve to `nameAttr`, but if the resource is
// referenced across environments, it will be resolved to `this.physicalName`,
// which will be a concrete name.
GetResourceNameAttribute(nameAttr *string) *string
// Returns a string representation of this construct.
ToString() *string
}
This represents an EC2 LaunchTemplate.
Example:
var vpc vpc
sg1 := ec2.NewSecurityGroup(this, jsii.String("sg1"), &SecurityGroupProps{
Vpc: vpc,
})
sg2 := ec2.NewSecurityGroup(this, jsii.String("sg2"), &SecurityGroupProps{
Vpc: vpc,
})
launchTemplate := ec2.NewLaunchTemplate(this, jsii.String("LaunchTemplate"), &LaunchTemplateProps{
MachineImage: ec2.MachineImage_LatestAmazonLinux2023(),
SecurityGroup: sg1,
})
launchTemplate.AddSecurityGroup(sg2)
See: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html
func NewLaunchTemplate ¶
func NewLaunchTemplate(scope constructs.Construct, id *string, props *LaunchTemplateProps) LaunchTemplate
type LaunchTemplateAttributes ¶
type LaunchTemplateAttributes struct {
// The identifier of the Launch Template.
//
// Exactly one of `launchTemplateId` and `launchTemplateName` may be set.
// Default: None.
//
LaunchTemplateId *string `field:"optional" json:"launchTemplateId" yaml:"launchTemplateId"`
// The name of the Launch Template.
//
// Exactly one of `launchTemplateId` and `launchTemplateName` may be set.
// Default: None.
//
LaunchTemplateName *string `field:"optional" json:"launchTemplateName" yaml:"launchTemplateName"`
// The version number of this launch template to use.
// Default: Version: "$Default".
//
VersionNumber *string `field:"optional" json:"versionNumber" yaml:"versionNumber"`
}
Attributes for an imported LaunchTemplate.
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"
launchTemplateAttributes := &LaunchTemplateAttributes{
LaunchTemplateId: jsii.String("launchTemplateId"),
LaunchTemplateName: jsii.String("launchTemplateName"),
VersionNumber: jsii.String("versionNumber"),
}
type LaunchTemplateHttpTokens ¶ added in v2.46.0
type LaunchTemplateHttpTokens string
The state of token usage for your instance metadata requests.
Example:
ec2.NewLaunchTemplate(this, jsii.String("LaunchTemplate"), &LaunchTemplateProps{
HttpEndpoint: jsii.Boolean(true),
HttpProtocolIpv6: jsii.Boolean(true),
HttpPutResponseHopLimit: jsii.Number(1),
HttpTokens: ec2.LaunchTemplateHttpTokens_REQUIRED,
InstanceMetadataTags: jsii.Boolean(true),
})
const ( // If the state is optional, you can choose to retrieve instance metadata with or without a signed token header on your request. LaunchTemplateHttpTokens_OPTIONAL LaunchTemplateHttpTokens = "OPTIONAL" // If the state is required, you must send a signed token header with any instance metadata retrieval requests. // // In this state, // retrieving the IAM role credentials always returns the version 2.0 credentials; the version 1.0 credentials are not available. LaunchTemplateHttpTokens_REQUIRED LaunchTemplateHttpTokens = "REQUIRED" )
type LaunchTemplateProps ¶
type LaunchTemplateProps struct {
// Whether instances should have a public IP addresses associated with them.
// Default: - Use subnet settings.
//
AssociatePublicIpAddress *bool `field:"optional" json:"associatePublicIpAddress" yaml:"associatePublicIpAddress"`
// Specifies how block devices are exposed to the instance. You can specify virtual devices and EBS volumes.
//
// Each instance that is launched has an associated root device volume,
// either an Amazon EBS volume or an instance store volume.
// You can use block device mappings to specify additional EBS volumes or
// instance store volumes to attach to an instance when it is launched.
// See: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html
//
// Default: - Uses the block device mapping of the AMI.
//
BlockDevices *[]*BlockDevice `field:"optional" json:"blockDevices" yaml:"blockDevices"`
// CPU credit type for burstable EC2 instance types.
// See: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html
//
// Default: - No credit type is specified in the Launch Template.
//
CpuCredits CpuCredits `field:"optional" json:"cpuCredits" yaml:"cpuCredits"`
// If set to true, then detailed monitoring will be enabled on instances created with this launch template.
// See: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-cloudwatch-new.html
//
// Default: False - Detailed monitoring is disabled.
//
DetailedMonitoring *bool `field:"optional" json:"detailedMonitoring" yaml:"detailedMonitoring"`
// If you set this parameter to true, you cannot terminate the instances launched with this launch template using the Amazon EC2 console, CLI, or API;
//
// otherwise, you can.
// Default: - The API termination setting is not specified in the Launch Template.
//
DisableApiTermination *bool `field:"optional" json:"disableApiTermination" yaml:"disableApiTermination"`
// Indicates whether the instances are optimized for Amazon EBS I/O.
//
// This optimization provides dedicated throughput
// to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization
// isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.
// Default: - EBS optimization is not specified in the launch template.
//
EbsOptimized *bool `field:"optional" json:"ebsOptimized" yaml:"ebsOptimized"`
// If you set this parameter to true, the instance is enabled for hibernation.
// Default: - Hibernation configuration is not specified in the launch template; defaulting to false.
//
HibernationConfigured *bool `field:"optional" json:"hibernationConfigured" yaml:"hibernationConfigured"`
// Enables or disables the HTTP metadata endpoint on your instances.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-metadataoptions.html#cfn-ec2-launchtemplate-launchtemplatedata-metadataoptions-httpendpoint
//
// Default: true.
//
HttpEndpoint *bool `field:"optional" json:"httpEndpoint" yaml:"httpEndpoint"`
// Enables or disables the IPv6 endpoint for the instance metadata service.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-metadataoptions.html#cfn-ec2-launchtemplate-launchtemplatedata-metadataoptions-httpprotocolipv6
//
// Default: true.
//
HttpProtocolIpv6 *bool `field:"optional" json:"httpProtocolIpv6" yaml:"httpProtocolIpv6"`
// The desired HTTP PUT response hop limit for instance metadata requests.
//
// The larger the number, the further instance metadata requests can travel.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-metadataoptions.html#cfn-ec2-launchtemplate-launchtemplatedata-metadataoptions-httpputresponsehoplimit
//
// Default: 1.
//
HttpPutResponseHopLimit *float64 `field:"optional" json:"httpPutResponseHopLimit" yaml:"httpPutResponseHopLimit"`
// The state of token usage for your instance metadata requests.
//
// The default state is `optional` if not specified. However,
// if requireImdsv2 is true, the state must be `required`.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-metadataoptions.html#cfn-ec2-launchtemplate-launchtemplatedata-metadataoptions-httptokens
//
// Default: LaunchTemplateHttpTokens.OPTIONAL
//
HttpTokens LaunchTemplateHttpTokens `field:"optional" json:"httpTokens" yaml:"httpTokens"`
// Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
// See: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/terminating-instances.html#Using_ChangingInstanceInitiatedShutdownBehavior
//
// Default: - Shutdown behavior is not specified in the launch template; defaults to STOP.
//
InstanceInitiatedShutdownBehavior InstanceInitiatedShutdownBehavior `field:"optional" json:"instanceInitiatedShutdownBehavior" yaml:"instanceInitiatedShutdownBehavior"`
// Set to enabled to allow access to instance tags from the instance metadata.
//
// Set to disabled to turn off access to instance tags from the instance metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-metadataoptions.html#cfn-ec2-launchtemplate-launchtemplatedata-metadataoptions-instancemetadatatags
//
// Default: false.
//
InstanceMetadataTags *bool `field:"optional" json:"instanceMetadataTags" yaml:"instanceMetadataTags"`
// The instance profile used to pass role information to EC2 instances.
//
// Note: You can provide an instanceProfile or a role, but not both.
// Default: - No instance profile.
//
InstanceProfile awsiam.IInstanceProfile `field:"optional" json:"instanceProfile" yaml:"instanceProfile"`
// Type of instance to launch.
// Default: - This Launch Template does not specify a default Instance Type.
//
InstanceType InstanceType `field:"optional" json:"instanceType" yaml:"instanceType"`
// Name of SSH keypair to grant access to instance.
// Default: - No SSH access will be possible.
//
// Deprecated: - Use `keyPair` instead - https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2-readme.html#using-an-existing-ec2-key-pair
KeyName *string `field:"optional" json:"keyName" yaml:"keyName"`
// The SSH keypair to grant access to the instance.
// Default: - No SSH access will be possible.
//
KeyPair IKeyPair `field:"optional" json:"keyPair" yaml:"keyPair"`
// Name for this launch template.
// Default: Automatically generated name.
//
LaunchTemplateName *string `field:"optional" json:"launchTemplateName" yaml:"launchTemplateName"`
// The AMI that will be used by instances.
// Default: - This Launch Template does not specify a default AMI.
//
MachineImage IMachineImage `field:"optional" json:"machineImage" yaml:"machineImage"`
// If this parameter is set to true, the instance is enabled for AWS Nitro Enclaves;
//
// otherwise, it is not enabled for AWS Nitro Enclaves.
// Default: - Enablement of Nitro enclaves is not specified in the launch template; defaulting to false.
//
NitroEnclaveEnabled *bool `field:"optional" json:"nitroEnclaveEnabled" yaml:"nitroEnclaveEnabled"`
// Whether IMDSv2 should be required on launched instances.
// Default: - false.
//
RequireImdsv2 *bool `field:"optional" json:"requireImdsv2" yaml:"requireImdsv2"`
// An IAM role to associate with the instance profile that is used by instances.
//
// The role must be assumable by the service principal `ec2.amazonaws.com`.
// Note: You can provide an instanceProfile or a role, but not both.
//
// Example:
// role := iam.NewRole(this, jsii.String("MyRole"), &RoleProps{
// AssumedBy: iam.NewServicePrincipal(jsii.String("ec2.amazonaws.com")),
// })
//
// Default: - No new role is created.
//
Role awsiam.IRole `field:"optional" json:"role" yaml:"role"`
// Security group to assign to instances created with the launch template.
// Default: No security group is assigned.
//
SecurityGroup ISecurityGroup `field:"optional" json:"securityGroup" yaml:"securityGroup"`
// If this property is defined, then the Launch Template's InstanceMarketOptions will be set to use Spot instances, and the options for the Spot instances will be as defined.
// Default: - Instance launched with this template will not be spot instances.
//
SpotOptions *LaunchTemplateSpotOptions `field:"optional" json:"spotOptions" yaml:"spotOptions"`
// The AMI that will be used by instances.
// Default: - This Launch Template creates a UserData based on the type of provided
// machineImage; no UserData is created if a machineImage is not provided.
//
UserData UserData `field:"optional" json:"userData" yaml:"userData"`
// A description for the first version of the launch template.
//
// The version description must be maximum 255 characters long.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-versiondescription
//
// Default: - No description.
//
VersionDescription *string `field:"optional" json:"versionDescription" yaml:"versionDescription"`
}
Properties of a LaunchTemplate.
Example:
var vpc vpc
sg1 := ec2.NewSecurityGroup(this, jsii.String("sg1"), &SecurityGroupProps{
Vpc: vpc,
})
sg2 := ec2.NewSecurityGroup(this, jsii.String("sg2"), &SecurityGroupProps{
Vpc: vpc,
})
launchTemplate := ec2.NewLaunchTemplate(this, jsii.String("LaunchTemplate"), &LaunchTemplateProps{
MachineImage: ec2.MachineImage_LatestAmazonLinux2023(),
SecurityGroup: sg1,
})
launchTemplate.AddSecurityGroup(sg2)
type LaunchTemplateRequireImdsv2Aspect ¶
type LaunchTemplateRequireImdsv2Aspect interface {
awscdk.IAspect
SuppressWarnings() *bool
// All aspects can visit an IConstruct.
Visit(node constructs.IConstruct)
// Adds a warning annotation to a node, unless `suppressWarnings` is true.
Warn(node constructs.IConstruct, message *string)
}
Aspect that applies IMDS configuration on EC2 Launch Template constructs.
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"
launchTemplateRequireImdsv2Aspect := awscdk.Aws_ec2.NewLaunchTemplateRequireImdsv2Aspect(&LaunchTemplateRequireImdsv2AspectProps{
SuppressWarnings: jsii.Boolean(false),
})
func NewLaunchTemplateRequireImdsv2Aspect ¶
func NewLaunchTemplateRequireImdsv2Aspect(props *LaunchTemplateRequireImdsv2AspectProps) LaunchTemplateRequireImdsv2Aspect
type LaunchTemplateRequireImdsv2AspectProps ¶
type LaunchTemplateRequireImdsv2AspectProps struct {
// Whether warning annotations from this Aspect should be suppressed or not.
// Default: - false.
//
SuppressWarnings *bool `field:"optional" json:"suppressWarnings" yaml:"suppressWarnings"`
}
Properties for `LaunchTemplateRequireImdsv2Aspect`.
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"
launchTemplateRequireImdsv2AspectProps := &LaunchTemplateRequireImdsv2AspectProps{
SuppressWarnings: jsii.Boolean(false),
}
type LaunchTemplateSpecialVersions ¶
type LaunchTemplateSpecialVersions interface {
}
A class that provides convenient access to special version tokens for LaunchTemplate versions.
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" launchTemplateSpecialVersions := awscdk.Aws_ec2.NewLaunchTemplateSpecialVersions()
func NewLaunchTemplateSpecialVersions ¶
func NewLaunchTemplateSpecialVersions() LaunchTemplateSpecialVersions
type LaunchTemplateSpotOptions ¶
type LaunchTemplateSpotOptions struct {
// Spot Instances with a defined duration (also known as Spot blocks) are designed not to be interrupted and will run continuously for the duration you select.
//
// You can use a duration of 1, 2, 3, 4, 5, or 6 hours.
// See: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-requests.html#fixed-duration-spot-instances
//
// Default: Requested spot instances do not have a pre-defined duration.
//
BlockDuration awscdk.Duration `field:"optional" json:"blockDuration" yaml:"blockDuration"`
// The behavior when a Spot Instance is interrupted.
// Default: Spot instances will terminate when interrupted.
//
InterruptionBehavior SpotInstanceInterruption `field:"optional" json:"interruptionBehavior" yaml:"interruptionBehavior"`
// Maximum hourly price you're willing to pay for each Spot instance.
//
// The value is given
// in dollars. ex: 0.01 for 1 cent per hour, or 0.001 for one-tenth of a cent per hour.
// Default: Maximum hourly price will default to the on-demand price for the instance type.
//
MaxPrice *float64 `field:"optional" json:"maxPrice" yaml:"maxPrice"`
// The Spot Instance request type.
//
// If you are using Spot Instances with an Auto Scaling group, use one-time requests, as the
// Amazon EC2 Auto Scaling service handles requesting new Spot Instances whenever the group is
// below its desired capacity.
// Default: One-time spot request.
//
RequestType SpotRequestType `field:"optional" json:"requestType" yaml:"requestType"`
// The end date of the request.
//
// For a one-time request, the request remains active until all instances
// launch, the request is canceled, or this date is reached. If the request is persistent, it remains
// active until it is canceled or this date and time is reached.
// Default: The default end date is 7 days from the current date.
//
ValidUntil awscdk.Expiration `field:"optional" json:"validUntil" yaml:"validUntil"`
}
Interface for the Spot market instance options provided in a LaunchTemplate.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
var expiration expiration
launchTemplateSpotOptions := &LaunchTemplateSpotOptions{
BlockDuration: cdk.Duration_Minutes(jsii.Number(30)),
InterruptionBehavior: awscdk.Aws_ec2.SpotInstanceInterruption_STOP,
MaxPrice: jsii.Number(123),
RequestType: awscdk.*Aws_ec2.SpotRequestType_ONE_TIME,
ValidUntil: expiration,
}
type LinuxUserDataOptions ¶
type LinuxUserDataOptions struct {
// Shebang for the UserData script.
// Default: "#!/bin/bash"
//
Shebang *string `field:"optional" json:"shebang" yaml:"shebang"`
}
Options when constructing UserData for Linux.
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"
linuxUserDataOptions := &LinuxUserDataOptions{
Shebang: jsii.String("shebang"),
}
type LocationPackageOptions ¶
type LocationPackageOptions struct {
// Identifier key for this package.
//
// You can use this to order package installs.
// Default: - Automatically generated.
//
Key *string `field:"optional" json:"key" yaml:"key"`
// Restart the given service after this command has run.
// Default: - Do not restart any service.
//
ServiceRestartHandles *[]InitServiceRestartHandle `field:"optional" json:"serviceRestartHandles" yaml:"serviceRestartHandles"`
}
Options for InitPackage.rpm/InitPackage.msi.
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"
var initServiceRestartHandle initServiceRestartHandle
locationPackageOptions := &LocationPackageOptions{
Key: jsii.String("key"),
ServiceRestartHandles: []*initServiceRestartHandle{
initServiceRestartHandle,
},
}
type LogFormat ¶ added in v2.51.0
type LogFormat interface {
Value() *string
}
The following table describes all of the available fields for a flow log record.
Example:
vpc := ec2.NewVpc(this, jsii.String("Vpc"))
vpc.addFlowLog(jsii.String("FlowLog"), &FlowLogOptions{
LogFormat: []logFormat{
ec2.*logFormat_DST_PORT(),
ec2.*logFormat_SRC_PORT(),
},
})
// If you just want to add a field to the default field
vpc.addFlowLog(jsii.String("FlowLog"), &FlowLogOptions{
LogFormat: []*logFormat{
ec2.*logFormat_VERSION(),
ec2.*logFormat_ALL_DEFAULT_FIELDS(),
},
})
// If AWS CDK does not support the new fields
vpc.addFlowLog(jsii.String("FlowLog"), &FlowLogOptions{
LogFormat: []*logFormat{
ec2.*logFormat_SRC_PORT(),
ec2.*logFormat_Custom(jsii.String("${new-field}")),
},
})
func LogFormat_ACCOUNT_ID ¶ added in v2.51.0
func LogFormat_ACCOUNT_ID() LogFormat
func LogFormat_ACTION ¶ added in v2.72.0
func LogFormat_ACTION() LogFormat
func LogFormat_ALL_DEFAULT_FIELDS ¶ added in v2.51.0
func LogFormat_ALL_DEFAULT_FIELDS() LogFormat
func LogFormat_AZ_ID ¶ added in v2.51.0
func LogFormat_AZ_ID() LogFormat
func LogFormat_BYTES ¶ added in v2.51.0
func LogFormat_BYTES() LogFormat
func LogFormat_Custom ¶ added in v2.51.0
A custom format string.
Gives full control over the format string fragment.
func LogFormat_DST_ADDR ¶ added in v2.51.0
func LogFormat_DST_ADDR() LogFormat
func LogFormat_DST_PORT ¶ added in v2.51.0
func LogFormat_DST_PORT() LogFormat
func LogFormat_ECS_CLUSTER_ARN ¶ added in v2.151.0
func LogFormat_ECS_CLUSTER_ARN() LogFormat
func LogFormat_ECS_CLUSTER_NAME ¶ added in v2.151.0
func LogFormat_ECS_CLUSTER_NAME() LogFormat
func LogFormat_ECS_CONTAINER_ID ¶ added in v2.151.0
func LogFormat_ECS_CONTAINER_ID() LogFormat
func LogFormat_ECS_CONTAINER_INSTANCE_ARN ¶ added in v2.151.0
func LogFormat_ECS_CONTAINER_INSTANCE_ARN() LogFormat
func LogFormat_ECS_CONTAINER_INSTANCE_ID ¶ added in v2.151.0
func LogFormat_ECS_CONTAINER_INSTANCE_ID() LogFormat
func LogFormat_ECS_SECOND_CONTAINER_ID ¶ added in v2.151.0
func LogFormat_ECS_SECOND_CONTAINER_ID() LogFormat
func LogFormat_ECS_SERVICE_NAME ¶ added in v2.151.0
func LogFormat_ECS_SERVICE_NAME() LogFormat
func LogFormat_ECS_TASK_ARN ¶ added in v2.151.0
func LogFormat_ECS_TASK_ARN() LogFormat
func LogFormat_ECS_TASK_DEFINITION_ARN ¶ added in v2.151.0
func LogFormat_ECS_TASK_DEFINITION_ARN() LogFormat
func LogFormat_ECS_TASK_ID ¶ added in v2.151.0
func LogFormat_ECS_TASK_ID() LogFormat
func LogFormat_END_TIMESTAMP ¶ added in v2.72.0
func LogFormat_END_TIMESTAMP() LogFormat
func LogFormat_FLOW_DIRECTION ¶ added in v2.51.0
func LogFormat_FLOW_DIRECTION() LogFormat
func LogFormat_Field ¶ added in v2.51.0
A custom field name.
If there is no ready-made constant for a new field yet, you can use this. The field name will automatically be wrapped in `${ ... }`.
func LogFormat_INSTANCE_ID ¶ added in v2.72.0
func LogFormat_INSTANCE_ID() LogFormat
func LogFormat_INTERFACE_ID ¶ added in v2.51.0
func LogFormat_INTERFACE_ID() LogFormat
func LogFormat_LOG_STATUS ¶ added in v2.72.0
func LogFormat_LOG_STATUS() LogFormat
func LogFormat_PACKETS ¶ added in v2.51.0
func LogFormat_PACKETS() LogFormat
func LogFormat_PKT_DST_ADDR ¶ added in v2.51.0
func LogFormat_PKT_DST_ADDR() LogFormat
func LogFormat_PKT_DST_AWS_SERVICE ¶ added in v2.51.0
func LogFormat_PKT_DST_AWS_SERVICE() LogFormat
func LogFormat_PKT_SRC_ADDR ¶ added in v2.51.0
func LogFormat_PKT_SRC_ADDR() LogFormat
func LogFormat_PKT_SRC_AWS_SERVICE ¶ added in v2.51.0
func LogFormat_PKT_SRC_AWS_SERVICE() LogFormat
func LogFormat_PROTOCOL ¶ added in v2.51.0
func LogFormat_PROTOCOL() LogFormat
func LogFormat_REGION ¶ added in v2.51.0
func LogFormat_REGION() LogFormat
func LogFormat_SRC_ADDR ¶ added in v2.51.0
func LogFormat_SRC_ADDR() LogFormat
func LogFormat_SRC_PORT ¶ added in v2.51.0
func LogFormat_SRC_PORT() LogFormat
func LogFormat_START_TIMESTAMP ¶ added in v2.72.0
func LogFormat_START_TIMESTAMP() LogFormat
func LogFormat_SUBLOCATION_ID ¶ added in v2.51.0
func LogFormat_SUBLOCATION_ID() LogFormat
func LogFormat_SUBLOCATION_TYPE ¶ added in v2.51.0
func LogFormat_SUBLOCATION_TYPE() LogFormat
func LogFormat_SUBNET_ID ¶ added in v2.72.0
func LogFormat_SUBNET_ID() LogFormat
func LogFormat_TCP_FLAGS ¶ added in v2.72.0
func LogFormat_TCP_FLAGS() LogFormat
func LogFormat_TRAFFIC_PATH ¶ added in v2.51.0
func LogFormat_TRAFFIC_PATH() LogFormat
func LogFormat_TRAFFIC_TYPE ¶ added in v2.72.0
func LogFormat_TRAFFIC_TYPE() LogFormat
func LogFormat_VERSION ¶ added in v2.51.0
func LogFormat_VERSION() LogFormat
func LogFormat_VPC_ID ¶ added in v2.72.0
func LogFormat_VPC_ID() LogFormat
func NewLogFormat ¶ added in v2.51.0
type LookupMachineImage ¶
type LookupMachineImage interface {
IMachineImage
// Return the image to use in the given context.
GetImage(scope constructs.Construct) *MachineImageConfig
}
A machine image whose AMI ID will be searched using DescribeImages.
The most recent, available, launchable image matching the given filter criteria will be used. Looking up AMIs may take a long time; specify as many filter criteria as possible to narrow down the search.
The AMI selected will be cached in `cdk.context.json` and the same value will be used on future runs. To refresh the AMI lookup, you will have to evict the value from the cache using the `cdk context` command. See https://docs.aws.amazon.com/cdk/latest/guide/context.html for more information.
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"
var userData userData
lookupMachineImage := awscdk.Aws_ec2.NewLookupMachineImage(&LookupMachineImageProps{
Name: jsii.String("name"),
// the properties below are optional
Filters: map[string][]*string{
"filtersKey": []*string{
jsii.String("filters"),
},
},
Owners: []*string{
jsii.String("owners"),
},
UserData: userData,
Windows: jsii.Boolean(false),
})
func NewLookupMachineImage ¶
func NewLookupMachineImage(props *LookupMachineImageProps) LookupMachineImage
type LookupMachineImageProps ¶
type LookupMachineImageProps struct {
// Name of the image (may contain wildcards).
Name *string `field:"required" json:"name" yaml:"name"`
// Additional filters on the AMI.
// See: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeImages.html
//
// Default: - No additional filters.
//
Filters *map[string]*[]*string `field:"optional" json:"filters" yaml:"filters"`
// Owner account IDs or aliases.
// Default: - All owners.
//
Owners *[]*string `field:"optional" json:"owners" yaml:"owners"`
// Custom userdata for this image.
// Default: - Empty user data appropriate for the platform type.
//
UserData UserData `field:"optional" json:"userData" yaml:"userData"`
// Look for Windows images.
// Default: false.
//
Windows *bool `field:"optional" json:"windows" yaml:"windows"`
}
Properties for looking up an image.
Example:
// Pick the right Amazon Linux edition. All arguments shown are optional
// and will default to these values when omitted.
amznLinux := ec2.MachineImage_LatestAmazonLinux(&AmazonLinuxImageProps{
Generation: ec2.AmazonLinuxGeneration_AMAZON_LINUX,
Edition: ec2.AmazonLinuxEdition_STANDARD,
Virtualization: ec2.AmazonLinuxVirt_HVM,
Storage: ec2.AmazonLinuxStorage_GENERAL_PURPOSE,
CpuType: ec2.AmazonLinuxCpuType_X86_64,
})
// Pick a Windows edition to use
windows := ec2.MachineImage_LatestWindows(ec2.WindowsVersion_WINDOWS_SERVER_2019_ENGLISH_FULL_BASE)
// Read AMI id from SSM parameter store
ssm := ec2.MachineImage_FromSsmParameter(jsii.String("/my/ami"), &SsmParameterImageOptions{
Os: ec2.OperatingSystemType_LINUX,
})
// Look up the most recent image matching a set of AMI filters.
// In this case, look up the NAT instance AMI, by using a wildcard
// in the 'name' field:
natAmi := ec2.MachineImage_Lookup(&LookupMachineImageProps{
Name: jsii.String("amzn-ami-vpc-nat-*"),
Owners: []*string{
jsii.String("amazon"),
},
})
// For other custom (Linux) images, instantiate a `GenericLinuxImage` with
// a map giving the AMI to in for each region:
linux := ec2.MachineImage_GenericLinux(map[string]*string{
"us-east-1": jsii.String("ami-97785bed"),
"eu-west-1": jsii.String("ami-12345678"),
})
// For other custom (Windows) images, instantiate a `GenericWindowsImage` with
// a map giving the AMI to in for each region:
genericWindows := ec2.MachineImage_GenericWindows(map[string]*string{
"us-east-1": jsii.String("ami-97785bed"),
"eu-west-1": jsii.String("ami-12345678"),
})
type MachineImage ¶
type MachineImage interface {
}
Factory functions for standard Amazon Machine Image objects.
Example:
var vpc vpc
mySecurityGroup := ec2.NewSecurityGroup(this, jsii.String("SecurityGroup"), &SecurityGroupProps{
Vpc: Vpc,
})
autoscaling.NewAutoScalingGroup(this, jsii.String("ASG"), &AutoScalingGroupProps{
Vpc: Vpc,
InstanceType: ec2.InstanceType_Of(ec2.InstanceClass_BURSTABLE2, ec2.InstanceSize_MICRO),
MachineImage: ec2.MachineImage_LatestAmazonLinux2(),
SecurityGroup: mySecurityGroup,
})
type MachineImageConfig ¶
type MachineImageConfig struct {
// The AMI ID of the image to use.
ImageId *string `field:"required" json:"imageId" yaml:"imageId"`
// Operating system type for this image.
OsType OperatingSystemType `field:"required" json:"osType" yaml:"osType"`
// Initial UserData for this image.
UserData UserData `field:"required" json:"userData" yaml:"userData"`
}
Configuration for a machine image.
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"
var userData userData
machineImageConfig := &MachineImageConfig{
ImageId: jsii.String("imageId"),
OsType: awscdk.Aws_ec2.OperatingSystemType_LINUX,
UserData: userData,
}
type MultipartBody ¶
type MultipartBody interface {
// Render body part as the string.
//
// Subclasses should not add leading nor trailing new line characters (\r \n).
RenderBodyPart() *[]*string
}
The base class for all classes which can be used as `MultipartUserData`.
Example:
multipartUserData := ec2.NewMultipartUserData()
commandsUserData := ec2.UserData_ForLinux()
multipartUserData.AddUserDataPart(commandsUserData, ec2.MultipartBody_SHELL_SCRIPT(), jsii.Boolean(true))
// Adding commands to the multipartUserData adds them to commandsUserData, and vice-versa.
multipartUserData.AddCommands(jsii.String("touch /root/multi.txt"))
commandsUserData.AddCommands(jsii.String("touch /root/userdata.txt"))
func MultipartBody_FromRawBody ¶
func MultipartBody_FromRawBody(opts *MultipartBodyOptions) MultipartBody
Constructs the raw `MultipartBody` using specified body, content type and transfer encoding.
When transfer encoding is specified (typically as Base64), it's caller responsibility to convert body to Base64 either by wrapping with `Fn.base64` or by converting it by other converters.
func MultipartBody_FromUserData ¶
func MultipartBody_FromUserData(userData UserData, contentType *string) MultipartBody
Constructs the new `MultipartBody` wrapping existing `UserData`. Modification to `UserData` are reflected in subsequent renders of the part.
For more information about content types see `MultipartBodyOptions.contentType`.
type MultipartBodyOptions ¶
type MultipartBodyOptions struct {
// `Content-Type` header of this part.
//
// Some examples of content types:
// * `text/x-shellscript; charset="utf-8"` (shell script)
// * `text/cloud-boothook; charset="utf-8"` (shell script executed during boot phase)
//
// For Linux shell scripts use `text/x-shellscript`.
ContentType *string `field:"required" json:"contentType" yaml:"contentType"`
// The body of message.
// Default: undefined - body will not be added to part.
//
Body *string `field:"optional" json:"body" yaml:"body"`
// `Content-Transfer-Encoding` header specifying part encoding.
// Default: undefined - body is not encoded.
//
TransferEncoding *string `field:"optional" json:"transferEncoding" yaml:"transferEncoding"`
}
Options when creating `MultipartBody`.
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"
multipartBodyOptions := &MultipartBodyOptions{
ContentType: jsii.String("contentType"),
// the properties below are optional
Body: jsii.String("body"),
TransferEncoding: jsii.String("transferEncoding"),
}
type MultipartUserData ¶
type MultipartUserData interface {
UserData
// Add one or more commands to the user data.
AddCommands(commands ...*string)
// Adds commands to execute a file.
AddExecuteFileCommand(params *ExecuteFileOptions)
// Add one or more commands to the user data that will run when the script exits.
AddOnExitCommands(commands ...*string)
// Adds a part to the list of parts.
AddPart(part MultipartBody)
// Adds commands to download a file from S3.
AddS3DownloadCommand(params *S3DownloadOptions) *string
// Adds a command which will send a cfn-signal when the user data script ends.
AddSignalOnExitCommand(resource awscdk.Resource)
// Adds a multipart part based on a UserData object.
//
// If `makeDefault` is true, then the UserData added by this method
// will also be the target of calls to the `add*Command` methods on
// this MultipartUserData object.
//
// If `makeDefault` is false, then this is the same as calling:
//
// “`ts
// declare const multiPart: ec2.MultipartUserData;
// declare const userData: ec2.UserData;
// declare const contentType: string;
//
// multiPart.addPart(ec2.MultipartBody.fromUserData(userData, contentType));
// “`
//
// An undefined `makeDefault` defaults to either:
// - `true` if no default UserData has been set yet; or
// - `false` if there is no default UserData set.
AddUserDataPart(userData UserData, contentType *string, makeDefault *bool)
// Render the UserData for use in a construct.
Render() *string
}
Mime multipart user data.
This class represents MIME multipart user data, as described in. [Specifying Multiple User Data Blocks Using a MIME Multi Part Archive](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/bootstrap_container_instance.html#multi-part_user_data)
Example:
bootHookConf := ec2.UserData_ForLinux()
bootHookConf.AddCommands(jsii.String("cloud-init-per once docker_options echo 'OPTIONS=\"${OPTIONS} --storage-opt dm.basesize=40G\"' >> /etc/sysconfig/docker"))
setupCommands := ec2.UserData_ForLinux()
setupCommands.AddCommands(jsii.String("sudo yum install awscli && echo Packages installed らと > /var/tmp/setup"))
multipartUserData := ec2.NewMultipartUserData()
// The docker has to be configured at early stage, so content type is overridden to boothook
multipartUserData.AddPart(ec2.MultipartBody_FromUserData(bootHookConf, jsii.String("text/cloud-boothook; charset=\"us-ascii\"")))
// Execute the rest of setup
multipartUserData.AddPart(ec2.MultipartBody_FromUserData(setupCommands))
ec2.NewLaunchTemplate(this, jsii.String(""), &LaunchTemplateProps{
UserData: multipartUserData,
BlockDevices: []blockDevice{
},
})
func NewMultipartUserData ¶
func NewMultipartUserData(opts *MultipartUserDataOptions) MultipartUserData
type MultipartUserDataOptions ¶
type MultipartUserDataOptions struct {
// The string used to separate parts in multipart user data archive (it's like MIME boundary).
//
// This string should contain [a-zA-Z0-9()+,-./:=?] characters only, and should not be present in any part, or in text content of archive.
// Default: `+AWS+CDK+User+Data+Separator==`.
//
PartsSeparator *string `field:"optional" json:"partsSeparator" yaml:"partsSeparator"`
}
Options for creating `MultipartUserData`.
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"
multipartUserDataOptions := &MultipartUserDataOptions{
PartsSeparator: jsii.String("partsSeparator"),
}
type NamedPackageOptions ¶
type NamedPackageOptions struct {
// Restart the given services after this command has run.
// Default: - Do not restart any service.
//
ServiceRestartHandles *[]InitServiceRestartHandle `field:"optional" json:"serviceRestartHandles" yaml:"serviceRestartHandles"`
// Specify the versions to install.
// Default: - Install the latest version.
//
Version *[]*string `field:"optional" json:"version" yaml:"version"`
}
Options for InitPackage.yum/apt/rubyGem/python.
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"
var initServiceRestartHandle initServiceRestartHandle
namedPackageOptions := &NamedPackageOptions{
ServiceRestartHandles: []*initServiceRestartHandle{
initServiceRestartHandle,
},
Version: []*string{
jsii.String("version"),
},
}
type NatGatewayProps ¶
type NatGatewayProps struct {
// EIP allocation IDs for the NAT gateways.
// Default: - No fixed EIPs allocated for the NAT gateways.
//
EipAllocationIds *[]*string `field:"optional" json:"eipAllocationIds" yaml:"eipAllocationIds"`
}
Properties for a NAT gateway.
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"
natGatewayProps := &NatGatewayProps{
EipAllocationIds: []*string{
jsii.String("eipAllocationIds"),
},
}
type NatGatewayProvider ¶ added in v2.151.0
type NatGatewayProvider interface {
NatProvider
// Return list of gateways spawned by the provider.
ConfiguredGateways() *[]*GatewayConfig
// Called by the VPC to configure NAT.
//
// Don't call this directly, the VPC will call it automatically.
ConfigureNat(options *ConfigureNatOptions)
// Configures subnet with the gateway.
//
// Don't call this directly, the VPC will call it automatically.
ConfigureSubnet(subnet PrivateSubnet)
}
Provider for NAT Gateways.
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"
natGatewayProvider := awscdk.Aws_ec2.NewNatGatewayProvider(&NatGatewayProps{
EipAllocationIds: []*string{
jsii.String("eipAllocationIds"),
},
})
func NewNatGatewayProvider ¶ added in v2.151.0
func NewNatGatewayProvider(props *NatGatewayProps) NatGatewayProvider
type NatInstanceImage ¶
type NatInstanceImage interface {
LookupMachineImage
// Return the image to use in the given context.
GetImage(scope constructs.Construct) *MachineImageConfig
}
Machine image representing the latest NAT instance image.
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" natInstanceImage := awscdk.Aws_ec2.NewNatInstanceImage()
func NewNatInstanceImage ¶
func NewNatInstanceImage() NatInstanceImage
type NatInstanceProps ¶
type NatInstanceProps struct {
// Instance type of the NAT instance.
InstanceType InstanceType `field:"required" json:"instanceType" yaml:"instanceType"`
// Specifying the CPU credit type for burstable EC2 instance types (T2, T3, T3a, etc).
//
// The unlimited CPU credit option is not supported for T3 instances with dedicated host (`host`) tenancy.
// Default: - T2 instances are standard, while T3, T4g, and T3a instances are unlimited.
//
CreditSpecification CpuCredits `field:"optional" json:"creditSpecification" yaml:"creditSpecification"`
// Direction to allow all traffic through the NAT instance by default.
//
// By default, inbound and outbound traffic is allowed.
//
// If you set this to another value than INBOUND_AND_OUTBOUND, you must
// configure the NAT instance's security groups in another way, either by
// passing in a fully configured Security Group using the `securityGroup`
// property, or by configuring it using the `.securityGroup` or
// `.connections` members after passing the NAT Instance Provider to a Vpc.
// Default: NatTrafficDirection.INBOUND_AND_OUTBOUND
//
DefaultAllowedTraffic NatTrafficDirection `field:"optional" json:"defaultAllowedTraffic" yaml:"defaultAllowedTraffic"`
// Name of SSH keypair to grant access to instance.
// Default: - No SSH access will be possible.
//
// Deprecated: - Use `keyPair` instead - https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2-readme.html#using-an-existing-ec2-key-pair
KeyName *string `field:"optional" json:"keyName" yaml:"keyName"`
// The SSH keypair to grant access to the instance.
// Default: - No SSH access will be possible.
//
KeyPair IKeyPair `field:"optional" json:"keyPair" yaml:"keyPair"`
// The machine image (AMI) to use.
//
// By default, will do an AMI lookup for the latest NAT instance image.
//
// If you have a specific AMI ID you want to use, pass a `GenericLinuxImage`. For example:
//
// “`ts
// ec2.NatProvider.instance({
// instanceType: new ec2.InstanceType('t3.micro'),
// machineImage: new ec2.GenericLinuxImage({
// 'us-east-2': 'ami-0f9c61b5a562a16af'
// })
// })
// “`.
// Default: - Latest NAT instance image.
//
MachineImage IMachineImage `field:"optional" json:"machineImage" yaml:"machineImage"`
// Security Group for NAT instances.
//
// Example:
// natGatewayProvider := ec2.NatProvider_InstanceV2(&NatInstanceProps{
// InstanceType: ec2.NewInstanceType(jsii.String("t3.small")),
// DefaultAllowedTraffic: ec2.NatTrafficDirection_NONE,
// })
// vpc := ec2.NewVpc(this, jsii.String("Vpc"), &VpcProps{
// NatGatewayProvider: NatGatewayProvider,
// })
//
// securityGroup := ec2.NewSecurityGroup(this, jsii.String("SecurityGroup"), &SecurityGroupProps{
// Vpc: Vpc,
// AllowAllOutbound: jsii.Boolean(false),
// })
// securityGroup.AddEgressRule(ec2.Peer_AnyIpv4(), ec2.Port_Tcp(jsii.Number(443)))
// for _, gatewayInstance := range natGatewayProvider.gatewayInstances {
// gatewayInstance.AddSecurityGroup(securityGroup)
// }
//
// Default: - A new security group will be created.
//
// Deprecated: - Cannot create a new security group before the VPC is created,
// and cannot create the VPC without the NAT provider.
// Set {@link defaultAllowedTraffic } to {@link NatTrafficDirection.NONE }
// and use {@link NatInstanceProviderV2.gatewayInstances } to retrieve
// the instances on the fly and add security groups.
SecurityGroup ISecurityGroup `field:"optional" json:"securityGroup" yaml:"securityGroup"`
// Custom user data to run on the NAT instances.
// See: https://docs.aws.amazon.com/vpc/latest/userguide/VPC_NAT_Instance.html#create-nat-ami
//
// Default: UserData.forLinux().addCommands(...NatInstanceProviderV2.DEFAULT_USER_DATA_COMMANDS); - Appropriate user data commands to initialize and configure the NAT instances
//
UserData UserData `field:"optional" json:"userData" yaml:"userData"`
}
Properties for a NAT instance.
Example:
var instanceType instanceType
provider := ec2.NatProvider_InstanceV2(&NatInstanceProps{
InstanceType: InstanceType,
DefaultAllowedTraffic: ec2.NatTrafficDirection_OUTBOUND_ONLY,
})
ec2.NewVpc(this, jsii.String("TheVPC"), &VpcProps{
NatGatewayProvider: provider,
})
provider.connections.AllowFrom(ec2.Peer_Ipv4(jsii.String("1.2.3.4/8")), ec2.Port_HTTP())
type NatInstanceProvider
deprecated
type NatInstanceProvider interface {
NatProvider
IConnectable
// Return list of gateways spawned by the provider.
// Deprecated: use NatInstanceProviderV2. NatInstanceProvider is deprecated since
// the instance image used has reached EOL on Dec 31 2023.
ConfiguredGateways() *[]*GatewayConfig
// Manage the Security Groups associated with the NAT instances.
// Deprecated: use NatInstanceProviderV2. NatInstanceProvider is deprecated since
// the instance image used has reached EOL on Dec 31 2023.
Connections() Connections
// The Security Group associated with the NAT instances.
// Deprecated: use NatInstanceProviderV2. NatInstanceProvider is deprecated since
// the instance image used has reached EOL on Dec 31 2023.
SecurityGroup() ISecurityGroup
// Called by the VPC to configure NAT.
//
// Don't call this directly, the VPC will call it automatically.
// Deprecated: use NatInstanceProviderV2. NatInstanceProvider is deprecated since
// the instance image used has reached EOL on Dec 31 2023.
ConfigureNat(options *ConfigureNatOptions)
// Configures subnet with the gateway.
//
// Don't call this directly, the VPC will call it automatically.
// Deprecated: use NatInstanceProviderV2. NatInstanceProvider is deprecated since
// the instance image used has reached EOL on Dec 31 2023.
ConfigureSubnet(subnet PrivateSubnet)
}
NAT provider which uses NAT Instances.
Example:
natInstanceProvider := ec2.NatProvider_Instance(&NatInstanceProps{
InstanceType: ec2.InstanceType_Of(ec2.InstanceClass_T4G, ec2.InstanceSize_LARGE),
MachineImage: ec2.NewAmazonLinuxImage(),
CreditSpecification: ec2.CpuCredits_UNLIMITED,
})
ec2.NewVpc(this, jsii.String("VPC"), &VpcProps{
NatGatewayProvider: natInstanceProvider,
})
Deprecated: use NatInstanceProviderV2. NatInstanceProvider is deprecated since the instance image used has reached EOL on Dec 31 2023.
func NatGatewayProvider_Instance
deprecated
added in
v2.151.0
func NatGatewayProvider_Instance(props *NatInstanceProps) NatInstanceProvider
Use NAT instances to provide NAT services for your VPC.
NAT instances are managed by you, but in return allow more configuration.
Be aware that instances created using this provider will not be automatically replaced if they are stopped for any reason. You should implement your own NatProvider based on AutoScaling groups if you need that. See: https://docs.aws.amazon.com/vpc/latest/userguide/VPC_NAT_Instance.html
Deprecated: use instanceV2. 'instance' is deprecated since NatInstanceProvider uses a instance image that has reached EOL on Dec 31 2023.
func NatInstanceProviderV2_Instance
deprecated
added in
v2.132.0
func NatInstanceProviderV2_Instance(props *NatInstanceProps) NatInstanceProvider
Use NAT instances to provide NAT services for your VPC.
NAT instances are managed by you, but in return allow more configuration.
Be aware that instances created using this provider will not be automatically replaced if they are stopped for any reason. You should implement your own NatProvider based on AutoScaling groups if you need that. See: https://docs.aws.amazon.com/vpc/latest/userguide/VPC_NAT_Instance.html
Deprecated: use instanceV2. 'instance' is deprecated since NatInstanceProvider uses a instance image that has reached EOL on Dec 31 2023.
func NatInstanceProvider_Instance
deprecated
func NatInstanceProvider_Instance(props *NatInstanceProps) NatInstanceProvider
Use NAT instances to provide NAT services for your VPC.
NAT instances are managed by you, but in return allow more configuration.
Be aware that instances created using this provider will not be automatically replaced if they are stopped for any reason. You should implement your own NatProvider based on AutoScaling groups if you need that. See: https://docs.aws.amazon.com/vpc/latest/userguide/VPC_NAT_Instance.html
Deprecated: use instanceV2. 'instance' is deprecated since NatInstanceProvider uses a instance image that has reached EOL on Dec 31 2023.
func NatProvider_Instance
deprecated
func NatProvider_Instance(props *NatInstanceProps) NatInstanceProvider
Use NAT instances to provide NAT services for your VPC.
NAT instances are managed by you, but in return allow more configuration.
Be aware that instances created using this provider will not be automatically replaced if they are stopped for any reason. You should implement your own NatProvider based on AutoScaling groups if you need that. See: https://docs.aws.amazon.com/vpc/latest/userguide/VPC_NAT_Instance.html
Deprecated: use instanceV2. 'instance' is deprecated since NatInstanceProvider uses a instance image that has reached EOL on Dec 31 2023.
func NewNatInstanceProvider
deprecated
func NewNatInstanceProvider(props *NatInstanceProps) NatInstanceProvider
Deprecated: use NatInstanceProviderV2. NatInstanceProvider is deprecated since the instance image used has reached EOL on Dec 31 2023.
type NatInstanceProviderV2 ¶ added in v2.132.0
type NatInstanceProviderV2 interface {
NatProvider
IConnectable
// Return list of gateways spawned by the provider.
ConfiguredGateways() *[]*GatewayConfig
// Manage the Security Groups associated with the NAT instances.
Connections() Connections
// Array of gateway instances spawned by the provider after internal configuration.
GatewayInstances() *[]Instance
// The Security Group associated with the NAT instances.
SecurityGroup() ISecurityGroup
// Called by the VPC to configure NAT.
//
// Don't call this directly, the VPC will call it automatically.
ConfigureNat(options *ConfigureNatOptions)
// Configures subnet with the gateway.
//
// Don't call this directly, the VPC will call it automatically.
ConfigureSubnet(subnet PrivateSubnet)
}
Modern NAT provider which uses NAT Instances.
The instance uses Amazon Linux 2023 as the operating system.
Example:
natGatewayProvider := ec2.NatProvider_InstanceV2(&NatInstanceProps{
InstanceType: ec2.NewInstanceType(jsii.String("t3.small")),
DefaultAllowedTraffic: ec2.NatTrafficDirection_NONE,
})
vpc := ec2.NewVpc(this, jsii.String("Vpc"), &VpcProps{
NatGatewayProvider: NatGatewayProvider,
})
securityGroup := ec2.NewSecurityGroup(this, jsii.String("SecurityGroup"), &SecurityGroupProps{
Vpc: Vpc,
AllowAllOutbound: jsii.Boolean(false),
})
securityGroup.AddEgressRule(ec2.Peer_AnyIpv4(), ec2.Port_Tcp(jsii.Number(443)))
for _, gatewayInstance := range natGatewayProvider.gatewayInstances {
gatewayInstance.AddSecurityGroup(securityGroup)
}
func NatGatewayProvider_InstanceV2 ¶ added in v2.151.0
func NatGatewayProvider_InstanceV2(props *NatInstanceProps) NatInstanceProviderV2
Use NAT instances to provide NAT services for your VPC.
NAT instances are managed by you, but in return allow more configuration.
Be aware that instances created using this provider will not be automatically replaced if they are stopped for any reason. You should implement your own NatProvider based on AutoScaling groups if you need that. See: https://docs.aws.amazon.com/vpc/latest/userguide/VPC_NAT_Instance.html
func NatInstanceProviderV2_InstanceV2 ¶ added in v2.132.0
func NatInstanceProviderV2_InstanceV2(props *NatInstanceProps) NatInstanceProviderV2
Use NAT instances to provide NAT services for your VPC.
NAT instances are managed by you, but in return allow more configuration.
Be aware that instances created using this provider will not be automatically replaced if they are stopped for any reason. You should implement your own NatProvider based on AutoScaling groups if you need that. See: https://docs.aws.amazon.com/vpc/latest/userguide/VPC_NAT_Instance.html
func NatInstanceProvider_InstanceV2
deprecated
added in
v2.132.0
func NatInstanceProvider_InstanceV2(props *NatInstanceProps) NatInstanceProviderV2
Use NAT instances to provide NAT services for your VPC.
NAT instances are managed by you, but in return allow more configuration.
Be aware that instances created using this provider will not be automatically replaced if they are stopped for any reason. You should implement your own NatProvider based on AutoScaling groups if you need that. See: https://docs.aws.amazon.com/vpc/latest/userguide/VPC_NAT_Instance.html
Deprecated: use NatInstanceProviderV2. NatInstanceProvider is deprecated since the instance image used has reached EOL on Dec 31 2023.
func NatProvider_InstanceV2 ¶ added in v2.132.0
func NatProvider_InstanceV2(props *NatInstanceProps) NatInstanceProviderV2
Use NAT instances to provide NAT services for your VPC.
NAT instances are managed by you, but in return allow more configuration.
Be aware that instances created using this provider will not be automatically replaced if they are stopped for any reason. You should implement your own NatProvider based on AutoScaling groups if you need that. See: https://docs.aws.amazon.com/vpc/latest/userguide/VPC_NAT_Instance.html
func NewNatInstanceProviderV2 ¶ added in v2.132.0
func NewNatInstanceProviderV2(props *NatInstanceProps) NatInstanceProviderV2
type NatProvider ¶
type NatProvider interface {
// Return list of gateways spawned by the provider.
ConfiguredGateways() *[]*GatewayConfig
// Called by the VPC to configure NAT.
//
// Don't call this directly, the VPC will call it automatically.
ConfigureNat(options *ConfigureNatOptions)
// Configures subnet with the gateway.
//
// Don't call this directly, the VPC will call it automatically.
ConfigureSubnet(subnet PrivateSubnet)
}
NAT providers.
Determines what type of NAT provider to create, either NAT gateways or NAT instance.
Example:
var instanceType instanceType
provider := ec2.NatProvider_InstanceV2(&NatInstanceProps{
InstanceType: InstanceType,
DefaultAllowedTraffic: ec2.NatTrafficDirection_OUTBOUND_ONLY,
})
ec2.NewVpc(this, jsii.String("TheVPC"), &VpcProps{
NatGatewayProvider: provider,
})
provider.connections.AllowFrom(ec2.Peer_Ipv4(jsii.String("1.2.3.4/8")), ec2.Port_HTTP())
func NatGatewayProvider_Gateway ¶ added in v2.151.0
func NatGatewayProvider_Gateway(props *NatGatewayProps) NatProvider
Use NAT Gateways to provide NAT services for your VPC.
NAT gateways are managed by AWS. See: https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html
func NatInstanceProviderV2_Gateway ¶ added in v2.132.0
func NatInstanceProviderV2_Gateway(props *NatGatewayProps) NatProvider
Use NAT Gateways to provide NAT services for your VPC.
NAT gateways are managed by AWS. See: https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html
func NatInstanceProvider_Gateway
deprecated
func NatInstanceProvider_Gateway(props *NatGatewayProps) NatProvider
Use NAT Gateways to provide NAT services for your VPC.
NAT gateways are managed by AWS. See: https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html
Deprecated: use NatInstanceProviderV2. NatInstanceProvider is deprecated since the instance image used has reached EOL on Dec 31 2023.
func NatProvider_Gateway ¶
func NatProvider_Gateway(props *NatGatewayProps) NatProvider
Use NAT Gateways to provide NAT services for your VPC.
NAT gateways are managed by AWS. See: https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html
type NatTrafficDirection ¶
type NatTrafficDirection string
Direction of traffic to allow all by default.
Example:
natGatewayProvider := ec2.NatProvider_InstanceV2(&NatInstanceProps{
InstanceType: ec2.NewInstanceType(jsii.String("t3.small")),
DefaultAllowedTraffic: ec2.NatTrafficDirection_NONE,
})
vpc := ec2.NewVpc(this, jsii.String("Vpc"), &VpcProps{
NatGatewayProvider: NatGatewayProvider,
})
securityGroup := ec2.NewSecurityGroup(this, jsii.String("SecurityGroup"), &SecurityGroupProps{
Vpc: Vpc,
AllowAllOutbound: jsii.Boolean(false),
})
securityGroup.AddEgressRule(ec2.Peer_AnyIpv4(), ec2.Port_Tcp(jsii.Number(443)))
for _, gatewayInstance := range natGatewayProvider.gatewayInstances {
gatewayInstance.AddSecurityGroup(securityGroup)
}
const ( // Allow all outbound traffic and disallow all inbound traffic. NatTrafficDirection_OUTBOUND_ONLY NatTrafficDirection = "OUTBOUND_ONLY" // Allow all outbound and inbound traffic. NatTrafficDirection_INBOUND_AND_OUTBOUND NatTrafficDirection = "INBOUND_AND_OUTBOUND" // Disallow all outbound and inbound traffic. NatTrafficDirection_NONE NatTrafficDirection = "NONE" )
type NetworkAcl ¶
type NetworkAcl interface {
awscdk.Resource
INetworkAcl
// The environment this resource belongs to.
//
// For resources that are created and managed by the CDK
// (generally, those created by creating new class instances like Role, Bucket, etc.),
// this is always the same as the environment of the stack they belong to;
// however, for imported resources
// (those obtained from static methods like fromRoleArn, fromBucketName, etc.),
// that might be different than the stack they were imported into.
Env() *awscdk.ResourceEnvironment
// The ID of the NetworkACL.
NetworkAclId() *string
// The VPC ID for this NetworkACL.
NetworkAclVpcId() *string
// The tree node.
Node() constructs.Node
// Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
//
// This value will resolve to one of the following:
// - a concrete value (e.g. `"my-awesome-bucket"`)
// - `undefined`, when a name should be generated by CloudFormation
// - a concrete name generated automatically during synthesis, in
// cross-environment scenarios.
PhysicalName() *string
// The stack in which this resource is defined.
Stack() awscdk.Stack
// Add a new entry to the ACL.
AddEntry(id *string, options *CommonNetworkAclEntryOptions) NetworkAclEntry
// Apply the given removal policy to this resource.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
// Associate the ACL with a given set of subnets.
AssociateWithSubnet(id *string, selection *SubnetSelection)
GeneratePhysicalName() *string
// Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`).
//
// Normally, this token will resolve to `arnAttr`, but if the resource is
// referenced across environments, `arnComponents` will be used to synthesize
// a concrete ARN with the resource's physical name. Make sure to reference
// `this.physicalName` in `arnComponents`.
GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
// Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`).
//
// Normally, this token will resolve to `nameAttr`, but if the resource is
// referenced across environments, it will be resolved to `this.physicalName`,
// which will be a concrete name.
GetResourceNameAttribute(nameAttr *string) *string
// Returns a string representation of this construct.
ToString() *string
}
Define a new custom network ACL.
By default, will deny all inbound and outbound traffic unless entries are added explicitly allowing it.
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"
var subnet subnet
var subnetFilter subnetFilter
var vpc vpc
networkAcl := awscdk.Aws_ec2.NewNetworkAcl(this, jsii.String("MyNetworkAcl"), &NetworkAclProps{
Vpc: vpc,
// the properties below are optional
NetworkAclName: jsii.String("networkAclName"),
SubnetSelection: &SubnetSelection{
AvailabilityZones: []*string{
jsii.String("availabilityZones"),
},
OnePerAz: jsii.Boolean(false),
SubnetFilters: []*subnetFilter{
subnetFilter,
},
SubnetGroupName: jsii.String("subnetGroupName"),
Subnets: []iSubnet{
subnet,
},
SubnetType: awscdk.*Aws_ec2.SubnetType_PRIVATE_ISOLATED,
},
})
func NewNetworkAcl ¶
func NewNetworkAcl(scope constructs.Construct, id *string, props *NetworkAclProps) NetworkAcl
type NetworkAclEntry ¶
type NetworkAclEntry interface {
awscdk.Resource
INetworkAclEntry
// The environment this resource belongs to.
//
// For resources that are created and managed by the CDK
// (generally, those created by creating new class instances like Role, Bucket, etc.),
// this is always the same as the environment of the stack they belong to;
// however, for imported resources
// (those obtained from static methods like fromRoleArn, fromBucketName, etc.),
// that might be different than the stack they were imported into.
Env() *awscdk.ResourceEnvironment
// The network ACL.
NetworkAcl() INetworkAcl
// The tree node.
Node() constructs.Node
// Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
//
// This value will resolve to one of the following:
// - a concrete value (e.g. `"my-awesome-bucket"`)
// - `undefined`, when a name should be generated by CloudFormation
// - a concrete name generated automatically during synthesis, in
// cross-environment scenarios.
PhysicalName() *string
// The stack in which this resource is defined.
Stack() awscdk.Stack
// Apply the given removal policy to this resource.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
GeneratePhysicalName() *string
// Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`).
//
// Normally, this token will resolve to `arnAttr`, but if the resource is
// referenced across environments, `arnComponents` will be used to synthesize
// a concrete ARN with the resource's physical name. Make sure to reference
// `this.physicalName` in `arnComponents`.
GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
// Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`).
//
// Normally, this token will resolve to `nameAttr`, but if the resource is
// referenced across environments, it will be resolved to `this.physicalName`,
// which will be a concrete name.
GetResourceNameAttribute(nameAttr *string) *string
// Returns a string representation of this construct.
ToString() *string
}
Define an entry in a Network ACL table.
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"
var aclCidr aclCidr
var aclTraffic aclTraffic
var networkAcl networkAcl
networkAclEntry := awscdk.Aws_ec2.NewNetworkAclEntry(this, jsii.String("MyNetworkAclEntry"), &NetworkAclEntryProps{
Cidr: aclCidr,
NetworkAcl: networkAcl,
RuleNumber: jsii.Number(123),
Traffic: aclTraffic,
// the properties below are optional
Direction: awscdk.*Aws_ec2.TrafficDirection_EGRESS,
NetworkAclEntryName: jsii.String("networkAclEntryName"),
RuleAction: awscdk.*Aws_ec2.Action_ALLOW,
})
func NewNetworkAclEntry ¶
func NewNetworkAclEntry(scope constructs.Construct, id *string, props *NetworkAclEntryProps) NetworkAclEntry
type NetworkAclEntryProps ¶
type NetworkAclEntryProps struct {
// The CIDR range to allow or deny.
Cidr AclCidr `field:"required" json:"cidr" yaml:"cidr"`
// Rule number to assign to the entry, such as 100.
//
// ACL entries are processed in ascending order by rule number.
// Entries can't use the same rule number unless one is an egress rule and the other is an ingress rule.
RuleNumber *float64 `field:"required" json:"ruleNumber" yaml:"ruleNumber"`
// What kind of traffic this ACL rule applies to.
Traffic AclTraffic `field:"required" json:"traffic" yaml:"traffic"`
// Traffic direction, with respect to the subnet, this rule applies to.
// Default: TrafficDirection.INGRESS
//
Direction TrafficDirection `field:"optional" json:"direction" yaml:"direction"`
// The name of the NetworkAclEntry.
//
// It is not recommended to use an explicit group name.
// Default: If you don't specify a NetworkAclName, AWS CloudFormation generates a
// unique physical ID and uses that ID for the group name.
//
NetworkAclEntryName *string `field:"optional" json:"networkAclEntryName" yaml:"networkAclEntryName"`
// Whether to allow or deny traffic that matches the rule; valid values are "allow" or "deny".
//
// Any traffic that is not explicitly allowed is automatically denied in a custom
// ACL, all traffic is automatically allowed in a default ACL.
// Default: ALLOW.
//
RuleAction Action `field:"optional" json:"ruleAction" yaml:"ruleAction"`
// The network ACL this entry applies to.
NetworkAcl INetworkAcl `field:"required" json:"networkAcl" yaml:"networkAcl"`
}
Properties to create NetworkAclEntry.
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"
var aclCidr aclCidr
var aclTraffic aclTraffic
var networkAcl networkAcl
networkAclEntryProps := &NetworkAclEntryProps{
Cidr: aclCidr,
NetworkAcl: networkAcl,
RuleNumber: jsii.Number(123),
Traffic: aclTraffic,
// the properties below are optional
Direction: awscdk.Aws_ec2.TrafficDirection_EGRESS,
NetworkAclEntryName: jsii.String("networkAclEntryName"),
RuleAction: awscdk.*Aws_ec2.Action_ALLOW,
}
type NetworkAclProps ¶
type NetworkAclProps struct {
// The VPC in which to create the NetworkACL.
Vpc IVpc `field:"required" json:"vpc" yaml:"vpc"`
// The name of the NetworkAcl.
//
// Since the NetworkAcl resource doesn't support providing a physical name, the value provided here will be recorded in the `Name` tag.
// Default: CDK generated name.
//
NetworkAclName *string `field:"optional" json:"networkAclName" yaml:"networkAclName"`
// Subnets in the given VPC to associate the ACL with.
//
// More subnets can always be added later by calling
// `associateWithSubnets()`.
// Default: - No subnets associated.
//
SubnetSelection *SubnetSelection `field:"optional" json:"subnetSelection" yaml:"subnetSelection"`
}
Properties to create NetworkAcl.
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"
var subnet subnet
var subnetFilter subnetFilter
var vpc vpc
networkAclProps := &NetworkAclProps{
Vpc: vpc,
// the properties below are optional
NetworkAclName: jsii.String("networkAclName"),
SubnetSelection: &SubnetSelection{
AvailabilityZones: []*string{
jsii.String("availabilityZones"),
},
OnePerAz: jsii.Boolean(false),
SubnetFilters: []*subnetFilter{
subnetFilter,
},
SubnetGroupName: jsii.String("subnetGroupName"),
Subnets: []iSubnet{
subnet,
},
SubnetType: awscdk.Aws_ec2.SubnetType_PRIVATE_ISOLATED,
},
}
type OperatingSystemType ¶
type OperatingSystemType string
The OS type of a particular image.
Example:
// Pick the right Amazon Linux edition. All arguments shown are optional
// and will default to these values when omitted.
amznLinux := ec2.MachineImage_LatestAmazonLinux(&AmazonLinuxImageProps{
Generation: ec2.AmazonLinuxGeneration_AMAZON_LINUX,
Edition: ec2.AmazonLinuxEdition_STANDARD,
Virtualization: ec2.AmazonLinuxVirt_HVM,
Storage: ec2.AmazonLinuxStorage_GENERAL_PURPOSE,
CpuType: ec2.AmazonLinuxCpuType_X86_64,
})
// Pick a Windows edition to use
windows := ec2.MachineImage_LatestWindows(ec2.WindowsVersion_WINDOWS_SERVER_2019_ENGLISH_FULL_BASE)
// Read AMI id from SSM parameter store
ssm := ec2.MachineImage_FromSsmParameter(jsii.String("/my/ami"), &SsmParameterImageOptions{
Os: ec2.OperatingSystemType_LINUX,
})
// Look up the most recent image matching a set of AMI filters.
// In this case, look up the NAT instance AMI, by using a wildcard
// in the 'name' field:
natAmi := ec2.MachineImage_Lookup(&LookupMachineImageProps{
Name: jsii.String("amzn-ami-vpc-nat-*"),
Owners: []*string{
jsii.String("amazon"),
},
})
// For other custom (Linux) images, instantiate a `GenericLinuxImage` with
// a map giving the AMI to in for each region:
linux := ec2.MachineImage_GenericLinux(map[string]*string{
"us-east-1": jsii.String("ami-97785bed"),
"eu-west-1": jsii.String("ami-12345678"),
})
// For other custom (Windows) images, instantiate a `GenericWindowsImage` with
// a map giving the AMI to in for each region:
genericWindows := ec2.MachineImage_GenericWindows(map[string]*string{
"us-east-1": jsii.String("ami-97785bed"),
"eu-west-1": jsii.String("ami-12345678"),
})
const ( OperatingSystemType_LINUX OperatingSystemType = "LINUX" OperatingSystemType_WINDOWS OperatingSystemType = "WINDOWS" // Used when the type of the operating system is not known (for example, for imported Auto-Scaling Groups). OperatingSystemType_UNKNOWN OperatingSystemType = "UNKNOWN" )
type Peer ¶
type Peer interface {
}
Peer object factories (to be used in Security Group management).
The static methods on this object can be used to create peer objects which represent a connection partner in Security Group rules.
Use this object if you need to represent connection partners using plain IP addresses, or a prefix list ID.
If you want to address a connection partner by Security Group, you can just use the Security Group (or the construct that contains a Security Group) directly, as it already implements `IPeer`.
Example:
var vpc vpc
cluster := msk.NewCluster(this, jsii.String("Cluster"), &ClusterProps{
ClusterName: jsii.String("myCluster"),
KafkaVersion: msk.KafkaVersion_V2_8_1(),
Vpc: Vpc,
})
cluster.connections.AllowFrom(ec2.Peer_Ipv4(jsii.String("1.2.3.4/8")), ec2.Port_Tcp(jsii.Number(2181)))
cluster.connections.AllowFrom(ec2.Peer_Ipv4(jsii.String("1.2.3.4/8")), ec2.Port_Tcp(jsii.Number(9094)))
type PlacementGroup ¶ added in v2.74.0
type PlacementGroup interface {
awscdk.Resource
IPlacementGroup
// The environment this resource belongs to.
//
// For resources that are created and managed by the CDK
// (generally, those created by creating new class instances like Role, Bucket, etc.),
// this is always the same as the environment of the stack they belong to;
// however, for imported resources
// (those obtained from static methods like fromRoleArn, fromBucketName, etc.),
// that might be different than the stack they were imported into.
Env() *awscdk.ResourceEnvironment
// The tree node.
Node() constructs.Node
// The number of partitions.
//
// Valid only when Strategy is set to PARTITION.
Partitions() *float64
// Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
//
// This value will resolve to one of the following:
// - a concrete value (e.g. `"my-awesome-bucket"`)
// - `undefined`, when a name should be generated by CloudFormation
// - a concrete name generated automatically during synthesis, in
// cross-environment scenarios.
PhysicalName() *string
// The name of this placement group.
PlacementGroupName() *string
// Places instances on distinct hardware.
//
// Spread placement groups are recommended for applications
// that have a small number of critical instances that should be kept separate from each other.
// Launching instances in a spread level placement group reduces the risk of simultaneous failures
// that might occur when instances share the same equipment.
// Spread level placement groups provide access to distinct hardware,
// and are therefore suitable for mixing instance types or launching instances over time.
// If you start or launch an instance in a spread placement group and there is insufficient
// unique hardware to fulfill the request, the request fails. Amazon EC2 makes more distinct hardware
// available over time, so you can try your request again later.
// Placement groups can spread instances across racks or hosts.
// You can use host level spread placement groups only with AWS Outposts.
SpreadLevel() PlacementGroupSpreadLevel
// The stack in which this resource is defined.
Stack() awscdk.Stack
// Which strategy to use when launching instances.
Strategy() PlacementGroupStrategy
// Apply the given removal policy to this resource.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
GeneratePhysicalName() *string
// Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`).
//
// Normally, this token will resolve to `arnAttr`, but if the resource is
// referenced across environments, `arnComponents` will be used to synthesize
// a concrete ARN with the resource's physical name. Make sure to reference
// `this.physicalName` in `arnComponents`.
GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
// Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`).
//
// Normally, this token will resolve to `nameAttr`, but if the resource is
// referenced across environments, it will be resolved to `this.physicalName`,
// which will be a concrete name.
GetResourceNameAttribute(nameAttr *string) *string
// Returns a string representation of this construct.
ToString() *string
}
Defines a placement group.
Placement groups give you fine-grained control over where your instances are provisioned.
Example:
var instanceType instanceType
pg := ec2.NewPlacementGroup(this, jsii.String("test-pg"), &PlacementGroupProps{
Strategy: ec2.PlacementGroupStrategy_SPREAD,
})
ec2.NewInstance(this, jsii.String("Instance"), &InstanceProps{
Vpc: Vpc,
InstanceType: InstanceType,
MachineImage: ec2.MachineImage_LatestAmazonLinux2023(),
PlacementGroup: pg,
})
func NewPlacementGroup ¶ added in v2.74.0
func NewPlacementGroup(scope constructs.Construct, id *string, props *PlacementGroupProps) PlacementGroup
type PlacementGroupProps ¶ added in v2.74.0
type PlacementGroupProps struct {
// The number of partitions.
//
// Valid only when Strategy is set to partition.
// Default: 0.
//
Partitions *float64 `field:"optional" json:"partitions" yaml:"partitions"`
// the name of this placement group.
// Default: - generated by CFN.
//
PlacementGroupName *string `field:"optional" json:"placementGroupName" yaml:"placementGroupName"`
// Places instances on distinct hardware.
//
// Spread placement groups are recommended for applications
// that have a small number of critical instances that should be kept separate from each other.
// Launching instances in a spread level placement group reduces the risk of simultaneous failures
// that might occur when instances share the same equipment.
// Spread level placement groups provide access to distinct hardware,
// and are therefore suitable for mixing instance types or launching instances over time.
// If you start or launch an instance in a spread placement group and there is insufficient
// unique hardware to fulfill the request, the request fails. Amazon EC2 makes more distinct hardware
// available over time, so you can try your request again later.
// Placement groups can spread instances across racks or hosts.
// You can use host level spread placement groups only with AWS Outposts.
// Default: - no spread level.
//
SpreadLevel PlacementGroupSpreadLevel `field:"optional" json:"spreadLevel" yaml:"spreadLevel"`
// Which strategy to use when launching instances.
// Default: - `PlacementGroupStrategy.PARTITION` if `partitions` is defined, `CLUSTER` otherwise
//
Strategy PlacementGroupStrategy `field:"optional" json:"strategy" yaml:"strategy"`
}
Props for a PlacementGroup.
Example:
var instanceType instanceType
pg := ec2.NewPlacementGroup(this, jsii.String("test-pg"), &PlacementGroupProps{
Strategy: ec2.PlacementGroupStrategy_SPREAD,
})
ec2.NewInstance(this, jsii.String("Instance"), &InstanceProps{
Vpc: Vpc,
InstanceType: InstanceType,
MachineImage: ec2.MachineImage_LatestAmazonLinux2023(),
PlacementGroup: pg,
})
type PlacementGroupSpreadLevel ¶ added in v2.74.0
type PlacementGroupSpreadLevel string
Determines how this placement group spreads instances.
const ( // Host spread level placement groups are only available with AWS Outposts. // // For host spread level placement groups, there are no restrictions for running instances per Outposts. // See: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups-outpost.html // PlacementGroupSpreadLevel_HOST PlacementGroupSpreadLevel = "HOST" // Each instance is launched on a separate rack. // // Each has its own network and power source. // A rack spread placement group can span multiple Availability Zones in the same Region. // For rack spread level placement groups, you can have a maximum of seven running instances per Availability Zone per group. PlacementGroupSpreadLevel_RACK PlacementGroupSpreadLevel = "RACK" )
type PlacementGroupStrategy ¶ added in v2.74.0
type PlacementGroupStrategy string
Which strategy to use when launching instances.
Example:
var instanceType instanceType
pg := ec2.NewPlacementGroup(this, jsii.String("test-pg"), &PlacementGroupProps{
Strategy: ec2.PlacementGroupStrategy_SPREAD,
})
ec2.NewInstance(this, jsii.String("Instance"), &InstanceProps{
Vpc: Vpc,
InstanceType: InstanceType,
MachineImage: ec2.MachineImage_LatestAmazonLinux2023(),
PlacementGroup: pg,
})
const ( // Packs instances close together inside an Availability Zone. // // This strategy enables workloads to achieve the low-latency network // performance necessary for tightly-coupled node-to-node communication that // is typical of high-performance computing (HPC) applications. PlacementGroupStrategy_CLUSTER PlacementGroupStrategy = "CLUSTER" // Spreads your instances across logical partitions such that groups of instances in one partition do not share the underlying hardware with groups of instances in different partitions. // // This strategy is typically used by large distributed and replicated workloads, // such as Hadoop, Cassandra, and Kafka. PlacementGroupStrategy_PARTITION PlacementGroupStrategy = "PARTITION" // Strictly places a small group of instances across distinct underlying hardware to reduce correlated failures. PlacementGroupStrategy_SPREAD PlacementGroupStrategy = "SPREAD" )
type Port ¶
type Port interface {
// Whether the rule containing this port range can be inlined into a securitygroup or not.
CanInlineRule() *bool
// Produce the ingress/egress rule JSON for the given connection.
ToRuleJson() interface{}
ToString() *string
}
Interface for classes that provide the connection-specification parts of a security group rule.
Example:
var instanceType instanceType
provider := ec2.NatProvider_InstanceV2(&NatInstanceProps{
InstanceType: InstanceType,
DefaultAllowedTraffic: ec2.NatTrafficDirection_OUTBOUND_ONLY,
})
ec2.NewVpc(this, jsii.String("TheVPC"), &VpcProps{
NatGatewayProvider: provider,
})
provider.connections.AllowFrom(ec2.Peer_Ipv4(jsii.String("1.2.3.4/8")), ec2.Port_HTTP())
func Port_DNS_TCP ¶ added in v2.138.0
func Port_DNS_TCP() Port
func Port_DNS_UDP ¶ added in v2.138.0
func Port_DNS_UDP() Port
func Port_HTTPS ¶ added in v2.138.0
func Port_HTTPS() Port
func Port_IMAPS ¶ added in v2.138.0
func Port_IMAPS() Port
func Port_IcmpTypeAndCode ¶
A specific combination of ICMP type and code. See: https://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml
func Port_MSSQL ¶ added in v2.138.0
func Port_MSSQL() Port
func Port_MYSQL_AURORA ¶ added in v2.138.0
func Port_MYSQL_AURORA() Port
func Port_POP3S ¶ added in v2.138.0
func Port_POP3S() Port
func Port_POSTGRES ¶ added in v2.138.0
func Port_POSTGRES() Port
func Port_TcpRange ¶
A TCP port range.
func Port_UdpRange ¶
A UDP port range.
type PortProps ¶
type PortProps struct {
// The protocol for the range.
Protocol Protocol `field:"required" json:"protocol" yaml:"protocol"`
// String representation for this object.
StringRepresentation *string `field:"required" json:"stringRepresentation" yaml:"stringRepresentation"`
// The starting port for the range.
// Default: - Not included in the rule.
//
FromPort *float64 `field:"optional" json:"fromPort" yaml:"fromPort"`
// The ending port for the range.
// Default: - Not included in the rule.
//
ToPort *float64 `field:"optional" json:"toPort" yaml:"toPort"`
}
Properties to create a port range.
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"
portProps := &PortProps{
Protocol: awscdk.Aws_ec2.Protocol_ALL,
StringRepresentation: jsii.String("stringRepresentation"),
// the properties below are optional
FromPort: jsii.Number(123),
ToPort: jsii.Number(123),
}
type PrefixList ¶ added in v2.78.0
type PrefixList interface {
awscdk.Resource
IPrefixList
// The address family of the prefix list.
AddressFamily() *string
// The environment this resource belongs to.
//
// For resources that are created and managed by the CDK
// (generally, those created by creating new class instances like Role, Bucket, etc.),
// this is always the same as the environment of the stack they belong to;
// however, for imported resources
// (those obtained from static methods like fromRoleArn, fromBucketName, etc.),
// that might be different than the stack they were imported into.
Env() *awscdk.ResourceEnvironment
// The tree node.
Node() constructs.Node
// The owner ID of the prefix list.
OwnerId() *string
// Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
//
// This value will resolve to one of the following:
// - a concrete value (e.g. `"my-awesome-bucket"`)
// - `undefined`, when a name should be generated by CloudFormation
// - a concrete name generated automatically during synthesis, in
// cross-environment scenarios.
PhysicalName() *string
// The ARN of the prefix list.
PrefixListArn() *string
// The ID of the prefix list.
PrefixListId() *string
// The name of the prefix list.
PrefixListName() *string
// The stack in which this resource is defined.
Stack() awscdk.Stack
// The version of the prefix list.
Version() *float64
// Apply the given removal policy to this resource.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
GeneratePhysicalName() *string
// Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`).
//
// Normally, this token will resolve to `arnAttr`, but if the resource is
// referenced across environments, `arnComponents` will be used to synthesize
// a concrete ARN with the resource's physical name. Make sure to reference
// `this.physicalName` in `arnComponents`.
GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
// Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`).
//
// Normally, this token will resolve to `nameAttr`, but if the resource is
// referenced across environments, it will be resolved to `this.physicalName`,
// which will be a concrete name.
GetResourceNameAttribute(nameAttr *string) *string
// Returns a string representation of this construct.
ToString() *string
}
A managed prefix list.
Example:
ec2.NewPrefixList(this, jsii.String("EmptyPrefixList"), &PrefixListProps{
MaxEntries: jsii.Number(100),
})
func NewPrefixList ¶ added in v2.78.0
func NewPrefixList(scope constructs.Construct, id *string, props *PrefixListProps) PrefixList
type PrefixListOptions ¶ added in v2.78.0
type PrefixListOptions struct {
// The maximum number of entries for the prefix list.
// Default: Automatically-calculated.
//
MaxEntries *float64 `field:"optional" json:"maxEntries" yaml:"maxEntries"`
}
Options to add a prefix list.
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"
prefixListOptions := &PrefixListOptions{
MaxEntries: jsii.Number(123),
}
type PrefixListProps ¶ added in v2.78.0
type PrefixListProps struct {
// The maximum number of entries for the prefix list.
// Default: Automatically-calculated.
//
MaxEntries *float64 `field:"optional" json:"maxEntries" yaml:"maxEntries"`
// The address family of the prefix list.
// Default: AddressFamily.IP_V4
//
AddressFamily AddressFamily `field:"optional" json:"addressFamily" yaml:"addressFamily"`
// The list of entries for the prefix list.
// Default: [].
//
Entries *[]*CfnPrefixList_EntryProperty `field:"optional" json:"entries" yaml:"entries"`
// The name of the prefix list.
// Default: None.
//
PrefixListName *string `field:"optional" json:"prefixListName" yaml:"prefixListName"`
}
Properties for creating a prefix list.
Example:
ec2.NewPrefixList(this, jsii.String("EmptyPrefixList"), &PrefixListProps{
MaxEntries: jsii.Number(100),
})
type PrivateSubnet ¶
type PrivateSubnet interface {
Subnet
IPrivateSubnet
// The Availability Zone the subnet is located in.
AvailabilityZone() *string
// Parts of this VPC subnet.
DependencyElements() *[]constructs.IDependable
// The environment this resource belongs to.
//
// For resources that are created and managed by the CDK
// (generally, those created by creating new class instances like Role, Bucket, etc.),
// this is always the same as the environment of the stack they belong to;
// however, for imported resources
// (those obtained from static methods like fromRoleArn, fromBucketName, etc.),
// that might be different than the stack they were imported into.
Env() *awscdk.ResourceEnvironment
// Dependable that can be depended upon to force internet connectivity established on the VPC.
InternetConnectivityEstablished() constructs.IDependable
// The IPv4 CIDR block for this subnet.
Ipv4CidrBlock() *string
// Network ACL associated with this Subnet.
//
// Upon creation, this is the default ACL which allows all traffic, except
// explicit DENY entries that you add.
//
// You can replace it with a custom ACL which denies all traffic except
// the explicit ALLOW entries that you add by creating a `NetworkAcl`
// object and calling `associateNetworkAcl()`.
NetworkAcl() INetworkAcl
// The tree node.
Node() constructs.Node
// Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
//
// This value will resolve to one of the following:
// - a concrete value (e.g. `"my-awesome-bucket"`)
// - `undefined`, when a name should be generated by CloudFormation
// - a concrete name generated automatically during synthesis, in
// cross-environment scenarios.
PhysicalName() *string
// The routeTableId attached to this subnet.
RouteTable() IRouteTable
// The stack in which this resource is defined.
Stack() awscdk.Stack
SubnetAvailabilityZone() *string
// The subnetId for this particular subnet.
SubnetId() *string
SubnetIpv6CidrBlocks() *[]*string
SubnetNetworkAclAssociationId() *string
// The Amazon Resource Name (ARN) of the Outpost for this subnet (if one exists).
SubnetOutpostArn() *string
SubnetVpcId() *string
// Create a default route that points to a passed IGW, with a dependency on the IGW's attachment to the VPC.
AddDefaultInternetRoute(gatewayId *string, gatewayAttachment constructs.IDependable)
// Adds an entry to this subnets route table that points to the passed NATGatewayId.
AddDefaultNatRoute(natGatewayId *string)
// Create a default IPv6 route that points to a passed EIGW.
AddIpv6DefaultEgressOnlyInternetRoute(gatewayId *string)
// Create a default IPv6 route that points to a passed IGW.
AddIpv6DefaultInternetRoute(gatewayId *string)
// Adds an entry to this subnets route table that points to the passed NATGatewayId.
//
// Uses the known 64:ff9b::/96 prefix.
AddIpv6Nat64Route(natGatewayId *string)
// Adds an entry to this subnets route table.
AddRoute(id *string, options *AddRouteOptions)
// Apply the given removal policy to this resource.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
// Associate a Network ACL with this subnet.
AssociateNetworkAcl(id *string, networkAcl INetworkAcl)
GeneratePhysicalName() *string
// Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`).
//
// Normally, this token will resolve to `arnAttr`, but if the resource is
// referenced across environments, `arnComponents` will be used to synthesize
// a concrete ARN with the resource's physical name. Make sure to reference
// `this.physicalName` in `arnComponents`.
GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
// Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`).
//
// Normally, this token will resolve to `nameAttr`, but if the resource is
// referenced across environments, it will be resolved to `this.physicalName`,
// which will be a concrete name.
GetResourceNameAttribute(nameAttr *string) *string
// Returns a string representation of this construct.
ToString() *string
}
Represents a private VPC subnet resource.
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"
privateSubnet := awscdk.Aws_ec2.NewPrivateSubnet(this, jsii.String("MyPrivateSubnet"), &PrivateSubnetProps{
AvailabilityZone: jsii.String("availabilityZone"),
CidrBlock: jsii.String("cidrBlock"),
VpcId: jsii.String("vpcId"),
// the properties below are optional
AssignIpv6AddressOnCreation: jsii.Boolean(false),
Ipv6CidrBlock: jsii.String("ipv6CidrBlock"),
MapPublicIpOnLaunch: jsii.Boolean(false),
})
func NewPrivateSubnet ¶
func NewPrivateSubnet(scope constructs.Construct, id *string, props *PrivateSubnetProps) PrivateSubnet
type PrivateSubnetAttributes ¶
type PrivateSubnetAttributes struct {
// The subnetId for this particular subnet.
SubnetId *string `field:"required" json:"subnetId" yaml:"subnetId"`
// The Availability Zone the subnet is located in.
// Default: - No AZ information, cannot use AZ selection features.
//
AvailabilityZone *string `field:"optional" json:"availabilityZone" yaml:"availabilityZone"`
// The IPv4 CIDR block associated with the subnet.
// Default: - No CIDR information, cannot use CIDR filter features.
//
Ipv4CidrBlock *string `field:"optional" json:"ipv4CidrBlock" yaml:"ipv4CidrBlock"`
// The ID of the route table for this particular subnet.
// Default: - No route table information, cannot create VPC endpoints.
//
RouteTableId *string `field:"optional" json:"routeTableId" yaml:"routeTableId"`
}
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"
privateSubnetAttributes := &PrivateSubnetAttributes{
SubnetId: jsii.String("subnetId"),
// the properties below are optional
AvailabilityZone: jsii.String("availabilityZone"),
Ipv4CidrBlock: jsii.String("ipv4CidrBlock"),
RouteTableId: jsii.String("routeTableId"),
}
type PrivateSubnetProps ¶
type PrivateSubnetProps struct {
// The availability zone for the subnet.
AvailabilityZone *string `field:"required" json:"availabilityZone" yaml:"availabilityZone"`
// The CIDR notation for this subnet.
CidrBlock *string `field:"required" json:"cidrBlock" yaml:"cidrBlock"`
// The VPC which this subnet is part of.
VpcId *string `field:"required" json:"vpcId" yaml:"vpcId"`
// Indicates whether a network interface created in this subnet receives an IPv6 address.
//
// If you specify AssignIpv6AddressOnCreation, you must also specify Ipv6CidrBlock.
// Default: false.
//
AssignIpv6AddressOnCreation *bool `field:"optional" json:"assignIpv6AddressOnCreation" yaml:"assignIpv6AddressOnCreation"`
// The IPv6 CIDR block.
//
// If you specify AssignIpv6AddressOnCreation, you must also specify Ipv6CidrBlock.
// Default: - no IPv6 CIDR block.
//
Ipv6CidrBlock *string `field:"optional" json:"ipv6CidrBlock" yaml:"ipv6CidrBlock"`
// Controls if a public IP is associated to an instance at launch.
// Default: true in Subnet.Public, false in Subnet.Private or Subnet.Isolated.
//
MapPublicIpOnLaunch *bool `field:"optional" json:"mapPublicIpOnLaunch" yaml:"mapPublicIpOnLaunch"`
}
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"
privateSubnetProps := &PrivateSubnetProps{
AvailabilityZone: jsii.String("availabilityZone"),
CidrBlock: jsii.String("cidrBlock"),
VpcId: jsii.String("vpcId"),
// the properties below are optional
AssignIpv6AddressOnCreation: jsii.Boolean(false),
Ipv6CidrBlock: jsii.String("ipv6CidrBlock"),
MapPublicIpOnLaunch: jsii.Boolean(false),
}
type Protocol ¶
type Protocol string
Protocol for use in Connection Rules.
https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml
const ( Protocol_ALL Protocol = "ALL" Protocol_HOPOPT Protocol = "HOPOPT" Protocol_ICMP Protocol = "ICMP" Protocol_IGMP Protocol = "IGMP" Protocol_GGP Protocol = "GGP" Protocol_IPV4 Protocol = "IPV4" Protocol_ST Protocol = "ST" Protocol_TCP Protocol = "TCP" Protocol_CBT Protocol = "CBT" Protocol_EGP Protocol = "EGP" Protocol_IGP Protocol = "IGP" Protocol_BBN_RCC_MON Protocol = "BBN_RCC_MON" Protocol_NVP_II Protocol = "NVP_II" Protocol_PUP Protocol = "PUP" Protocol_EMCON Protocol = "EMCON" Protocol_XNET Protocol = "XNET" Protocol_CHAOS Protocol = "CHAOS" Protocol_UDP Protocol = "UDP" Protocol_MUX Protocol = "MUX" Protocol_DCN_MEAS Protocol = "DCN_MEAS" Protocol_HMP Protocol = "HMP" Protocol_PRM Protocol = "PRM" Protocol_XNS_IDP Protocol = "XNS_IDP" Protocol_TRUNK_1 Protocol = "TRUNK_1" Protocol_TRUNK_2 Protocol = "TRUNK_2" Protocol_LEAF_1 Protocol = "LEAF_1" Protocol_LEAF_2 Protocol = "LEAF_2" Protocol_RDP Protocol = "RDP" Protocol_IRTP Protocol = "IRTP" Protocol_ISO_TP4 Protocol = "ISO_TP4" Protocol_NETBLT Protocol = "NETBLT" Protocol_MFE_NSP Protocol = "MFE_NSP" Protocol_MERIT_INP Protocol = "MERIT_INP" Protocol_DCCP Protocol = "DCCP" Protocol_THREEPC Protocol = "THREEPC" Protocol_IDPR Protocol = "IDPR" Protocol_XTP Protocol = "XTP" Protocol_DDP Protocol = "DDP" Protocol_IDPR_CMTP Protocol = "IDPR_CMTP" Protocol_TPPLUSPLUS Protocol = "TPPLUSPLUS" Protocol_IL Protocol = "IL" Protocol_IPV6 Protocol = "IPV6" Protocol_SDRP Protocol = "SDRP" Protocol_IPV6_ROUTE Protocol = "IPV6_ROUTE" Protocol_IPV6_FRAG Protocol = "IPV6_FRAG" Protocol_IDRP Protocol = "IDRP" Protocol_RSVP Protocol = "RSVP" Protocol_GRE Protocol = "GRE" Protocol_DSR Protocol = "DSR" Protocol_BNA Protocol = "BNA" Protocol_ESP Protocol = "ESP" Protocol_AH Protocol = "AH" Protocol_I_NLSP Protocol = "I_NLSP" Protocol_SWIPE Protocol = "SWIPE" Protocol_NARP Protocol = "NARP" Protocol_MOBILE Protocol = "MOBILE" Protocol_TLSP Protocol = "TLSP" Protocol_SKIP Protocol = "SKIP" Protocol_ICMPV6 Protocol = "ICMPV6" Protocol_IPV6_NONXT Protocol = "IPV6_NONXT" Protocol_IPV6_OPTS Protocol = "IPV6_OPTS" Protocol_CFTP Protocol = "CFTP" Protocol_ANY_LOCAL Protocol = "ANY_LOCAL" Protocol_SAT_EXPAK Protocol = "SAT_EXPAK" Protocol_KRYPTOLAN Protocol = "KRYPTOLAN" Protocol_RVD Protocol = "RVD" Protocol_IPPC Protocol = "IPPC" Protocol_ANY_DFS Protocol = "ANY_DFS" Protocol_SAT_MON Protocol = "SAT_MON" Protocol_VISA Protocol = "VISA" Protocol_IPCV Protocol = "IPCV" Protocol_CPNX Protocol = "CPNX" Protocol_CPHB Protocol = "CPHB" Protocol_WSN Protocol = "WSN" Protocol_PVP Protocol = "PVP" Protocol_BR_SAT_MON Protocol = "BR_SAT_MON" Protocol_SUN_ND Protocol = "SUN_ND" Protocol_WB_MON Protocol = "WB_MON" Protocol_WB_EXPAK Protocol = "WB_EXPAK" Protocol_ISO_IP Protocol = "ISO_IP" Protocol_VMTP Protocol = "VMTP" Protocol_SECURE_VMTP Protocol = "SECURE_VMTP" Protocol_VINES Protocol = "VINES" Protocol_TTP Protocol = "TTP" Protocol_IPTM Protocol = "IPTM" Protocol_NSFNET_IGP Protocol = "NSFNET_IGP" Protocol_DGP Protocol = "DGP" Protocol_TCF Protocol = "TCF" Protocol_EIGRP Protocol = "EIGRP" Protocol_OSPFIGP Protocol = "OSPFIGP" Protocol_SPRITE_RPC Protocol = "SPRITE_RPC" Protocol_LARP Protocol = "LARP" Protocol_MTP Protocol = "MTP" Protocol_AX_25 Protocol = "AX_25" Protocol_IPIP Protocol = "IPIP" Protocol_MICP Protocol = "MICP" Protocol_SCC_SP Protocol = "SCC_SP" Protocol_ETHERIP Protocol = "ETHERIP" Protocol_ENCAP Protocol = "ENCAP" Protocol_ANY_ENC Protocol = "ANY_ENC" Protocol_GMTP Protocol = "GMTP" Protocol_IFMP Protocol = "IFMP" Protocol_PNNI Protocol = "PNNI" Protocol_PIM Protocol = "PIM" Protocol_ARIS Protocol = "ARIS" Protocol_SCPS Protocol = "SCPS" Protocol_QNX Protocol = "QNX" Protocol_A_N Protocol = "A_N" Protocol_IPCOMP Protocol = "IPCOMP" Protocol_SNP Protocol = "SNP" Protocol_COMPAQ_PEER Protocol = "COMPAQ_PEER" Protocol_IPX_IN_IP Protocol = "IPX_IN_IP" Protocol_VRRP Protocol = "VRRP" Protocol_PGM Protocol = "PGM" Protocol_ANY_0_HOP Protocol = "ANY_0_HOP" Protocol_L2_T_P Protocol = "L2_T_P" Protocol_DDX Protocol = "DDX" Protocol_IATP Protocol = "IATP" Protocol_STP Protocol = "STP" Protocol_SRP Protocol = "SRP" Protocol_UTI Protocol = "UTI" Protocol_SMP Protocol = "SMP" Protocol_SM Protocol = "SM" Protocol_PTP Protocol = "PTP" Protocol_ISIS_IPV4 Protocol = "ISIS_IPV4" Protocol_FIRE Protocol = "FIRE" Protocol_CRTP Protocol = "CRTP" Protocol_CRUDP Protocol = "CRUDP" Protocol_SSCOPMCE Protocol = "SSCOPMCE" Protocol_IPLT Protocol = "IPLT" Protocol_SPS Protocol = "SPS" Protocol_PIPE Protocol = "PIPE" Protocol_SCTP Protocol = "SCTP" Protocol_FC Protocol = "FC" Protocol_RSVP_E2E_IGNORE Protocol = "RSVP_E2E_IGNORE" Protocol_MOBILITY_HEADER Protocol = "MOBILITY_HEADER" Protocol_UDPLITE Protocol = "UDPLITE" Protocol_MPLS_IN_IP Protocol = "MPLS_IN_IP" Protocol_MANET Protocol = "MANET" Protocol_HIP Protocol = "HIP" Protocol_SHIM6 Protocol = "SHIM6" Protocol_WESP Protocol = "WESP" Protocol_ROHC Protocol = "ROHC" Protocol_ETHERNET Protocol = "ETHERNET" Protocol_EXPERIMENT_1 Protocol = "EXPERIMENT_1" Protocol_EXPERIMENT_2 Protocol = "EXPERIMENT_2" Protocol_RESERVED Protocol = "RESERVED" )
type PublicSubnet ¶
type PublicSubnet interface {
Subnet
IPublicSubnet
// The Availability Zone the subnet is located in.
AvailabilityZone() *string
// Parts of this VPC subnet.
DependencyElements() *[]constructs.IDependable
// The environment this resource belongs to.
//
// For resources that are created and managed by the CDK
// (generally, those created by creating new class instances like Role, Bucket, etc.),
// this is always the same as the environment of the stack they belong to;
// however, for imported resources
// (those obtained from static methods like fromRoleArn, fromBucketName, etc.),
// that might be different than the stack they were imported into.
Env() *awscdk.ResourceEnvironment
// Dependable that can be depended upon to force internet connectivity established on the VPC.
InternetConnectivityEstablished() constructs.IDependable
// The IPv4 CIDR block for this subnet.
Ipv4CidrBlock() *string
// Network ACL associated with this Subnet.
//
// Upon creation, this is the default ACL which allows all traffic, except
// explicit DENY entries that you add.
//
// You can replace it with a custom ACL which denies all traffic except
// the explicit ALLOW entries that you add by creating a `NetworkAcl`
// object and calling `associateNetworkAcl()`.
NetworkAcl() INetworkAcl
// The tree node.
Node() constructs.Node
// Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
//
// This value will resolve to one of the following:
// - a concrete value (e.g. `"my-awesome-bucket"`)
// - `undefined`, when a name should be generated by CloudFormation
// - a concrete name generated automatically during synthesis, in
// cross-environment scenarios.
PhysicalName() *string
// The routeTableId attached to this subnet.
RouteTable() IRouteTable
// The stack in which this resource is defined.
Stack() awscdk.Stack
SubnetAvailabilityZone() *string
// The subnetId for this particular subnet.
SubnetId() *string
SubnetIpv6CidrBlocks() *[]*string
SubnetNetworkAclAssociationId() *string
// The Amazon Resource Name (ARN) of the Outpost for this subnet (if one exists).
SubnetOutpostArn() *string
SubnetVpcId() *string
// Create a default route that points to a passed IGW, with a dependency on the IGW's attachment to the VPC.
AddDefaultInternetRoute(gatewayId *string, gatewayAttachment constructs.IDependable)
// Adds an entry to this subnets route table that points to the passed NATGatewayId.
AddDefaultNatRoute(natGatewayId *string)
// Create a default IPv6 route that points to a passed EIGW.
AddIpv6DefaultEgressOnlyInternetRoute(gatewayId *string)
// Create a default IPv6 route that points to a passed IGW.
AddIpv6DefaultInternetRoute(gatewayId *string)
// Adds an entry to this subnets route table that points to the passed NATGatewayId.
//
// Uses the known 64:ff9b::/96 prefix.
AddIpv6Nat64Route(natGatewayId *string)
// Creates a new managed NAT gateway attached to this public subnet.
//
// Also adds the EIP for the managed NAT.
//
// Returns: A ref to the the NAT Gateway ID.
AddNatGateway(eipAllocationId *string) CfnNatGateway
// Adds an entry to this subnets route table.
AddRoute(id *string, options *AddRouteOptions)
// Apply the given removal policy to this resource.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
// Associate a Network ACL with this subnet.
AssociateNetworkAcl(id *string, networkAcl INetworkAcl)
GeneratePhysicalName() *string
// Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`).
//
// Normally, this token will resolve to `arnAttr`, but if the resource is
// referenced across environments, `arnComponents` will be used to synthesize
// a concrete ARN with the resource's physical name. Make sure to reference
// `this.physicalName` in `arnComponents`.
GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
// Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`).
//
// Normally, this token will resolve to `nameAttr`, but if the resource is
// referenced across environments, it will be resolved to `this.physicalName`,
// which will be a concrete name.
GetResourceNameAttribute(nameAttr *string) *string
// Returns a string representation of this construct.
ToString() *string
}
Represents a public VPC subnet resource.
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"
publicSubnet := awscdk.Aws_ec2.NewPublicSubnet(this, jsii.String("MyPublicSubnet"), &PublicSubnetProps{
AvailabilityZone: jsii.String("availabilityZone"),
CidrBlock: jsii.String("cidrBlock"),
VpcId: jsii.String("vpcId"),
// the properties below are optional
AssignIpv6AddressOnCreation: jsii.Boolean(false),
Ipv6CidrBlock: jsii.String("ipv6CidrBlock"),
MapPublicIpOnLaunch: jsii.Boolean(false),
})
func NewPublicSubnet ¶
func NewPublicSubnet(scope constructs.Construct, id *string, props *PublicSubnetProps) PublicSubnet
type PublicSubnetAttributes ¶
type PublicSubnetAttributes struct {
// The subnetId for this particular subnet.
SubnetId *string `field:"required" json:"subnetId" yaml:"subnetId"`
// The Availability Zone the subnet is located in.
// Default: - No AZ information, cannot use AZ selection features.
//
AvailabilityZone *string `field:"optional" json:"availabilityZone" yaml:"availabilityZone"`
// The IPv4 CIDR block associated with the subnet.
// Default: - No CIDR information, cannot use CIDR filter features.
//
Ipv4CidrBlock *string `field:"optional" json:"ipv4CidrBlock" yaml:"ipv4CidrBlock"`
// The ID of the route table for this particular subnet.
// Default: - No route table information, cannot create VPC endpoints.
//
RouteTableId *string `field:"optional" json:"routeTableId" yaml:"routeTableId"`
}
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"
publicSubnetAttributes := &PublicSubnetAttributes{
SubnetId: jsii.String("subnetId"),
// the properties below are optional
AvailabilityZone: jsii.String("availabilityZone"),
Ipv4CidrBlock: jsii.String("ipv4CidrBlock"),
RouteTableId: jsii.String("routeTableId"),
}
type PublicSubnetProps ¶
type PublicSubnetProps struct {
// The availability zone for the subnet.
AvailabilityZone *string `field:"required" json:"availabilityZone" yaml:"availabilityZone"`
// The CIDR notation for this subnet.
CidrBlock *string `field:"required" json:"cidrBlock" yaml:"cidrBlock"`
// The VPC which this subnet is part of.
VpcId *string `field:"required" json:"vpcId" yaml:"vpcId"`
// Indicates whether a network interface created in this subnet receives an IPv6 address.
//
// If you specify AssignIpv6AddressOnCreation, you must also specify Ipv6CidrBlock.
// Default: false.
//
AssignIpv6AddressOnCreation *bool `field:"optional" json:"assignIpv6AddressOnCreation" yaml:"assignIpv6AddressOnCreation"`
// The IPv6 CIDR block.
//
// If you specify AssignIpv6AddressOnCreation, you must also specify Ipv6CidrBlock.
// Default: - no IPv6 CIDR block.
//
Ipv6CidrBlock *string `field:"optional" json:"ipv6CidrBlock" yaml:"ipv6CidrBlock"`
// Controls if a public IP is associated to an instance at launch.
// Default: true in Subnet.Public, false in Subnet.Private or Subnet.Isolated.
//
MapPublicIpOnLaunch *bool `field:"optional" json:"mapPublicIpOnLaunch" yaml:"mapPublicIpOnLaunch"`
}
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"
publicSubnetProps := &PublicSubnetProps{
AvailabilityZone: jsii.String("availabilityZone"),
CidrBlock: jsii.String("cidrBlock"),
VpcId: jsii.String("vpcId"),
// the properties below are optional
AssignIpv6AddressOnCreation: jsii.Boolean(false),
Ipv6CidrBlock: jsii.String("ipv6CidrBlock"),
MapPublicIpOnLaunch: jsii.Boolean(false),
}
type RequestedSubnet ¶ added in v2.48.0
type RequestedSubnet struct {
// The availability zone for the subnet.
AvailabilityZone *string `field:"required" json:"availabilityZone" yaml:"availabilityZone"`
// Specify configuration parameters for a single subnet group in a VPC.
Configuration *SubnetConfiguration `field:"required" json:"configuration" yaml:"configuration"`
// Id for the Subnet construct.
SubnetConstructId *string `field:"required" json:"subnetConstructId" yaml:"subnetConstructId"`
}
Subnet requested for allocation.
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"
requestedSubnet := &RequestedSubnet{
AvailabilityZone: jsii.String("availabilityZone"),
Configuration: &SubnetConfiguration{
Name: jsii.String("name"),
SubnetType: awscdk.Aws_ec2.SubnetType_PRIVATE_ISOLATED,
// the properties below are optional
CidrMask: jsii.Number(123),
Ipv6AssignAddressOnCreation: jsii.Boolean(false),
MapPublicIpOnLaunch: jsii.Boolean(false),
Reserved: jsii.Boolean(false),
},
SubnetConstructId: jsii.String("subnetConstructId"),
}
type ResolveSsmParameterAtLaunchImage ¶ added in v2.88.0
type ResolveSsmParameterAtLaunchImage interface {
IMachineImage
// Name of the SSM parameter we're looking up.
ParameterName() *string
// Return the image to use in the given context.
GetImage(_arg constructs.Construct) *MachineImageConfig
}
Select the image based on a given SSM parameter at instance launch time.
This Machine Image comes with an imageId as `resolve:ssm:parameter-name` or `resolve:ssm:parameter-name:version` format as described in the document:.
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"
var userData userData
resolveSsmParameterAtLaunchImage := awscdk.Aws_ec2.NewResolveSsmParameterAtLaunchImage(jsii.String("parameterName"), &SsmParameterImageOptions{
CachedInContext: jsii.Boolean(false),
Os: awscdk.*Aws_ec2.OperatingSystemType_LINUX,
ParameterVersion: jsii.String("parameterVersion"),
UserData: userData,
})
See: https://docs.aws.amazon.com/autoscaling/ec2/userguide/using-systems-manager-parameters.html
The AMI ID would be selected at instance launch time.
func NewResolveSsmParameterAtLaunchImage ¶ added in v2.88.0
func NewResolveSsmParameterAtLaunchImage(parameterName *string, props *SsmParameterImageOptions) ResolveSsmParameterAtLaunchImage
type RouterType ¶
type RouterType string
Type of router used in route.
Example:
vpc := ec2.NewVpc(this, jsii.String("VPC"), &VpcProps{
SubnetConfiguration: []subnetConfiguration{
&subnetConfiguration{
SubnetType: ec2.SubnetType_PUBLIC,
Name: jsii.String("Public"),
},
&subnetConfiguration{
SubnetType: ec2.SubnetType_PRIVATE_ISOLATED,
Name: jsii.String("Isolated"),
},
},
})
(vpc.IsolatedSubnets[0].(subnet)).AddRoute(jsii.String("StaticRoute"), &AddRouteOptions{
RouterId: vpc.InternetGatewayId,
RouterType: ec2.RouterType_GATEWAY,
DestinationCidrBlock: jsii.String("8.8.8.8/32"),
})
const ( // Carrier gateway. RouterType_CARRIER_GATEWAY RouterType = "CARRIER_GATEWAY" // Egress-only Internet Gateway. RouterType_EGRESS_ONLY_INTERNET_GATEWAY RouterType = "EGRESS_ONLY_INTERNET_GATEWAY" // Internet Gateway. RouterType_GATEWAY RouterType = "GATEWAY" // Instance. RouterType_INSTANCE RouterType = "INSTANCE" // Local Gateway. RouterType_LOCAL_GATEWAY RouterType = "LOCAL_GATEWAY" // NAT Gateway. RouterType_NAT_GATEWAY RouterType = "NAT_GATEWAY" // Network Interface. RouterType_NETWORK_INTERFACE RouterType = "NETWORK_INTERFACE" // Transit Gateway. RouterType_TRANSIT_GATEWAY RouterType = "TRANSIT_GATEWAY" // VPC peering connection. RouterType_VPC_PEERING_CONNECTION RouterType = "VPC_PEERING_CONNECTION" // VPC Endpoint for gateway load balancers. RouterType_VPC_ENDPOINT RouterType = "VPC_ENDPOINT" )
type RuleScope ¶ added in v2.72.0
type RuleScope struct {
// The construct ID to use for the rule.
Id *string `field:"required" json:"id" yaml:"id"`
// The SecurityGroup in which a rule should be scoped.
Scope ISecurityGroup `field:"required" json:"scope" yaml:"scope"`
}
The scope and id in which a given SecurityGroup rule should be defined.
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"
var securityGroup securityGroup
ruleScope := &RuleScope{
Id: jsii.String("id"),
Scope: securityGroup,
}
type S3DestinationOptions ¶ added in v2.31.0
type S3DestinationOptions struct {
// The format for the flow log.
// Default: FlowLogFileFormat.PLAIN_TEXT
//
FileFormat FlowLogFileFormat `field:"optional" json:"fileFormat" yaml:"fileFormat"`
// Use Hive-compatible prefixes for flow logs stored in Amazon S3.
// Default: false.
//
HiveCompatiblePartitions *bool `field:"optional" json:"hiveCompatiblePartitions" yaml:"hiveCompatiblePartitions"`
// Partition the flow log per hour.
// Default: false.
//
PerHourPartition *bool `field:"optional" json:"perHourPartition" yaml:"perHourPartition"`
}
Options for writing logs to a S3 destination.
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"
s3DestinationOptions := &S3DestinationOptions{
FileFormat: awscdk.Aws_ec2.FlowLogFileFormat_PLAIN_TEXT,
HiveCompatiblePartitions: jsii.Boolean(false),
PerHourPartition: jsii.Boolean(false),
}
type S3DownloadOptions ¶
type S3DownloadOptions struct {
// Name of the S3 bucket to download from.
Bucket awss3.IBucket `field:"required" json:"bucket" yaml:"bucket"`
// The key of the file to download.
BucketKey *string `field:"required" json:"bucketKey" yaml:"bucketKey"`
// The name of the local file.
// Default: Linux - /tmp/bucketKey
// Windows - %TEMP%/bucketKey.
//
LocalFile *string `field:"optional" json:"localFile" yaml:"localFile"`
// The region of the S3 Bucket (needed for access via VPC Gateway).
// Default: none.
//
Region *string `field:"optional" json:"region" yaml:"region"`
}
Options when downloading files from S3.
Example:
import "github.com/aws/aws-cdk-go/awscdk"
var instance instance
asset := awscdk.NewAsset(this, jsii.String("Asset"), &AssetProps{
Path: jsii.String("./configure.sh"),
})
localPath := instance.UserData.AddS3DownloadCommand(&S3DownloadOptions{
Bucket: asset.Bucket,
BucketKey: asset.S3ObjectKey,
Region: jsii.String("us-east-1"),
})
instance.UserData.AddExecuteFileCommand(&ExecuteFileOptions{
FilePath: localPath,
Arguments: jsii.String("--verbose -y"),
})
asset.GrantRead(instance.Role)
type SecurityGroup ¶
type SecurityGroup interface {
awscdk.Resource
ISecurityGroup
// Whether the SecurityGroup has been configured to allow all outbound ipv6 traffic.
AllowAllIpv6Outbound() *bool
// Whether the SecurityGroup has been configured to allow all outbound traffic.
AllowAllOutbound() *bool
// Whether the rule can be inlined into a SecurityGroup or not.
CanInlineRule() *bool
// The network connections associated with this resource.
Connections() Connections
DefaultPort() Port
// The environment this resource belongs to.
//
// For resources that are created and managed by the CDK
// (generally, those created by creating new class instances like Role, Bucket, etc.),
// this is always the same as the environment of the stack they belong to;
// however, for imported resources
// (those obtained from static methods like fromRoleArn, fromBucketName, etc.),
// that might be different than the stack they were imported into.
Env() *awscdk.ResourceEnvironment
// The tree node.
Node() constructs.Node
// Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
//
// This value will resolve to one of the following:
// - a concrete value (e.g. `"my-awesome-bucket"`)
// - `undefined`, when a name should be generated by CloudFormation
// - a concrete name generated automatically during synthesis, in
// cross-environment scenarios.
PhysicalName() *string
// The ID of the security group.
SecurityGroupId() *string
// The VPC ID this security group is part of.
SecurityGroupVpcId() *string
// The stack in which this resource is defined.
Stack() awscdk.Stack
// A unique identifier for this connection peer.
UniqueId() *string
// Add an egress rule for the current security group.
//
// `remoteRule` controls where the Rule object is created if the peer is also a
// securityGroup and they are in different stack. If false (default) the
// rule object is created under the current SecurityGroup object. If true and the
// peer is also a SecurityGroup, the rule object is created under the remote
// SecurityGroup object.
AddEgressRule(peer IPeer, connection Port, description *string, remoteRule *bool)
// Add an ingress rule for the current security group.
//
// `remoteRule` controls where the Rule object is created if the peer is also a
// securityGroup and they are in different stack. If false (default) the
// rule object is created under the current SecurityGroup object. If true and the
// peer is also a SecurityGroup, the rule object is created under the remote
// SecurityGroup object.
AddIngressRule(peer IPeer, connection Port, description *string, remoteRule *bool)
// Apply the given removal policy to this resource.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
// Determine where to parent a new ingress/egress rule.
//
// A SecurityGroup rule is parented under the group it's related to, UNLESS
// we're in a cross-stack scenario with another Security Group. In that case,
// we respect the 'remoteRule' flag and will parent under the other security
// group.
//
// This is necessary to avoid cyclic dependencies between stacks, since both
// ingress and egress rules will reference both security groups, and a naive
// parenting will lead to the following situation:
//
// ╔════════════════════╗ ╔════════════════════╗
// ║ ┌───────────┐ ║ ║ ┌───────────┐ ║
// ║ │ GroupA │◀────╬─┐ ┌───╬───▶│ GroupB │ ║
// ║ └───────────┘ ║ │ │ ║ └───────────┘ ║
// ║ ▲ ║ │ │ ║ ▲ ║
// ║ │ ║ │ │ ║ │ ║
// ║ │ ║ │ │ ║ │ ║
// ║ ┌───────────┐ ║ └───┼───╬────┌───────────┐ ║
// ║ │ EgressA │─────╬─────┘ ║ │ IngressB │ ║
// ║ └───────────┘ ║ ║ └───────────┘ ║
// ║ ║ ║ ║
// ╚════════════════════╝ ╚════════════════════╝
//
// By having the ability to switch the parent, we avoid the cyclic reference by
// keeping all rules in a single stack.
//
// If this happens, we also have to change the construct ID, because
// otherwise we might have two objects with the same ID if we have
// multiple reversed security group relationships.
//
// ╔═══════════════════════════════════╗
// ║┌───────────┐ ║
// ║│ GroupB │ ║
// ║└───────────┘ ║
// ║ ▲ ║
// ║ │ ┌───────────┐ ║
// ║ ├────"from A"──│ IngressB │ ║
// ║ │ └───────────┘ ║
// ║ │ ┌───────────┐ ║
// ║ ├─────"to B"───│ EgressA │ ║
// ║ │ └───────────┘ ║
// ║ │ ┌───────────┐ ║
// ║ └─────"to B"───│ EgressC │ ║ <-- oops
// ║ └───────────┘ ║
// ╚═══════════════════════════════════╝.
DetermineRuleScope(peer IPeer, connection Port, fromTo *string, remoteRule *bool) *RuleScope
GeneratePhysicalName() *string
// Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`).
//
// Normally, this token will resolve to `arnAttr`, but if the resource is
// referenced across environments, `arnComponents` will be used to synthesize
// a concrete ARN with the resource's physical name. Make sure to reference
// `this.physicalName` in `arnComponents`.
GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
// Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`).
//
// Normally, this token will resolve to `nameAttr`, but if the resource is
// referenced across environments, it will be resolved to `this.physicalName`,
// which will be a concrete name.
GetResourceNameAttribute(nameAttr *string) *string
// Produce the egress rule JSON for the given connection.
ToEgressRuleConfig() interface{}
// Produce the ingress rule JSON for the given connection.
ToIngressRuleConfig() interface{}
// Returns a string representation of this construct.
ToString() *string
}
Creates an Amazon EC2 security group within a VPC.
Security Groups act like a firewall with a set of rules, and are associated with any AWS resource that has or creates Elastic Network Interfaces (ENIs). A typical example of a resource that has a security group is an Instance (or Auto Scaling Group of instances)
If you are defining new infrastructure in CDK, there is a good chance you won't have to interact with this class at all. Like IAM Roles, Security Groups need to exist to control access between AWS resources, but CDK will automatically generate and populate them with least-privilege permissions for you so you can concentrate on your business logic.
All Constructs that require Security Groups will create one for you if you don't specify one at construction. After construction, you can selectively allow connections to and between constructs via--for example-- the `instance.connections` object. Think of it as "allowing connections to your instance", rather than "adding ingress rules a security group". See the [Allowing Connections](https://docs.aws.amazon.com/cdk/api/latest/docs/aws-cdk-lib.aws_ec2-readme.html#allowing-connections) section in the library documentation for examples.
Direct manipulation of the Security Group through `addIngressRule` and `addEgressRule` is possible, but mutation through the `.connections` object is recommended. If you peer two constructs with security groups this way, appropriate rules will be created in both.
If you have an existing security group you want to use in your CDK application, you would import it like this:
```ts
const securityGroup = ec2.SecurityGroup.fromSecurityGroupId(this, 'SG', 'sg-12345', {
mutable: false
});
```.
Example:
var vpc vpc
mySecurityGroup := ec2.NewSecurityGroup(this, jsii.String("SecurityGroup"), &SecurityGroupProps{
Vpc: Vpc,
})
autoscaling.NewAutoScalingGroup(this, jsii.String("ASG"), &AutoScalingGroupProps{
Vpc: Vpc,
InstanceType: ec2.InstanceType_Of(ec2.InstanceClass_BURSTABLE2, ec2.InstanceSize_MICRO),
MachineImage: ec2.MachineImage_LatestAmazonLinux2(),
SecurityGroup: mySecurityGroup,
})
func NewSecurityGroup ¶
func NewSecurityGroup(scope constructs.Construct, id *string, props *SecurityGroupProps) SecurityGroup
type SecurityGroupImportOptions ¶
type SecurityGroupImportOptions struct {
// Mark the SecurityGroup as having been created allowing all outbound ipv6 traffic.
//
// Only if this is set to false will egress rules for ipv6 be added to this security
// group. Be aware, this would undo any potential "all outbound traffic"
// default.
// Default: false.
//
AllowAllIpv6Outbound *bool `field:"optional" json:"allowAllIpv6Outbound" yaml:"allowAllIpv6Outbound"`
// Mark the SecurityGroup as having been created allowing all outbound traffic.
//
// Only if this is set to false will egress rules be added to this security
// group. Be aware, this would undo any potential "all outbound traffic"
// default.
// Default: true.
//
AllowAllOutbound *bool `field:"optional" json:"allowAllOutbound" yaml:"allowAllOutbound"`
// If a SecurityGroup is mutable CDK can add rules to existing groups.
//
// Beware that making a SecurityGroup immutable might lead to issue
// due to missing ingress/egress rules for new resources.
// Default: true.
//
Mutable *bool `field:"optional" json:"mutable" yaml:"mutable"`
}
Additional options for imported security groups.
Example:
securityGroup := ec2.SecurityGroup_FromSecurityGroupId(this, jsii.String("SG"), jsii.String("sg-12345"), &SecurityGroupImportOptions{
Mutable: jsii.Boolean(false),
})
type SecurityGroupProps ¶
type SecurityGroupProps struct {
// The VPC in which to create the security group.
Vpc IVpc `field:"required" json:"vpc" yaml:"vpc"`
// Whether to allow all outbound ipv6 traffic by default.
//
// If this is set to true, there will only be a single egress rule which allows all
// outbound ipv6 traffic. If this is set to false, no outbound traffic will be allowed by
// default and all egress ipv6 traffic must be explicitly authorized.
//
// To allow all ipv4 traffic use allowAllOutbound.
// Default: false.
//
AllowAllIpv6Outbound *bool `field:"optional" json:"allowAllIpv6Outbound" yaml:"allowAllIpv6Outbound"`
// Whether to allow all outbound traffic by default.
//
// If this is set to true, there will only be a single egress rule which allows all
// outbound traffic. If this is set to false, no outbound traffic will be allowed by
// default and all egress traffic must be explicitly authorized.
//
// To allow all ipv6 traffic use allowAllIpv6Outbound.
// Default: true.
//
AllowAllOutbound *bool `field:"optional" json:"allowAllOutbound" yaml:"allowAllOutbound"`
// A description of the security group.
// Default: The default name will be the construct's CDK path.
//
Description *string `field:"optional" json:"description" yaml:"description"`
// Whether to disable inline ingress and egress rule optimization.
//
// If this is set to true, ingress and egress rules will not be declared under the
// SecurityGroup in cloudformation, but will be separate elements.
//
// Inlining rules is an optimization for producing smaller stack templates. Sometimes
// this is not desirable, for example when security group access is managed via tags.
//
// The default value can be overriden globally by setting the context variable
// '@aws-cdk/aws-ec2.securityGroupDisableInlineRules'.
// Default: false.
//
DisableInlineRules *bool `field:"optional" json:"disableInlineRules" yaml:"disableInlineRules"`
// The name of the security group.
//
// For valid values, see the GroupName
// parameter of the CreateSecurityGroup action in the Amazon EC2 API
// Reference.
//
// It is not recommended to use an explicit group name.
// Default: If you don't specify a GroupName, AWS CloudFormation generates a
// unique physical ID and uses that ID for the group name.
//
SecurityGroupName *string `field:"optional" json:"securityGroupName" yaml:"securityGroupName"`
}
Example:
var vpc vpc
mySecurityGroup := ec2.NewSecurityGroup(this, jsii.String("SecurityGroup"), &SecurityGroupProps{
Vpc: Vpc,
})
autoscaling.NewAutoScalingGroup(this, jsii.String("ASG"), &AutoScalingGroupProps{
Vpc: Vpc,
InstanceType: ec2.InstanceType_Of(ec2.InstanceClass_BURSTABLE2, ec2.InstanceSize_MICRO),
MachineImage: ec2.MachineImage_LatestAmazonLinux2(),
SecurityGroup: mySecurityGroup,
})
type SelectedSubnets ¶
type SelectedSubnets struct {
// The respective AZs of each subnet.
AvailabilityZones *[]*string `field:"required" json:"availabilityZones" yaml:"availabilityZones"`
// Whether any of the given subnets are from the VPC's public subnets.
HasPublic *bool `field:"required" json:"hasPublic" yaml:"hasPublic"`
// Dependency representing internet connectivity for these subnets.
InternetConnectivityEstablished constructs.IDependable `field:"required" json:"internetConnectivityEstablished" yaml:"internetConnectivityEstablished"`
// The subnet IDs.
SubnetIds *[]*string `field:"required" json:"subnetIds" yaml:"subnetIds"`
// Selected subnet objects.
Subnets *[]ISubnet `field:"required" json:"subnets" yaml:"subnets"`
// The subnet selection is not actually real yet.
//
// If this value is true, don't validate anything about the subnets. The count
// or identities are not known yet, and the validation will most likely fail
// which will prevent a successful lookup.
// Default: false.
//
IsPendingLookup *bool `field:"optional" json:"isPendingLookup" yaml:"isPendingLookup"`
}
Result of selecting a subset of subnets from a VPC.
Example:
vpc := ec2.NewVpc(this, jsii.String("TheVPC"), &VpcProps{
IpAddresses: ec2.IpAddresses_Cidr(jsii.String("10.0.0.0/16")),
})
// Iterate the private subnets
selection := vpc.selectSubnets(&SubnetSelection{
SubnetType: ec2.SubnetType_PRIVATE_WITH_EGRESS,
})
for _, subnet := range selection.Subnets {}
type ServiceManager ¶ added in v2.70.0
type ServiceManager string
The service manager that will be used by InitServices.
The value needs to match the service manager used by your operating system.
Example:
var vpc vpc
var instanceType instanceType
ec2.NewInstance(this, jsii.String("Instance"), &InstanceProps{
Vpc: Vpc,
InstanceType: InstanceType,
MachineImage: ec2.MachineImage_LatestAmazonLinux2023(),
Init: ec2.CloudFormationInit_FromElements(ec2.InitService_SystemdConfigFile(jsii.String("simpleserver"), &SystemdConfigFileOptions{
Command: jsii.String("/usr/bin/python3 -m http.server 8080"),
Cwd: jsii.String("/var/www/html"),
}), ec2.InitService_Enable(jsii.String("simpleserver"), &InitServiceOptions{
ServiceManager: ec2.ServiceManager_SYSTEMD,
}), ec2.InitFile_FromString(jsii.String("/var/www/html/index.html"), jsii.String("Hello! It's working!"))),
})
const ( // Use SysVinit. // // This is the default for Linux systems. ServiceManager_SYSVINIT ServiceManager = "SYSVINIT" // Use Windows. // // This is the default for Windows systems. ServiceManager_WINDOWS ServiceManager = "WINDOWS" // Use systemd. ServiceManager_SYSTEMD ServiceManager = "SYSTEMD" )
type SpotInstanceInterruption ¶
type SpotInstanceInterruption string
Provides the options for the types of interruption for spot instances.
const ( // The instance will stop when interrupted. SpotInstanceInterruption_STOP SpotInstanceInterruption = "STOP" // The instance will be terminated when interrupted. SpotInstanceInterruption_TERMINATE SpotInstanceInterruption = "TERMINATE" // The instance will hibernate when interrupted. SpotInstanceInterruption_HIBERNATE SpotInstanceInterruption = "HIBERNATE" )
type SpotRequestType ¶
type SpotRequestType string
The Spot Instance request type. See: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-requests.html
const ( // A one-time Spot Instance request remains active until Amazon EC2 launches the Spot Instance, the request expires, or you cancel the request. // // If the Spot price exceeds your maximum price // or capacity is not available, your Spot Instance is terminated and the Spot Instance request // is closed. SpotRequestType_ONE_TIME SpotRequestType = "ONE_TIME" // A persistent Spot Instance request remains active until it expires or you cancel it, even if the request is fulfilled. // // If the Spot price exceeds your maximum price or capacity is not available, // your Spot Instance is interrupted. After your instance is interrupted, when your maximum price exceeds // the Spot price or capacity becomes available again, the Spot Instance is started if stopped or resumed // if hibernated. SpotRequestType_PERSISTENT SpotRequestType = "PERSISTENT" )
type SsmParameterImageOptions ¶
type SsmParameterImageOptions struct {
// Whether the AMI ID is cached to be stable between deployments.
//
// By default, the newest image is used on each deployment. This will cause
// instances to be replaced whenever a new version is released, and may cause
// downtime if there aren't enough running instances in the AutoScalingGroup
// to reschedule the tasks on.
//
// If set to true, the AMI ID will be cached in `cdk.context.json` and the
// same value will be used on future runs. Your instances will not be replaced
// but your AMI version will grow old over time. To refresh the AMI lookup,
// you will have to evict the value from the cache using the `cdk context`
// command. See https://docs.aws.amazon.com/cdk/latest/guide/context.html for
// more information.
//
// Can not be set to `true` in environment-agnostic stacks.
// Default: false.
//
CachedInContext *bool `field:"optional" json:"cachedInContext" yaml:"cachedInContext"`
// Operating system.
// Default: OperatingSystemType.LINUX
//
Os OperatingSystemType `field:"optional" json:"os" yaml:"os"`
// The version of the SSM parameter.
// Default: no version specified.
//
ParameterVersion *string `field:"optional" json:"parameterVersion" yaml:"parameterVersion"`
// Custom UserData.
// Default: - UserData appropriate for the OS.
//
UserData UserData `field:"optional" json:"userData" yaml:"userData"`
}
Properties for GenericSsmParameterImage.
Example:
// Pick the right Amazon Linux edition. All arguments shown are optional
// and will default to these values when omitted.
amznLinux := ec2.MachineImage_LatestAmazonLinux(&AmazonLinuxImageProps{
Generation: ec2.AmazonLinuxGeneration_AMAZON_LINUX,
Edition: ec2.AmazonLinuxEdition_STANDARD,
Virtualization: ec2.AmazonLinuxVirt_HVM,
Storage: ec2.AmazonLinuxStorage_GENERAL_PURPOSE,
CpuType: ec2.AmazonLinuxCpuType_X86_64,
})
// Pick a Windows edition to use
windows := ec2.MachineImage_LatestWindows(ec2.WindowsVersion_WINDOWS_SERVER_2019_ENGLISH_FULL_BASE)
// Read AMI id from SSM parameter store
ssm := ec2.MachineImage_FromSsmParameter(jsii.String("/my/ami"), &SsmParameterImageOptions{
Os: ec2.OperatingSystemType_LINUX,
})
// Look up the most recent image matching a set of AMI filters.
// In this case, look up the NAT instance AMI, by using a wildcard
// in the 'name' field:
natAmi := ec2.MachineImage_Lookup(&LookupMachineImageProps{
Name: jsii.String("amzn-ami-vpc-nat-*"),
Owners: []*string{
jsii.String("amazon"),
},
})
// For other custom (Linux) images, instantiate a `GenericLinuxImage` with
// a map giving the AMI to in for each region:
linux := ec2.MachineImage_GenericLinux(map[string]*string{
"us-east-1": jsii.String("ami-97785bed"),
"eu-west-1": jsii.String("ami-12345678"),
})
// For other custom (Windows) images, instantiate a `GenericWindowsImage` with
// a map giving the AMI to in for each region:
genericWindows := ec2.MachineImage_GenericWindows(map[string]*string{
"us-east-1": jsii.String("ami-97785bed"),
"eu-west-1": jsii.String("ami-12345678"),
})
type Subnet ¶
type Subnet interface {
awscdk.Resource
ISubnet
// The Availability Zone the subnet is located in.
AvailabilityZone() *string
// Parts of this VPC subnet.
DependencyElements() *[]constructs.IDependable
// The environment this resource belongs to.
//
// For resources that are created and managed by the CDK
// (generally, those created by creating new class instances like Role, Bucket, etc.),
// this is always the same as the environment of the stack they belong to;
// however, for imported resources
// (those obtained from static methods like fromRoleArn, fromBucketName, etc.),
// that might be different than the stack they were imported into.
Env() *awscdk.ResourceEnvironment
// Dependable that can be depended upon to force internet connectivity established on the VPC.
InternetConnectivityEstablished() constructs.IDependable
// The IPv4 CIDR block for this subnet.
Ipv4CidrBlock() *string
// Network ACL associated with this Subnet.
//
// Upon creation, this is the default ACL which allows all traffic, except
// explicit DENY entries that you add.
//
// You can replace it with a custom ACL which denies all traffic except
// the explicit ALLOW entries that you add by creating a `NetworkAcl`
// object and calling `associateNetworkAcl()`.
NetworkAcl() INetworkAcl
// The tree node.
Node() constructs.Node
// Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
//
// This value will resolve to one of the following:
// - a concrete value (e.g. `"my-awesome-bucket"`)
// - `undefined`, when a name should be generated by CloudFormation
// - a concrete name generated automatically during synthesis, in
// cross-environment scenarios.
PhysicalName() *string
// The routeTableId attached to this subnet.
RouteTable() IRouteTable
// The stack in which this resource is defined.
Stack() awscdk.Stack
SubnetAvailabilityZone() *string
// The subnetId for this particular subnet.
SubnetId() *string
SubnetIpv6CidrBlocks() *[]*string
SubnetNetworkAclAssociationId() *string
// The Amazon Resource Name (ARN) of the Outpost for this subnet (if one exists).
SubnetOutpostArn() *string
SubnetVpcId() *string
// Create a default route that points to a passed IGW, with a dependency on the IGW's attachment to the VPC.
AddDefaultInternetRoute(gatewayId *string, gatewayAttachment constructs.IDependable)
// Adds an entry to this subnets route table that points to the passed NATGatewayId.
AddDefaultNatRoute(natGatewayId *string)
// Create a default IPv6 route that points to a passed EIGW.
AddIpv6DefaultEgressOnlyInternetRoute(gatewayId *string)
// Create a default IPv6 route that points to a passed IGW.
AddIpv6DefaultInternetRoute(gatewayId *string)
// Adds an entry to this subnets route table that points to the passed NATGatewayId.
//
// Uses the known 64:ff9b::/96 prefix.
AddIpv6Nat64Route(natGatewayId *string)
// Adds an entry to this subnets route table.
AddRoute(id *string, options *AddRouteOptions)
// Apply the given removal policy to this resource.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
// Associate a Network ACL with this subnet.
AssociateNetworkAcl(id *string, networkAcl INetworkAcl)
GeneratePhysicalName() *string
// Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`).
//
// Normally, this token will resolve to `arnAttr`, but if the resource is
// referenced across environments, `arnComponents` will be used to synthesize
// a concrete ARN with the resource's physical name. Make sure to reference
// `this.physicalName` in `arnComponents`.
GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
// Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`).
//
// Normally, this token will resolve to `nameAttr`, but if the resource is
// referenced across environments, it will be resolved to `this.physicalName`,
// which will be a concrete name.
GetResourceNameAttribute(nameAttr *string) *string
// Returns a string representation of this construct.
ToString() *string
}
Represents a new VPC subnet resource.
Example:
var cluster cluster
loadBalancedFargateService := ecsPatterns.NewApplicationLoadBalancedFargateService(this, jsii.String("Service"), &ApplicationLoadBalancedFargateServiceProps{
Cluster: Cluster,
MemoryLimitMiB: jsii.Number(1024),
DesiredCount: jsii.Number(1),
Cpu: jsii.Number(512),
TaskImageOptions: &ApplicationLoadBalancedTaskImageOptions{
Image: ecs.ContainerImage_FromRegistry(jsii.String("amazon/amazon-ecs-sample")),
},
TaskSubnets: &SubnetSelection{
Subnets: []iSubnet{
ec2.Subnet_FromSubnetId(this, jsii.String("subnet"), jsii.String("VpcISOLATEDSubnet1Subnet80F07FA0")),
},
},
})
func NewSubnet ¶
func NewSubnet(scope constructs.Construct, id *string, props *SubnetProps) Subnet
type SubnetAttributes ¶
type SubnetAttributes struct {
// The subnetId for this particular subnet.
SubnetId *string `field:"required" json:"subnetId" yaml:"subnetId"`
// The Availability Zone the subnet is located in.
// Default: - No AZ information, cannot use AZ selection features.
//
AvailabilityZone *string `field:"optional" json:"availabilityZone" yaml:"availabilityZone"`
// The IPv4 CIDR block associated with the subnet.
// Default: - No CIDR information, cannot use CIDR filter features.
//
Ipv4CidrBlock *string `field:"optional" json:"ipv4CidrBlock" yaml:"ipv4CidrBlock"`
// The ID of the route table for this particular subnet.
// Default: - No route table information, cannot create VPC endpoints.
//
RouteTableId *string `field:"optional" json:"routeTableId" yaml:"routeTableId"`
}
Example:
// Supply all properties
subnet1 := ec2.Subnet_FromSubnetAttributes(this, jsii.String("SubnetFromAttributes"), &SubnetAttributes{
SubnetId: jsii.String("s-1234"),
AvailabilityZone: jsii.String("pub-az-4465"),
RouteTableId: jsii.String("rt-145"),
})
// Supply only subnet id
subnet2 := ec2.Subnet_FromSubnetId(this, jsii.String("SubnetFromId"), jsii.String("s-1234"))
type SubnetConfiguration ¶
type SubnetConfiguration struct {
// Logical name for the subnet group.
//
// This name can be used when selecting VPC subnets to distinguish
// between different subnet groups of the same type.
Name *string `field:"required" json:"name" yaml:"name"`
// The type of Subnet to configure.
//
// The Subnet type will control the ability to route and connect to the
// Internet.
SubnetType SubnetType `field:"required" json:"subnetType" yaml:"subnetType"`
// The number of leading 1 bits in the routing mask.
//
// The number of available IP addresses in each subnet of this group
// will be equal to `2^(32 - cidrMask) - 2`.
//
// Valid values are `16--28`.
//
// Note this is specific to IPv4 addresses.
// Default: - Available IP space is evenly divided across subnets.
//
CidrMask *float64 `field:"optional" json:"cidrMask" yaml:"cidrMask"`
// This property is specific to dual stack VPCs.
//
// If set to false, then an IPv6 address will not be automatically assigned.
//
// Note this is specific to IPv6 addresses.
// Default: true.
//
Ipv6AssignAddressOnCreation *bool `field:"optional" json:"ipv6AssignAddressOnCreation" yaml:"ipv6AssignAddressOnCreation"`
// Controls if a public IPv4 address is associated to an instance at launch.
//
// Note this is specific to IPv4 addresses.
// Default: true in Subnet.Public of IPV4_ONLY VPCs, false otherwise
//
MapPublicIpOnLaunch *bool `field:"optional" json:"mapPublicIpOnLaunch" yaml:"mapPublicIpOnLaunch"`
// Controls if subnet IP space needs to be reserved.
//
// When true, the IP space for the subnet is reserved but no actual
// resources are provisioned. This space is only dependent on the
// number of availability zones and on `cidrMask` - all other subnet
// properties are ignored.
// Default: false.
//
Reserved *bool `field:"optional" json:"reserved" yaml:"reserved"`
}
Specify configuration parameters for a single subnet group in a VPC.
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"
subnetConfiguration := &SubnetConfiguration{
Name: jsii.String("name"),
SubnetType: awscdk.Aws_ec2.SubnetType_PRIVATE_ISOLATED,
// the properties below are optional
CidrMask: jsii.Number(123),
Ipv6AssignAddressOnCreation: jsii.Boolean(false),
MapPublicIpOnLaunch: jsii.Boolean(false),
Reserved: jsii.Boolean(false),
}
type SubnetFilter ¶
type SubnetFilter interface {
// Executes the subnet filtering logic, returning a filtered set of subnets.
SelectSubnets(_subnets *[]ISubnet) *[]ISubnet
}
Contains logic which chooses a set of subnets from a larger list, in conjunction with SubnetSelection, to determine where to place AWS resources such as VPC endpoints, EC2 instances, etc.
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"
subnetFilter := awscdk.Aws_ec2.SubnetFilter_AvailabilityZones([]*string{
jsii.String("availabilityZones"),
})
func SubnetFilter_AvailabilityZones ¶
func SubnetFilter_AvailabilityZones(availabilityZones *[]*string) SubnetFilter
Chooses subnets which are in one of the given availability zones.
func SubnetFilter_ByCidrMask ¶
func SubnetFilter_ByCidrMask(mask *float64) SubnetFilter
Chooses subnets which have the provided CIDR netmask.
func SubnetFilter_ByCidrRanges ¶ added in v2.101.0
func SubnetFilter_ByCidrRanges(cidrs *[]*string) SubnetFilter
Chooses subnets which are inside any of the specified CIDR range.
func SubnetFilter_ByIds ¶
func SubnetFilter_ByIds(subnetIds *[]*string) SubnetFilter
Chooses subnets by id.
func SubnetFilter_ContainsIpAddresses ¶
func SubnetFilter_ContainsIpAddresses(ipv4addrs *[]*string) SubnetFilter
Chooses subnets which contain any of the specified IP addresses.
func SubnetFilter_OnePerAz ¶
func SubnetFilter_OnePerAz() SubnetFilter
Chooses subnets such that there is at most one per availability zone.
type SubnetIpamOptions ¶ added in v2.48.0
type SubnetIpamOptions struct {
// CIDR Allocations for Subnets.
AllocatedSubnets *[]*AllocatedSubnet `field:"required" json:"allocatedSubnets" yaml:"allocatedSubnets"`
}
CIDR Allocated Subnets.
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"
subnetIpamOptions := &SubnetIpamOptions{
AllocatedSubnets: []allocatedSubnet{
&allocatedSubnet{
Cidr: jsii.String("cidr"),
// the properties below are optional
Ipv6Cidr: jsii.String("ipv6Cidr"),
},
},
}
type SubnetNetworkAclAssociation ¶
type SubnetNetworkAclAssociation interface {
awscdk.Resource
ISubnetNetworkAclAssociation
// The environment this resource belongs to.
//
// For resources that are created and managed by the CDK
// (generally, those created by creating new class instances like Role, Bucket, etc.),
// this is always the same as the environment of the stack they belong to;
// however, for imported resources
// (those obtained from static methods like fromRoleArn, fromBucketName, etc.),
// that might be different than the stack they were imported into.
Env() *awscdk.ResourceEnvironment
// ID for the current Network ACL.
NetworkAcl() INetworkAcl
// The tree node.
Node() constructs.Node
// Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
//
// This value will resolve to one of the following:
// - a concrete value (e.g. `"my-awesome-bucket"`)
// - `undefined`, when a name should be generated by CloudFormation
// - a concrete name generated automatically during synthesis, in
// cross-environment scenarios.
PhysicalName() *string
// The stack in which this resource is defined.
Stack() awscdk.Stack
// ID of the Subnet.
Subnet() ISubnet
// ID for the current SubnetNetworkAclAssociation.
SubnetNetworkAclAssociationAssociationId() *string
// Apply the given removal policy to this resource.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
GeneratePhysicalName() *string
// Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`).
//
// Normally, this token will resolve to `arnAttr`, but if the resource is
// referenced across environments, `arnComponents` will be used to synthesize
// a concrete ARN with the resource's physical name. Make sure to reference
// `this.physicalName` in `arnComponents`.
GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
// Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`).
//
// Normally, this token will resolve to `nameAttr`, but if the resource is
// referenced across environments, it will be resolved to `this.physicalName`,
// which will be a concrete name.
GetResourceNameAttribute(nameAttr *string) *string
// Returns a string representation of this construct.
ToString() *string
}
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"
var networkAcl networkAcl
var subnet subnet
subnetNetworkAclAssociation := awscdk.Aws_ec2.NewSubnetNetworkAclAssociation(this, jsii.String("MySubnetNetworkAclAssociation"), &SubnetNetworkAclAssociationProps{
NetworkAcl: networkAcl,
Subnet: subnet,
// the properties below are optional
SubnetNetworkAclAssociationName: jsii.String("subnetNetworkAclAssociationName"),
})
func NewSubnetNetworkAclAssociation ¶
func NewSubnetNetworkAclAssociation(scope constructs.Construct, id *string, props *SubnetNetworkAclAssociationProps) SubnetNetworkAclAssociation
type SubnetNetworkAclAssociationProps ¶
type SubnetNetworkAclAssociationProps struct {
// The Network ACL this association is defined for.
NetworkAcl INetworkAcl `field:"required" json:"networkAcl" yaml:"networkAcl"`
// ID of the Subnet.
Subnet ISubnet `field:"required" json:"subnet" yaml:"subnet"`
// The name of the SubnetNetworkAclAssociation.
//
// It is not recommended to use an explicit name.
// Default: If you don't specify a SubnetNetworkAclAssociationName, AWS CloudFormation generates a
// unique physical ID and uses that ID for the group name.
//
SubnetNetworkAclAssociationName *string `field:"optional" json:"subnetNetworkAclAssociationName" yaml:"subnetNetworkAclAssociationName"`
}
Properties to create a SubnetNetworkAclAssociation.
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"
var networkAcl networkAcl
var subnet subnet
subnetNetworkAclAssociationProps := &SubnetNetworkAclAssociationProps{
NetworkAcl: networkAcl,
Subnet: subnet,
// the properties below are optional
SubnetNetworkAclAssociationName: jsii.String("subnetNetworkAclAssociationName"),
}
type SubnetProps ¶
type SubnetProps struct {
// The availability zone for the subnet.
AvailabilityZone *string `field:"required" json:"availabilityZone" yaml:"availabilityZone"`
// The CIDR notation for this subnet.
CidrBlock *string `field:"required" json:"cidrBlock" yaml:"cidrBlock"`
// The VPC which this subnet is part of.
VpcId *string `field:"required" json:"vpcId" yaml:"vpcId"`
// Indicates whether a network interface created in this subnet receives an IPv6 address.
//
// If you specify AssignIpv6AddressOnCreation, you must also specify Ipv6CidrBlock.
// Default: false.
//
AssignIpv6AddressOnCreation *bool `field:"optional" json:"assignIpv6AddressOnCreation" yaml:"assignIpv6AddressOnCreation"`
// The IPv6 CIDR block.
//
// If you specify AssignIpv6AddressOnCreation, you must also specify Ipv6CidrBlock.
// Default: - no IPv6 CIDR block.
//
Ipv6CidrBlock *string `field:"optional" json:"ipv6CidrBlock" yaml:"ipv6CidrBlock"`
// Controls if a public IP is associated to an instance at launch.
// Default: true in Subnet.Public, false in Subnet.Private or Subnet.Isolated.
//
MapPublicIpOnLaunch *bool `field:"optional" json:"mapPublicIpOnLaunch" yaml:"mapPublicIpOnLaunch"`
}
Specify configuration parameters for a VPC subnet.
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"
subnetProps := &SubnetProps{
AvailabilityZone: jsii.String("availabilityZone"),
CidrBlock: jsii.String("cidrBlock"),
VpcId: jsii.String("vpcId"),
// the properties below are optional
AssignIpv6AddressOnCreation: jsii.Boolean(false),
Ipv6CidrBlock: jsii.String("ipv6CidrBlock"),
MapPublicIpOnLaunch: jsii.Boolean(false),
}
type SubnetSelection ¶
type SubnetSelection struct {
// Select subnets only in the given AZs.
// Default: no filtering on AZs is done.
//
AvailabilityZones *[]*string `field:"optional" json:"availabilityZones" yaml:"availabilityZones"`
// If true, return at most one subnet per AZ.
// Default: false.
//
OnePerAz *bool `field:"optional" json:"onePerAz" yaml:"onePerAz"`
// List of provided subnet filters.
// Default: - none.
//
SubnetFilters *[]SubnetFilter `field:"optional" json:"subnetFilters" yaml:"subnetFilters"`
// Select the subnet group with the given name.
//
// Select the subnet group with the given name. This only needs
// to be used if you have multiple subnet groups of the same type
// and you need to distinguish between them. Otherwise, prefer
// `subnetType`.
//
// This field does not select individual subnets, it selects all subnets that
// share the given subnet group name. This is the name supplied in
// `subnetConfiguration`.
//
// At most one of `subnetType` and `subnetGroupName` can be supplied.
// Default: - Selection by type instead of by name.
//
SubnetGroupName *string `field:"optional" json:"subnetGroupName" yaml:"subnetGroupName"`
// Explicitly select individual subnets.
//
// Use this if you don't want to automatically use all subnets in
// a group, but have a need to control selection down to
// individual subnets.
//
// Cannot be specified together with `subnetType` or `subnetGroupName`.
// Default: - Use all subnets in a selected group (all private subnets by default).
//
Subnets *[]ISubnet `field:"optional" json:"subnets" yaml:"subnets"`
// Select all subnets of the given type.
//
// At most one of `subnetType` and `subnetGroupName` can be supplied.
// Default: SubnetType.PRIVATE_WITH_EGRESS (or ISOLATED or PUBLIC if there are no PRIVATE_WITH_EGRESS subnets)
//
SubnetType SubnetType `field:"optional" json:"subnetType" yaml:"subnetType"`
}
Customize subnets that are selected for placement of ENIs.
Constructs that allow customization of VPC placement use parameters of this type to provide placement settings.
By default, the instances are placed in the private subnets.
Example:
var vpc vpc
cluster := docdb.NewDatabaseCluster(this, jsii.String("Database"), &DatabaseClusterProps{
MasterUser: &Login{
Username: jsii.String("myuser"),
},
InstanceType: ec2.InstanceType_Of(ec2.InstanceClass_MEMORY5, ec2.InstanceSize_LARGE),
VpcSubnets: &SubnetSelection{
SubnetType: ec2.SubnetType_PUBLIC,
},
Vpc: Vpc,
RemovalPolicy: awscdk.RemovalPolicy_SNAPSHOT,
InstanceRemovalPolicy: awscdk.RemovalPolicy_RETAIN,
})
type SubnetType ¶
type SubnetType string
The type of Subnet.
Example:
var vpc vpc
cluster := docdb.NewDatabaseCluster(this, jsii.String("Database"), &DatabaseClusterProps{
MasterUser: &Login{
Username: jsii.String("myuser"),
},
InstanceType: ec2.InstanceType_Of(ec2.InstanceClass_MEMORY5, ec2.InstanceSize_LARGE),
VpcSubnets: &SubnetSelection{
SubnetType: ec2.SubnetType_PUBLIC,
},
Vpc: Vpc,
RemovalPolicy: awscdk.RemovalPolicy_SNAPSHOT,
InstanceRemovalPolicy: awscdk.RemovalPolicy_RETAIN,
})
const ( // Isolated Subnets do not route traffic to the Internet (in this VPC), and as such, do not require NAT gateways. // // Isolated subnets can only connect to or be connected to from other // instances in the same VPC. A default VPC configuration will not include // isolated subnets. // // This can be good for subnets with RDS or Elasticache instances, // or which route Internet traffic through a peer VPC. SubnetType_PRIVATE_ISOLATED SubnetType = "PRIVATE_ISOLATED" // Subnet that routes to the internet, but not vice versa. // // Instances in a private subnet can connect to the Internet, but will not // allow connections to be initiated from the Internet. Egress to the internet will // need to be provided. // NAT Gateway(s) are the default solution to providing this subnet type the ability to route Internet traffic. // If a NAT Gateway is not required or desired, set `natGateways:0` or use // `SubnetType.PRIVATE_ISOLATED` instead. // // By default, a NAT gateway is created in every public subnet for maximum availability. // Be aware that you will be charged for NAT gateways. // // Normally a Private subnet will use a NAT gateway in the same AZ, but // if `natGateways` is used to reduce the number of NAT gateways, a NAT // gateway from another AZ will be used instead. SubnetType_PRIVATE_WITH_EGRESS SubnetType = "PRIVATE_WITH_EGRESS" // Subnet that routes to the internet (via a NAT gateway), but not vice versa. // // Instances in a private subnet can connect to the Internet, but will not // allow connections to be initiated from the Internet. NAT Gateway(s) are // required with this subnet type to route the Internet traffic through. // If a NAT Gateway is not required or desired, use `SubnetType.PRIVATE_ISOLATED` instead. // // By default, a NAT gateway is created in every public subnet for maximum availability. // Be aware that you will be charged for NAT gateways. // // Normally a Private subnet will use a NAT gateway in the same AZ, but // if `natGateways` is used to reduce the number of NAT gateways, a NAT // gateway from another AZ will be used instead. // Deprecated: use `PRIVATE_WITH_EGRESS`. SubnetType_PRIVATE_WITH_NAT SubnetType = "PRIVATE_WITH_NAT" // Subnet connected to the Internet. // // Instances in a Public subnet can connect to the Internet and can be // connected to from the Internet as long as they are launched with public // IPs (controlled on the AutoScalingGroup or other constructs that launch // instances). // // Public subnets route outbound traffic via an Internet Gateway. SubnetType_PUBLIC SubnetType = "PUBLIC" )
type SystemdConfigFileOptions ¶ added in v2.70.0
type SystemdConfigFileOptions struct {
// The command to run to start this service.
Command *string `field:"required" json:"command" yaml:"command"`
// Start the service after the networking part of the OS comes up.
// Default: true.
//
AfterNetwork *bool `field:"optional" json:"afterNetwork" yaml:"afterNetwork"`
// The working directory for the command.
// Default: Root directory or home directory of specified user.
//
Cwd *string `field:"optional" json:"cwd" yaml:"cwd"`
// A description of this service.
// Default: - No description.
//
Description *string `field:"optional" json:"description" yaml:"description"`
// Loads environment variables from files when the process is running.
//
// Must use absolute paths.
// Default: - No environment files.
//
EnvironmentFiles *[]*string `field:"optional" json:"environmentFiles" yaml:"environmentFiles"`
// Environment variables to load when the process is running.
// Default: - No environment variables set.
//
EnvironmentVariables *map[string]*string `field:"optional" json:"environmentVariables" yaml:"environmentVariables"`
// The group to execute the process under.
// Default: root.
//
Group *string `field:"optional" json:"group" yaml:"group"`
// Keep the process running all the time.
//
// Restarts the process when it exits for any reason other
// than the machine shutting down.
// Default: true.
//
KeepRunning *bool `field:"optional" json:"keepRunning" yaml:"keepRunning"`
// The user to execute the process under.
// Default: root.
//
User *string `field:"optional" json:"user" yaml:"user"`
}
Options for creating a SystemD configuration file.
Example:
var vpc vpc
var instanceType instanceType
ec2.NewInstance(this, jsii.String("Instance"), &InstanceProps{
Vpc: Vpc,
InstanceType: InstanceType,
MachineImage: ec2.MachineImage_LatestAmazonLinux2023(),
Init: ec2.CloudFormationInit_FromElements(ec2.InitService_SystemdConfigFile(jsii.String("simpleserver"), &SystemdConfigFileOptions{
Command: jsii.String("/usr/bin/python3 -m http.server 8080"),
Cwd: jsii.String("/var/www/html"),
}), ec2.InitService_Enable(jsii.String("simpleserver"), &InitServiceOptions{
ServiceManager: ec2.ServiceManager_SYSTEMD,
}), ec2.InitFile_FromString(jsii.String("/var/www/html/index.html"), jsii.String("Hello! It's working!"))),
})
type TrafficDirection ¶
type TrafficDirection string
Direction of traffic the AclEntry applies to.
const ( // Traffic leaving the subnet. TrafficDirection_EGRESS TrafficDirection = "EGRESS" // Traffic entering the subnet. TrafficDirection_INGRESS TrafficDirection = "INGRESS" )
type TransportProtocol ¶
type TransportProtocol string
Transport protocol for client VPN.
const ( // Transmission Control Protocol (TCP). TransportProtocol_TCP TransportProtocol = "TCP" // User Datagram Protocol (UDP). TransportProtocol_UDP TransportProtocol = "UDP" )
type UserData ¶
type UserData interface {
// Add one or more commands to the user data.
AddCommands(commands ...*string)
// Adds commands to execute a file.
AddExecuteFileCommand(params *ExecuteFileOptions)
// Add one or more commands to the user data that will run when the script exits.
AddOnExitCommands(commands ...*string)
// Adds commands to download a file from S3.
//
// Returns: : The local path that the file will be downloaded to.
AddS3DownloadCommand(params *S3DownloadOptions) *string
// Adds a command which will send a cfn-signal when the user data script ends.
AddSignalOnExitCommand(resource awscdk.Resource)
// Render the UserData for use in a construct.
Render() *string
}
Instance User Data.
Example:
var cluster cluster
userData := ec2.UserData_ForLinux()
userData.AddCommands(jsii.String("set -o xtrace"),
fmt.Sprintf("/etc/eks/bootstrap.sh %v", cluster.ClusterName))
lt := ec2.NewCfnLaunchTemplate(this, jsii.String("LaunchTemplate"), &CfnLaunchTemplateProps{
LaunchTemplateData: &LaunchTemplateDataProperty{
ImageId: jsii.String("some-ami-id"),
// custom AMI
InstanceType: jsii.String("t3.small"),
UserData: awscdk.Fn_Base64(userData.Render()),
},
})
cluster.AddNodegroupCapacity(jsii.String("extra-ng"), &NodegroupOptions{
LaunchTemplateSpec: &LaunchTemplateSpec{
Id: lt.ref,
Version: lt.AttrLatestVersionNumber,
},
})
func MultipartUserData_Custom ¶
Create a userdata object with custom content.
func MultipartUserData_ForLinux ¶
func MultipartUserData_ForLinux(options *LinuxUserDataOptions) UserData
Create a userdata object for Linux hosts.
func MultipartUserData_ForOperatingSystem ¶
func MultipartUserData_ForOperatingSystem(os OperatingSystemType) UserData
func MultipartUserData_ForWindows ¶
func MultipartUserData_ForWindows(options *WindowsUserDataOptions) UserData
Create a userdata object for Windows hosts.
func UserData_Custom ¶
Create a userdata object with custom content.
func UserData_ForLinux ¶
func UserData_ForLinux(options *LinuxUserDataOptions) UserData
Create a userdata object for Linux hosts.
func UserData_ForOperatingSystem ¶
func UserData_ForOperatingSystem(os OperatingSystemType) UserData
func UserData_ForWindows ¶
func UserData_ForWindows(options *WindowsUserDataOptions) UserData
Create a userdata object for Windows hosts.
type Volume ¶
type Volume interface {
awscdk.Resource
IVolume
// The availability zone that the EBS Volume is contained within (ex: us-west-2a).
AvailabilityZone() *string
// The customer-managed encryption key that is used to encrypt the Volume.
EncryptionKey() awskms.IKey
// The environment this resource belongs to.
//
// For resources that are created and managed by the CDK
// (generally, those created by creating new class instances like Role, Bucket, etc.),
// this is always the same as the environment of the stack they belong to;
// however, for imported resources
// (those obtained from static methods like fromRoleArn, fromBucketName, etc.),
// that might be different than the stack they were imported into.
Env() *awscdk.ResourceEnvironment
// The tree node.
Node() constructs.Node
// Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
//
// This value will resolve to one of the following:
// - a concrete value (e.g. `"my-awesome-bucket"`)
// - `undefined`, when a name should be generated by CloudFormation
// - a concrete name generated automatically during synthesis, in
// cross-environment scenarios.
PhysicalName() *string
// The stack in which this resource is defined.
Stack() awscdk.Stack
// The EBS Volume's ID.
VolumeId() *string
// Apply the given removal policy to this resource.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
GeneratePhysicalName() *string
// Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`).
//
// Normally, this token will resolve to `arnAttr`, but if the resource is
// referenced across environments, `arnComponents` will be used to synthesize
// a concrete ARN with the resource's physical name. Make sure to reference
// `this.physicalName` in `arnComponents`.
GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
// Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`).
//
// Normally, this token will resolve to `nameAttr`, but if the resource is
// referenced across environments, it will be resolved to `this.physicalName`,
// which will be a concrete name.
GetResourceNameAttribute(nameAttr *string) *string
// Grants permission to attach this Volume to an instance.
//
// CAUTION: Granting an instance permission to attach to itself using this method will lead to
// an unresolvable circular reference between the instance role and the instance.
// Use `IVolume.grantAttachVolumeToSelf` to grant an instance permission to attach this
// volume to itself.
GrantAttachVolume(grantee awsiam.IGrantable, instances *[]IInstance) awsiam.Grant
// Grants permission to attach the Volume by a ResourceTag condition.
//
// If you are looking to
// grant an Instance, AutoScalingGroup, EC2-Fleet, SpotFleet, ECS host, etc the ability to attach
// this volume to **itself** then this is the method you want to use.
//
// This is implemented by adding a Tag with key `VolumeGrantAttach-<suffix>` to the given
// constructs and this Volume, and then conditioning the Grant such that the grantee is only
// given the ability to AttachVolume if both the Volume and the destination Instance have that
// tag applied to them.
GrantAttachVolumeByResourceTag(grantee awsiam.IGrantable, constructs *[]constructs.Construct, tagKeySuffix *string) awsiam.Grant
// Grants permission to detach this Volume from an instance CAUTION: Granting an instance permission to detach from itself using this method will lead to an unresolvable circular reference between the instance role and the instance.
//
// Use `IVolume.grantDetachVolumeFromSelf` to grant an instance permission to detach this
// volume from itself.
GrantDetachVolume(grantee awsiam.IGrantable, instances *[]IInstance) awsiam.Grant
// Grants permission to detach the Volume by a ResourceTag condition.
//
// This is implemented via the same mechanism as `IVolume.grantAttachVolumeByResourceTag`,
// and is subject to the same conditions.
GrantDetachVolumeByResourceTag(grantee awsiam.IGrantable, constructs *[]constructs.Construct, tagKeySuffix *string) awsiam.Grant
// Returns a string representation of this construct.
ToString() *string
ValidateProps(props *VolumeProps)
}
Creates a new EBS Volume in AWS EC2.
Example:
var instance instance
var role role
volume := ec2.NewVolume(this, jsii.String("Volume"), &VolumeProps{
AvailabilityZone: jsii.String("us-west-2a"),
Size: awscdk.Size_Gibibytes(jsii.Number(500)),
Encrypted: jsii.Boolean(true),
})
volume.grantAttachVolume(role, []iInstance{
instance,
})
func NewVolume ¶
func NewVolume(scope constructs.Construct, id *string, props *VolumeProps) Volume
type VolumeAttributes ¶
type VolumeAttributes struct {
// The availability zone that the EBS Volume is contained within (ex: us-west-2a).
AvailabilityZone *string `field:"required" json:"availabilityZone" yaml:"availabilityZone"`
// The EBS Volume's ID.
VolumeId *string `field:"required" json:"volumeId" yaml:"volumeId"`
// The customer-managed encryption key that is used to encrypt the Volume.
// Default: None -- The EBS Volume is not using a customer-managed KMS key for encryption.
//
EncryptionKey awskms.IKey `field:"optional" json:"encryptionKey" yaml:"encryptionKey"`
}
Attributes required to import an existing EBS Volume into the Stack.
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"
import "github.com/aws/aws-cdk-go/awscdk"
var key key
volumeAttributes := &VolumeAttributes{
AvailabilityZone: jsii.String("availabilityZone"),
VolumeId: jsii.String("volumeId"),
// the properties below are optional
EncryptionKey: key,
}
type VolumeProps ¶
type VolumeProps struct {
// The Availability Zone in which to create the volume.
AvailabilityZone *string `field:"required" json:"availabilityZone" yaml:"availabilityZone"`
// Indicates whether the volume is auto-enabled for I/O operations.
//
// By default, Amazon EBS disables I/O to the volume from attached EC2
// instances when it determines that a volume's data is potentially inconsistent. If the consistency of the volume is not a concern, and
// you prefer that the volume be made available immediately if it's impaired, you can configure the volume to automatically enable I/O.
// Default: false.
//
AutoEnableIo *bool `field:"optional" json:"autoEnableIo" yaml:"autoEnableIo"`
// Indicates whether Amazon EBS Multi-Attach is enabled.
//
// See [Considerations and limitations](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-volumes-multi.html#considerations)
// for the constraints of multi-attach.
// Default: false.
//
EnableMultiAttach *bool `field:"optional" json:"enableMultiAttach" yaml:"enableMultiAttach"`
// Specifies whether the volume should be encrypted.
//
// The effect of setting the encryption state to true depends on the volume origin
// (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information,
// see [Encryption by Default](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-by-default)
// in the Amazon Elastic Compute Cloud User Guide.
//
// Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see
// [Supported Instance Types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#EBSEncryption_supported_instances).
// Default: false.
//
Encrypted *bool `field:"optional" json:"encrypted" yaml:"encrypted"`
// The customer-managed encryption key that is used to encrypt the Volume.
//
// The encrypted property must
// be true if this is provided.
//
// Note: If using an `aws-kms.IKey` created from a `aws-kms.Key.fromKeyArn()` here,
// then the KMS key **must** have the following in its Key policy; otherwise, the Volume
// will fail to create.
//
// {
// "Effect": "Allow",
// "Principal": { "AWS": "<arn for your account-user> ex: arn:aws:iam::00000000000:root" },
// "Resource": "*",
// "Action": [
// "kms:DescribeKey",
// "kms:GenerateDataKeyWithoutPlainText",
// ],
// "Condition": {
// "StringEquals": {
// "kms:ViaService": "ec2.<Region>.amazonaws.com", (eg: ec2.us-east-1.amazonaws.com)
// "kms:CallerAccount": "0000000000" (your account ID)
// }
// }
// }.
// Default: The default KMS key for the account, region, and EC2 service is used.
//
EncryptionKey awskms.IKey `field:"optional" json:"encryptionKey" yaml:"encryptionKey"`
// The number of I/O operations per second (IOPS) to provision for the volume.
//
// The maximum ratio is 50 IOPS/GiB for PROVISIONED_IOPS_SSD,
// and 500 IOPS/GiB for both PROVISIONED_IOPS_SSD_IO2 and GENERAL_PURPOSE_SSD_GP3.
// See https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html
// for more information.
//
// This parameter is valid only for PROVISIONED_IOPS_SSD, PROVISIONED_IOPS_SSD_IO2 and GENERAL_PURPOSE_SSD_GP3 volumes.
// Default: None -- Required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS if omitted.
//
Iops *float64 `field:"optional" json:"iops" yaml:"iops"`
// Policy to apply when the volume is removed from the stack.
// Default: RemovalPolicy.RETAIN
//
RemovalPolicy awscdk.RemovalPolicy `field:"optional" json:"removalPolicy" yaml:"removalPolicy"`
// The size of the volume, in GiBs.
//
// You must specify either a snapshot ID or a volume size.
// See https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html
// for details on the allowable size for each type of volume.
// Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.
//
Size awscdk.Size `field:"optional" json:"size" yaml:"size"`
// The snapshot from which to create the volume.
//
// You must specify either a snapshot ID or a volume size.
// Default: The EBS volume is not created from a snapshot.
//
SnapshotId *string `field:"optional" json:"snapshotId" yaml:"snapshotId"`
// The throughput that the volume supports, in MiB/s Takes a minimum of 125 and maximum of 1000.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-throughput
//
// Default: - 125 MiB/s. Only valid on gp3 volumes.
//
Throughput *float64 `field:"optional" json:"throughput" yaml:"throughput"`
// The value of the physicalName property of this resource.
// Default: The physical name will be allocated by CloudFormation at deployment time.
//
VolumeName *string `field:"optional" json:"volumeName" yaml:"volumeName"`
// The type of the volume;
//
// what type of storage to use to form the EBS Volume.
// Default: `EbsDeviceVolumeType.GENERAL_PURPOSE_SSD`
//
VolumeType EbsDeviceVolumeType `field:"optional" json:"volumeType" yaml:"volumeType"`
}
Properties of an EBS Volume.
Example:
var instance instance
var role role
volume := ec2.NewVolume(this, jsii.String("Volume"), &VolumeProps{
AvailabilityZone: jsii.String("us-west-2a"),
Size: awscdk.Size_Gibibytes(jsii.Number(500)),
Encrypted: jsii.Boolean(true),
})
volume.grantAttachVolume(role, []iInstance{
instance,
})
type Vpc ¶
type Vpc interface {
awscdk.Resource
IVpc
// AZs for this VPC.
AvailabilityZones() *[]*string
// Indicates if instances launched in this VPC will have public DNS hostnames.
DnsHostnamesEnabled() *bool
// Indicates if DNS support is enabled for this VPC.
DnsSupportEnabled() *bool
// The environment this resource belongs to.
//
// For resources that are created and managed by the CDK
// (generally, those created by creating new class instances like Role, Bucket, etc.),
// this is always the same as the environment of the stack they belong to;
// however, for imported resources
// (those obtained from static methods like fromRoleArn, fromBucketName, etc.),
// that might be different than the stack they were imported into.
Env() *awscdk.ResourceEnvironment
// If this is set to true, don't error out on trying to select subnets.
IncompleteSubnetDefinition() *bool
SetIncompleteSubnetDefinition(val *bool)
// Dependencies for internet connectivity.
InternetConnectivityEstablished() constructs.IDependable
// Internet Gateway for the VPC.
//
// Note that in case the VPC is configured only
// with ISOLATED subnets, this attribute will be `undefined`.
InternetGatewayId() *string
// List of isolated subnets in this VPC.
IsolatedSubnets() *[]ISubnet
// The tree node.
Node() constructs.Node
// Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
//
// This value will resolve to one of the following:
// - a concrete value (e.g. `"my-awesome-bucket"`)
// - `undefined`, when a name should be generated by CloudFormation
// - a concrete name generated automatically during synthesis, in
// cross-environment scenarios.
PhysicalName() *string
// List of private subnets in this VPC.
PrivateSubnets() *[]ISubnet
// List of public subnets in this VPC.
PublicSubnets() *[]ISubnet
// The stack in which this resource is defined.
Stack() awscdk.Stack
// Arn of this VPC.
VpcArn() *string
// CIDR range for this VPC.
VpcCidrBlock() *string
VpcCidrBlockAssociations() *[]*string
VpcDefaultNetworkAcl() *string
VpcDefaultSecurityGroup() *string
// Identifier for this VPC.
VpcId() *string
VpcIpv6CidrBlocks() *[]*string
// Returns the id of the VPN Gateway (if enabled).
VpnGatewayId() *string
// Adds a new client VPN endpoint to this VPC.
AddClientVpnEndpoint(id *string, options *ClientVpnEndpointOptions) ClientVpnEndpoint
// Adds a new flow log to this VPC.
AddFlowLog(id *string, options *FlowLogOptions) FlowLog
// Adds a new gateway endpoint to this VPC.
AddGatewayEndpoint(id *string, options *GatewayVpcEndpointOptions) GatewayVpcEndpoint
// Adds a new interface endpoint to this VPC.
AddInterfaceEndpoint(id *string, options *InterfaceVpcEndpointOptions) InterfaceVpcEndpoint
// Adds a new VPN connection to this VPC.
AddVpnConnection(id *string, options *VpnConnectionOptions) VpnConnection
// Apply the given removal policy to this resource.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
// Adds a VPN Gateway to this VPC.
EnableVpnGateway(options *EnableVpnGatewayOptions)
GeneratePhysicalName() *string
// Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`).
//
// Normally, this token will resolve to `arnAttr`, but if the resource is
// referenced across environments, `arnComponents` will be used to synthesize
// a concrete ARN with the resource's physical name. Make sure to reference
// `this.physicalName` in `arnComponents`.
GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
// Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`).
//
// Normally, this token will resolve to `nameAttr`, but if the resource is
// referenced across environments, it will be resolved to `this.physicalName`,
// which will be a concrete name.
GetResourceNameAttribute(nameAttr *string) *string
// Return the subnets appropriate for the placement strategy.
SelectSubnetObjects(selection *SubnetSelection) *[]ISubnet
// Returns IDs of selected subnets.
SelectSubnets(selection *SubnetSelection) *SelectedSubnets
// Returns a string representation of this construct.
ToString() *string
}
Define an AWS Virtual Private Cloud.
See the package-level documentation of this package for an overview of the various dimensions in which you can configure your VPC.
For example:
```ts
const vpc = new ec2.Vpc(this, 'TheVPC', {
ipAddresses: ec2.IpAddresses.cidr('10.0.0.0/16'),
})
// Iterate the private subnets
const selection = vpc.selectSubnets({
subnetType: ec2.SubnetType.PRIVATE_WITH_EGRESS
});
for (const subnet of selection.subnets) {
// ...
}
```.
Example:
import "github.com/aws/aws-cdk-go/awscdk"
vpc := ec2.NewVpc(this, jsii.String("Vpc"), &VpcProps{
IpAddresses: ec2.IpAddresses_Cidr(jsii.String("10.0.0.0/16")),
})
vpcConnector := apprunner.NewVpcConnector(this, jsii.String("VpcConnector"), &VpcConnectorProps{
Vpc: Vpc,
VpcSubnets: vpc.selectSubnets(&SubnetSelection{
SubnetType: ec2.SubnetType_PUBLIC,
}),
VpcConnectorName: jsii.String("MyVpcConnector"),
})
apprunner.NewService(this, jsii.String("Service"), &ServiceProps{
Source: apprunner.Source_FromEcrPublic(&EcrPublicProps{
ImageConfiguration: &ImageConfiguration{
Port: jsii.Number(8000),
},
ImageIdentifier: jsii.String("public.ecr.aws/aws-containers/hello-app-runner:latest"),
}),
VpcConnector: VpcConnector,
})
func NewVpc ¶
Vpc creates a VPC that spans a whole region.
It will automatically divide the provided VPC CIDR range, and create public and private subnets per Availability Zone. Network routing for the public subnets will be configured to allow outbound access directly via an Internet Gateway. Network routing for the private subnets will be configured to allow outbound access via a set of resilient NAT Gateways (one per AZ).
type VpcAttributes ¶
type VpcAttributes struct {
// List of availability zones for the subnets in this VPC.
AvailabilityZones *[]*string `field:"required" json:"availabilityZones" yaml:"availabilityZones"`
// VPC's identifier.
VpcId *string `field:"required" json:"vpcId" yaml:"vpcId"`
// List of isolated subnet IDs.
//
// Must be undefined or match the availability zones in length and order.
// Default: - The VPC does not have any isolated subnets.
//
IsolatedSubnetIds *[]*string `field:"optional" json:"isolatedSubnetIds" yaml:"isolatedSubnetIds"`
// List of IPv4 CIDR blocks for the isolated subnets.
//
// Must be undefined or have an entry for every isolated subnet group.
// Default: - Retrieving the IPv4 CIDR block of any isolated subnet will fail.
//
IsolatedSubnetIpv4CidrBlocks *[]*string `field:"optional" json:"isolatedSubnetIpv4CidrBlocks" yaml:"isolatedSubnetIpv4CidrBlocks"`
// List of names for the isolated subnets.
//
// Must be undefined or have a name for every isolated subnet group.
// Default: - All isolated subnets will have the name `Isolated`.
//
IsolatedSubnetNames *[]*string `field:"optional" json:"isolatedSubnetNames" yaml:"isolatedSubnetNames"`
// List of IDs of route tables for the isolated subnets.
//
// Must be undefined or have a name for every isolated subnet group.
// Default: - Retrieving the route table ID of any isolated subnet will fail.
//
IsolatedSubnetRouteTableIds *[]*string `field:"optional" json:"isolatedSubnetRouteTableIds" yaml:"isolatedSubnetRouteTableIds"`
// List of private subnet IDs.
//
// Must be undefined or match the availability zones in length and order.
// Default: - The VPC does not have any private subnets.
//
PrivateSubnetIds *[]*string `field:"optional" json:"privateSubnetIds" yaml:"privateSubnetIds"`
// List of IPv4 CIDR blocks for the private subnets.
//
// Must be undefined or have an entry for every private subnet group.
// Default: - Retrieving the IPv4 CIDR block of any private subnet will fail.
//
PrivateSubnetIpv4CidrBlocks *[]*string `field:"optional" json:"privateSubnetIpv4CidrBlocks" yaml:"privateSubnetIpv4CidrBlocks"`
// List of names for the private subnets.
//
// Must be undefined or have a name for every private subnet group.
// Default: - All private subnets will have the name `Private`.
//
PrivateSubnetNames *[]*string `field:"optional" json:"privateSubnetNames" yaml:"privateSubnetNames"`
// List of IDs of route tables for the private subnets.
//
// Must be undefined or have a name for every private subnet group.
// Default: - Retrieving the route table ID of any private subnet will fail.
//
PrivateSubnetRouteTableIds *[]*string `field:"optional" json:"privateSubnetRouteTableIds" yaml:"privateSubnetRouteTableIds"`
// List of public subnet IDs.
//
// Must be undefined or match the availability zones in length and order.
// Default: - The VPC does not have any public subnets.
//
PublicSubnetIds *[]*string `field:"optional" json:"publicSubnetIds" yaml:"publicSubnetIds"`
// List of IPv4 CIDR blocks for the public subnets.
//
// Must be undefined or have an entry for every public subnet group.
// Default: - Retrieving the IPv4 CIDR block of any public subnet will fail.
//
PublicSubnetIpv4CidrBlocks *[]*string `field:"optional" json:"publicSubnetIpv4CidrBlocks" yaml:"publicSubnetIpv4CidrBlocks"`
// List of names for the public subnets.
//
// Must be undefined or have a name for every public subnet group.
// Default: - All public subnets will have the name `Public`.
//
PublicSubnetNames *[]*string `field:"optional" json:"publicSubnetNames" yaml:"publicSubnetNames"`
// List of IDs of route tables for the public subnets.
//
// Must be undefined or have a name for every public subnet group.
// Default: - Retrieving the route table ID of any public subnet will fail.
//
PublicSubnetRouteTableIds *[]*string `field:"optional" json:"publicSubnetRouteTableIds" yaml:"publicSubnetRouteTableIds"`
// The region the VPC is in.
// Default: - The region of the stack where the VPC belongs to.
//
Region *string `field:"optional" json:"region" yaml:"region"`
// VPC's CIDR range.
// Default: - Retrieving the CIDR from the VPC will fail.
//
VpcCidrBlock *string `field:"optional" json:"vpcCidrBlock" yaml:"vpcCidrBlock"`
// VPN gateway's identifier.
VpnGatewayId *string `field:"optional" json:"vpnGatewayId" yaml:"vpnGatewayId"`
}
Properties that reference an external Vpc.
Example:
vpc := ec2.Vpc_FromVpcAttributes(this, jsii.String("VPC"), &VpcAttributes{
VpcId: jsii.String("vpc-1234"),
AvailabilityZones: []*string{
jsii.String("us-east-1a"),
jsii.String("us-east-1b"),
},
// Either pass literals for all IDs
PublicSubnetIds: []*string{
jsii.String("s-12345"),
jsii.String("s-67890"),
},
// OR: import a list of known length
PrivateSubnetIds: awscdk.Fn_ImportListValue(jsii.String("PrivateSubnetIds"), jsii.Number(2)),
// OR: split an imported string to a list of known length
IsolatedSubnetIds: awscdk.Fn_Split(jsii.String(","), ssm.StringParameter_ValueForStringParameter(this, jsii.String("MyParameter")), jsii.Number(2)),
})
type VpcEndpoint ¶
type VpcEndpoint interface {
awscdk.Resource
IVpcEndpoint
// The environment this resource belongs to.
//
// For resources that are created and managed by the CDK
// (generally, those created by creating new class instances like Role, Bucket, etc.),
// this is always the same as the environment of the stack they belong to;
// however, for imported resources
// (those obtained from static methods like fromRoleArn, fromBucketName, etc.),
// that might be different than the stack they were imported into.
Env() *awscdk.ResourceEnvironment
// The tree node.
Node() constructs.Node
// Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
//
// This value will resolve to one of the following:
// - a concrete value (e.g. `"my-awesome-bucket"`)
// - `undefined`, when a name should be generated by CloudFormation
// - a concrete name generated automatically during synthesis, in
// cross-environment scenarios.
PhysicalName() *string
PolicyDocument() awsiam.PolicyDocument
SetPolicyDocument(val awsiam.PolicyDocument)
// The stack in which this resource is defined.
Stack() awscdk.Stack
// The VPC endpoint identifier.
VpcEndpointId() *string
// Adds a statement to the policy document of the VPC endpoint. The statement must have a Principal.
//
// Not all interface VPC endpoints support policy. For more information
// see https://docs.aws.amazon.com/vpc/latest/userguide/vpce-interface.html
AddToPolicy(statement awsiam.PolicyStatement)
// Apply the given removal policy to this resource.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
GeneratePhysicalName() *string
// Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`).
//
// Normally, this token will resolve to `arnAttr`, but if the resource is
// referenced across environments, `arnComponents` will be used to synthesize
// a concrete ARN with the resource's physical name. Make sure to reference
// `this.physicalName` in `arnComponents`.
GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
// Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`).
//
// Normally, this token will resolve to `nameAttr`, but if the resource is
// referenced across environments, it will be resolved to `this.physicalName`,
// which will be a concrete name.
GetResourceNameAttribute(nameAttr *string) *string
// Returns a string representation of this construct.
ToString() *string
}
type VpcEndpointService ¶
type VpcEndpointService interface {
awscdk.Resource
IVpcEndpointService
// Whether to require manual acceptance of new connections to the service.
AcceptanceRequired() *bool
// One or more Principal ARNs to allow inbound connections to.
AllowedPrincipals() *[]awsiam.ArnPrincipal
// Whether to enable the built-in Contributor Insights rules provided by AWS PrivateLink.
ContributorInsightsEnabled() *bool
// The environment this resource belongs to.
//
// For resources that are created and managed by the CDK
// (generally, those created by creating new class instances like Role, Bucket, etc.),
// this is always the same as the environment of the stack they belong to;
// however, for imported resources
// (those obtained from static methods like fromRoleArn, fromBucketName, etc.),
// that might be different than the stack they were imported into.
Env() *awscdk.ResourceEnvironment
// The tree node.
Node() constructs.Node
// Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
//
// This value will resolve to one of the following:
// - a concrete value (e.g. `"my-awesome-bucket"`)
// - `undefined`, when a name should be generated by CloudFormation
// - a concrete name generated automatically during synthesis, in
// cross-environment scenarios.
PhysicalName() *string
// The stack in which this resource is defined.
Stack() awscdk.Stack
// The id of the VPC Endpoint Service, like vpce-svc-xxxxxxxxxxxxxxxx.
VpcEndpointServiceId() *string
// One or more network load balancers to host the service.
VpcEndpointServiceLoadBalancers() *[]IVpcEndpointServiceLoadBalancer
// The service name of the VPC Endpoint Service that clients use to connect to, like com.amazonaws.vpce.<region>.vpce-svc-xxxxxxxxxxxxxxxx.
VpcEndpointServiceName() *string
// Apply the given removal policy to this resource.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
GeneratePhysicalName() *string
// Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`).
//
// Normally, this token will resolve to `arnAttr`, but if the resource is
// referenced across environments, `arnComponents` will be used to synthesize
// a concrete ARN with the resource's physical name. Make sure to reference
// `this.physicalName` in `arnComponents`.
GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
// Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`).
//
// Normally, this token will resolve to `nameAttr`, but if the resource is
// referenced across environments, it will be resolved to `this.physicalName`,
// which will be a concrete name.
GetResourceNameAttribute(nameAttr *string) *string
// Returns a string representation of this construct.
ToString() *string
}
A VPC endpoint service.
Example:
var networkLoadBalancer1 networkLoadBalancer
var networkLoadBalancer2 networkLoadBalancer
ec2.NewVpcEndpointService(this, jsii.String("EndpointService"), &VpcEndpointServiceProps{
VpcEndpointServiceLoadBalancers: []iVpcEndpointServiceLoadBalancer{
networkLoadBalancer1,
networkLoadBalancer2,
},
AcceptanceRequired: jsii.Boolean(true),
AllowedPrincipals: []arnPrincipal{
iam.NewArnPrincipal(jsii.String("arn:aws:iam::123456789012:root")),
},
ContributorInsights: jsii.Boolean(true),
})
func NewVpcEndpointService ¶
func NewVpcEndpointService(scope constructs.Construct, id *string, props *VpcEndpointServiceProps) VpcEndpointService
type VpcEndpointServiceProps ¶
type VpcEndpointServiceProps struct {
// One or more load balancers to host the VPC Endpoint Service.
VpcEndpointServiceLoadBalancers *[]IVpcEndpointServiceLoadBalancer `field:"required" json:"vpcEndpointServiceLoadBalancers" yaml:"vpcEndpointServiceLoadBalancers"`
// Whether requests from service consumers to connect to the service through an endpoint must be accepted.
// Default: true.
//
AcceptanceRequired *bool `field:"optional" json:"acceptanceRequired" yaml:"acceptanceRequired"`
// IAM users, IAM roles, or AWS accounts to allow inbound connections from.
//
// These principals can connect to your service using VPC endpoints. Takes a
// list of one or more ArnPrincipal.
// Default: - no principals.
//
AllowedPrincipals *[]awsiam.ArnPrincipal `field:"optional" json:"allowedPrincipals" yaml:"allowedPrincipals"`
// Indicates whether to enable the built-in Contributor Insights rules provided by AWS PrivateLink.
// Default: false.
//
ContributorInsights *bool `field:"optional" json:"contributorInsights" yaml:"contributorInsights"`
}
Construction properties for a VpcEndpointService.
Example:
var networkLoadBalancer1 networkLoadBalancer
var networkLoadBalancer2 networkLoadBalancer
ec2.NewVpcEndpointService(this, jsii.String("EndpointService"), &VpcEndpointServiceProps{
VpcEndpointServiceLoadBalancers: []iVpcEndpointServiceLoadBalancer{
networkLoadBalancer1,
networkLoadBalancer2,
},
AcceptanceRequired: jsii.Boolean(true),
AllowedPrincipals: []arnPrincipal{
iam.NewArnPrincipal(jsii.String("arn:aws:iam::123456789012:root")),
},
ContributorInsights: jsii.Boolean(true),
})
type VpcEndpointType ¶
type VpcEndpointType string
The type of VPC endpoint.
const ( // Interface. // // An interface endpoint is an elastic network interface with a private IP // address that serves as an entry point for traffic destined to a supported // service. VpcEndpointType_INTERFACE VpcEndpointType = "INTERFACE" // Gateway. // // A gateway endpoint is a gateway that is a target for a specified route in // your route table, used for traffic destined to a supported AWS service. VpcEndpointType_GATEWAY VpcEndpointType = "GATEWAY" )
type VpcIpamOptions ¶ added in v2.48.0
type VpcIpamOptions struct {
// CIDR Block for Vpc.
// Default: - Only required when Ipam has concrete allocation available for static Vpc.
//
CidrBlock *string `field:"optional" json:"cidrBlock" yaml:"cidrBlock"`
// ipv4 IPAM Pool Id.
// Default: - Only required when using AWS Ipam.
//
Ipv4IpamPoolId *string `field:"optional" json:"ipv4IpamPoolId" yaml:"ipv4IpamPoolId"`
// CIDR Mask for Vpc.
// Default: - Only required when using AWS Ipam.
//
Ipv4NetmaskLength *float64 `field:"optional" json:"ipv4NetmaskLength" yaml:"ipv4NetmaskLength"`
}
CIDR Allocated Vpc.
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"
vpcIpamOptions := &VpcIpamOptions{
CidrBlock: jsii.String("cidrBlock"),
Ipv4IpamPoolId: jsii.String("ipv4IpamPoolId"),
Ipv4NetmaskLength: jsii.Number(123),
}
type VpcLookupOptions ¶
type VpcLookupOptions struct {
// Whether to match the default VPC.
// Default: Don't care whether we return the default VPC.
//
IsDefault *bool `field:"optional" json:"isDefault" yaml:"isDefault"`
// The ID of the AWS account that owns the VPC.
// Default: the account id of the parent stack.
//
OwnerAccountId *string `field:"optional" json:"ownerAccountId" yaml:"ownerAccountId"`
// Optional to override inferred region.
// Default: Current stack's environment region.
//
Region *string `field:"optional" json:"region" yaml:"region"`
// Whether to look up whether a VPN Gateway is attached to the looked up VPC.
//
// You can set this to `false` if you know the VPC does not have a VPN Gateway
// attached, in order to avoid an API call.
//
// If you change this property from `false` to `true` or undefined, you may
// need to clear the corresponding context entry in `cdk.context.json` in
// order to trigger a new lookup.
// Default: true.
//
ReturnVpnGateways *bool `field:"optional" json:"returnVpnGateways" yaml:"returnVpnGateways"`
// Optional tag for subnet group name.
//
// If not provided, we'll look at the aws-cdk:subnet-name tag.
// If the subnet does not have the specified tag,
// we'll use its type as the name.
// Default: aws-cdk:subnet-name.
//
SubnetGroupNameTag *string `field:"optional" json:"subnetGroupNameTag" yaml:"subnetGroupNameTag"`
// Tags on the VPC.
//
// The VPC must have all of these tags.
// Default: Don't filter on tags.
//
Tags *map[string]*string `field:"optional" json:"tags" yaml:"tags"`
// The ID of the VPC.
//
// If given, will import exactly this VPC.
// Default: Don't filter on vpcId.
//
VpcId *string `field:"optional" json:"vpcId" yaml:"vpcId"`
// The name of the VPC.
//
// If given, will import the VPC with this name.
// Default: Don't filter on vpcName.
//
VpcName *string `field:"optional" json:"vpcName" yaml:"vpcName"`
}
Properties for looking up an existing VPC.
The combination of properties must specify filter down to exactly one non-default VPC, otherwise an error is raised.
Example:
vpc := ec2.Vpc_FromLookup(this, jsii.String("Vpc"), &VpcLookupOptions{
IsDefault: jsii.Boolean(true),
})
cluster := ecs.NewCluster(this, jsii.String("ECSCluster"), &ClusterProps{
Vpc: Vpc,
})
taskDefinition := ecs.NewTaskDefinition(this, jsii.String("TD"), &TaskDefinitionProps{
Compatibility: ecs.Compatibility_EC2,
})
taskDefinition.AddContainer(jsii.String("TheContainer"), &ContainerDefinitionOptions{
Image: ecs.ContainerImage_FromRegistry(jsii.String("foo/bar")),
MemoryLimitMiB: jsii.Number(256),
})
runTask := tasks.NewEcsRunTask(this, jsii.String("Run"), &EcsRunTaskProps{
IntegrationPattern: sfn.IntegrationPattern_RUN_JOB,
Cluster: Cluster,
TaskDefinition: TaskDefinition,
LaunchTarget: tasks.NewEcsEc2LaunchTarget(),
EnableExecuteCommand: jsii.Boolean(true),
})
type VpcProps ¶
type VpcProps struct {
// Availability zones this VPC spans.
//
// Specify this option only if you do not specify `maxAzs`.
// Default: - a subset of AZs of the stack.
//
AvailabilityZones *[]*string `field:"optional" json:"availabilityZones" yaml:"availabilityZones"`
// The CIDR range to use for the VPC, e.g. '10.0.0.0/16'.
//
// Should be a minimum of /28 and maximum size of /16. The range will be
// split across all subnets per Availability Zone.
// Default: Vpc.DEFAULT_CIDR_RANGE
//
// Deprecated: Use ipAddresses instead.
Cidr *string `field:"optional" json:"cidr" yaml:"cidr"`
// If set to false then disable the creation of the default internet gateway.
// Default: true.
//
CreateInternetGateway *bool `field:"optional" json:"createInternetGateway" yaml:"createInternetGateway"`
// The default tenancy of instances launched into the VPC.
//
// By setting this to dedicated tenancy, instances will be launched on
// hardware dedicated to a single AWS customer, unless specifically specified
// at instance launch time. Please note, not all instance types are usable
// with Dedicated tenancy.
// Default: DefaultInstanceTenancy.Default (shared) tenancy
//
DefaultInstanceTenancy DefaultInstanceTenancy `field:"optional" json:"defaultInstanceTenancy" yaml:"defaultInstanceTenancy"`
// Indicates whether the instances launched in the VPC get public DNS hostnames.
//
// If this attribute is true, instances in the VPC get public DNS hostnames,
// but only if the enableDnsSupport attribute is also set to true.
// Default: true.
//
EnableDnsHostnames *bool `field:"optional" json:"enableDnsHostnames" yaml:"enableDnsHostnames"`
// Indicates whether the DNS resolution is supported for the VPC.
//
// If this attribute is false, the Amazon-provided DNS server in the VPC that
// resolves public DNS hostnames to IP addresses is not enabled. If this
// attribute is true, queries to the Amazon provided DNS server at the
// 169.254.169.253 IP address, or the reserved IP address at the base of the
// VPC IPv4 network range plus two will succeed.
// Default: true.
//
EnableDnsSupport *bool `field:"optional" json:"enableDnsSupport" yaml:"enableDnsSupport"`
// Flow logs to add to this VPC.
// Default: - No flow logs.
//
FlowLogs *map[string]*FlowLogOptions `field:"optional" json:"flowLogs" yaml:"flowLogs"`
// Gateway endpoints to add to this VPC.
// Default: - None.
//
GatewayEndpoints *map[string]*GatewayVpcEndpointOptions `field:"optional" json:"gatewayEndpoints" yaml:"gatewayEndpoints"`
// The Provider to use to allocate IPv4 Space to your VPC.
//
// Options include static allocation or from a pool.
//
// Note this is specific to IPv4 addresses.
// Default: ec2.IpAddresses.cidr
//
IpAddresses IIpAddresses `field:"optional" json:"ipAddresses" yaml:"ipAddresses"`
// The protocol of the vpc.
//
// Options are IPv4 only or dual stack.
// Default: IpProtocol.IPV4_ONLY
//
IpProtocol IpProtocol `field:"optional" json:"ipProtocol" yaml:"ipProtocol"`
// The Provider to use to allocate IPv6 Space to your VPC.
//
// Options include amazon provided CIDR block.
//
// Note this is specific to IPv6 addresses.
// Default: Ipv6Addresses.amazonProvided
//
Ipv6Addresses IIpv6Addresses `field:"optional" json:"ipv6Addresses" yaml:"ipv6Addresses"`
// Define the maximum number of AZs to use in this region.
//
// If the region has more AZs than you want to use (for example, because of
// EIP limits), pick a lower number here. The AZs will be sorted and picked
// from the start of the list.
//
// If you pick a higher number than the number of AZs in the region, all AZs
// in the region will be selected. To use "all AZs" available to your
// account, use a high number (such as 99).
//
// Be aware that environment-agnostic stacks will be created with access to
// only 2 AZs, so to use more than 2 AZs, be sure to specify the account and
// region on your stack.
//
// Specify this option only if you do not specify `availabilityZones`.
// Default: 3.
//
MaxAzs *float64 `field:"optional" json:"maxAzs" yaml:"maxAzs"`
// What type of NAT provider to use.
//
// Select between NAT gateways or NAT instances. NAT gateways
// may not be available in all AWS regions.
// Default: NatProvider.gateway()
//
NatGatewayProvider NatProvider `field:"optional" json:"natGatewayProvider" yaml:"natGatewayProvider"`
// The number of NAT Gateways/Instances to create.
//
// The type of NAT gateway or instance will be determined by the
// `natGatewayProvider` parameter.
//
// You can set this number lower than the number of Availability Zones in your
// VPC in order to save on NAT cost. Be aware you may be charged for
// cross-AZ data traffic instead.
// Default: - One NAT gateway/instance per Availability Zone.
//
NatGateways *float64 `field:"optional" json:"natGateways" yaml:"natGateways"`
// Configures the subnets which will have NAT Gateways/Instances.
//
// You can pick a specific group of subnets by specifying the group name;
// the picked subnets must be public subnets.
//
// Only necessary if you have more than one public subnet group.
// Default: - All public subnets.
//
NatGatewaySubnets *SubnetSelection `field:"optional" json:"natGatewaySubnets" yaml:"natGatewaySubnets"`
// Define the number of AZs to reserve.
//
// When specified, the IP space is reserved for the azs but no actual
// resources are provisioned.
// Default: 0.
//
ReservedAzs *float64 `field:"optional" json:"reservedAzs" yaml:"reservedAzs"`
// If set to true then the default inbound & outbound rules will be removed from the default security group.
// Default: true if '@aws-cdk/aws-ec2:restrictDefaultSecurityGroup' is enabled, false otherwise.
//
RestrictDefaultSecurityGroup *bool `field:"optional" json:"restrictDefaultSecurityGroup" yaml:"restrictDefaultSecurityGroup"`
// Configure the subnets to build for each AZ.
//
// Each entry in this list configures a Subnet Group; each group will contain a
// subnet for each Availability Zone.
//
// For example, if you want 1 public subnet, 1 private subnet, and 1 isolated
// subnet in each AZ provide the following:
//
// “`ts
// new ec2.Vpc(this, 'VPC', {
// subnetConfiguration: [
// {
// cidrMask: 24,
// name: 'ingress',
// subnetType: ec2.SubnetType.PUBLIC,
// },
// {
// cidrMask: 24,
// name: 'application',
// subnetType: ec2.SubnetType.PRIVATE_WITH_EGRESS,
// },
// {
// cidrMask: 28,
// name: 'rds',
// subnetType: ec2.SubnetType.PRIVATE_ISOLATED,
// }
// ]
// });
// “`.
// Default: - The VPC CIDR will be evenly divided between 1 public and 1
// private subnet per AZ.
//
SubnetConfiguration *[]*SubnetConfiguration `field:"optional" json:"subnetConfiguration" yaml:"subnetConfiguration"`
// The VPC name.
//
// Since the VPC resource doesn't support providing a physical name, the value provided here will be recorded in the `Name` tag.
// Default: this.node.path
//
VpcName *string `field:"optional" json:"vpcName" yaml:"vpcName"`
// VPN connections to this VPC.
// Default: - No connections.
//
VpnConnections *map[string]*VpnConnectionOptions `field:"optional" json:"vpnConnections" yaml:"vpnConnections"`
// Indicates whether a VPN gateway should be created and attached to this VPC.
// Default: - true when vpnGatewayAsn or vpnConnections is specified.
//
VpnGateway *bool `field:"optional" json:"vpnGateway" yaml:"vpnGateway"`
// The private Autonomous System Number (ASN) for the VPN gateway.
// Default: - Amazon default ASN.
//
VpnGatewayAsn *float64 `field:"optional" json:"vpnGatewayAsn" yaml:"vpnGatewayAsn"`
// Where to propagate VPN routes.
// Default: - On the route tables associated with private subnets. If no
// private subnets exists, isolated subnets are used. If no isolated subnets
// exists, public subnets are used.
//
VpnRoutePropagation *[]*SubnetSelection `field:"optional" json:"vpnRoutePropagation" yaml:"vpnRoutePropagation"`
}
Configuration for Vpc.
Example:
import "github.com/aws/aws-cdk-go/awscdk"
vpc := ec2.NewVpc(this, jsii.String("Vpc"), &VpcProps{
IpAddresses: ec2.IpAddresses_Cidr(jsii.String("10.0.0.0/16")),
})
vpcConnector := apprunner.NewVpcConnector(this, jsii.String("VpcConnector"), &VpcConnectorProps{
Vpc: Vpc,
VpcSubnets: vpc.selectSubnets(&SubnetSelection{
SubnetType: ec2.SubnetType_PUBLIC,
}),
VpcConnectorName: jsii.String("MyVpcConnector"),
})
apprunner.NewService(this, jsii.String("Service"), &ServiceProps{
Source: apprunner.Source_FromEcrPublic(&EcrPublicProps{
ImageConfiguration: &ImageConfiguration{
Port: jsii.Number(8000),
},
ImageIdentifier: jsii.String("public.ecr.aws/aws-containers/hello-app-runner:latest"),
}),
VpcConnector: VpcConnector,
})
type VpnConnection ¶
type VpnConnection interface {
VpnConnectionBase
// The ASN of the customer gateway.
CustomerGatewayAsn() *float64
// The id of the customer gateway.
CustomerGatewayId() *string
// The ip address of the customer gateway.
CustomerGatewayIp() *string
// The environment this resource belongs to.
//
// For resources that are created and managed by the CDK
// (generally, those created by creating new class instances like Role, Bucket, etc.),
// this is always the same as the environment of the stack they belong to;
// however, for imported resources
// (those obtained from static methods like fromRoleArn, fromBucketName, etc.),
// that might be different than the stack they were imported into.
Env() *awscdk.ResourceEnvironment
// The tree node.
Node() constructs.Node
// Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
//
// This value will resolve to one of the following:
// - a concrete value (e.g. `"my-awesome-bucket"`)
// - `undefined`, when a name should be generated by CloudFormation
// - a concrete name generated automatically during synthesis, in
// cross-environment scenarios.
PhysicalName() *string
// The stack in which this resource is defined.
Stack() awscdk.Stack
// The id of the VPN connection.
VpnId() *string
// Apply the given removal policy to this resource.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
GeneratePhysicalName() *string
// Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`).
//
// Normally, this token will resolve to `arnAttr`, but if the resource is
// referenced across environments, `arnComponents` will be used to synthesize
// a concrete ARN with the resource's physical name. Make sure to reference
// `this.physicalName` in `arnComponents`.
GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
// Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`).
//
// Normally, this token will resolve to `nameAttr`, but if the resource is
// referenced across environments, it will be resolved to `this.physicalName`,
// which will be a concrete name.
GetResourceNameAttribute(nameAttr *string) *string
// Return the given named metric for this VPNConnection.
Metric(metricName *string, props *awscloudwatch.MetricOptions) awscloudwatch.Metric
// The bytes received through the VPN tunnel.
//
// Sum over 5 minutes.
MetricTunnelDataIn(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
// The bytes sent through the VPN tunnel.
//
// Sum over 5 minutes.
MetricTunnelDataOut(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
// The state of the tunnel. 0 indicates DOWN and 1 indicates UP.
//
// Average over 5 minutes.
MetricTunnelState(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
// Returns a string representation of this construct.
ToString() *string
}
Define a VPN Connection.
Example:
// Across all tunnels in the account/region
allDataOut := ec2.VpnConnection_MetricAllTunnelDataOut()
// For a specific vpn connection
vpnConnection := vpc.addVpnConnection(jsii.String("Dynamic"), &VpnConnectionOptions{
Ip: jsii.String("1.2.3.4"),
})
state := vpnConnection.metricTunnelState()
func NewVpnConnection ¶
func NewVpnConnection(scope constructs.Construct, id *string, props *VpnConnectionProps) VpnConnection
type VpnConnectionAttributes ¶ added in v2.43.0
type VpnConnectionAttributes struct {
// The ASN of the customer gateway.
CustomerGatewayAsn *float64 `field:"required" json:"customerGatewayAsn" yaml:"customerGatewayAsn"`
// The id of the customer gateway.
CustomerGatewayId *string `field:"required" json:"customerGatewayId" yaml:"customerGatewayId"`
// The ip address of the customer gateway.
CustomerGatewayIp *string `field:"required" json:"customerGatewayIp" yaml:"customerGatewayIp"`
// The id of the VPN connection.
VpnId *string `field:"required" json:"vpnId" yaml:"vpnId"`
}
Attributes of an imported VpnConnection.
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"
vpnConnectionAttributes := &VpnConnectionAttributes{
CustomerGatewayAsn: jsii.Number(123),
CustomerGatewayId: jsii.String("customerGatewayId"),
CustomerGatewayIp: jsii.String("customerGatewayIp"),
VpnId: jsii.String("vpnId"),
}
type VpnConnectionBase ¶ added in v2.43.0
type VpnConnectionBase interface {
awscdk.Resource
IVpnConnection
// The ASN of the customer gateway.
CustomerGatewayAsn() *float64
// The id of the customer gateway.
CustomerGatewayId() *string
// The ip address of the customer gateway.
CustomerGatewayIp() *string
// The environment this resource belongs to.
//
// For resources that are created and managed by the CDK
// (generally, those created by creating new class instances like Role, Bucket, etc.),
// this is always the same as the environment of the stack they belong to;
// however, for imported resources
// (those obtained from static methods like fromRoleArn, fromBucketName, etc.),
// that might be different than the stack they were imported into.
Env() *awscdk.ResourceEnvironment
// The tree node.
Node() constructs.Node
// Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
//
// This value will resolve to one of the following:
// - a concrete value (e.g. `"my-awesome-bucket"`)
// - `undefined`, when a name should be generated by CloudFormation
// - a concrete name generated automatically during synthesis, in
// cross-environment scenarios.
PhysicalName() *string
// The stack in which this resource is defined.
Stack() awscdk.Stack
// The id of the VPN connection.
VpnId() *string
// Apply the given removal policy to this resource.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
GeneratePhysicalName() *string
// Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`).
//
// Normally, this token will resolve to `arnAttr`, but if the resource is
// referenced across environments, `arnComponents` will be used to synthesize
// a concrete ARN with the resource's physical name. Make sure to reference
// `this.physicalName` in `arnComponents`.
GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
// Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`).
//
// Normally, this token will resolve to `nameAttr`, but if the resource is
// referenced across environments, it will be resolved to `this.physicalName`,
// which will be a concrete name.
GetResourceNameAttribute(nameAttr *string) *string
// Return the given named metric for this VPNConnection.
Metric(metricName *string, props *awscloudwatch.MetricOptions) awscloudwatch.Metric
// The bytes received through the VPN tunnel.
//
// Sum over 5 minutes.
MetricTunnelDataIn(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
// The bytes sent through the VPN tunnel.
//
// Sum over 5 minutes.
MetricTunnelDataOut(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
// The state of the tunnel. 0 indicates DOWN and 1 indicates UP.
//
// Average over 5 minutes.
MetricTunnelState(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
// Returns a string representation of this construct.
ToString() *string
}
Base class for Vpn connections.
type VpnConnectionOptions ¶
type VpnConnectionOptions struct {
// The ip address of the customer gateway.
Ip *string `field:"required" json:"ip" yaml:"ip"`
// The ASN of the customer gateway.
// Default: 65000.
//
Asn *float64 `field:"optional" json:"asn" yaml:"asn"`
// The static routes to be routed from the VPN gateway to the customer gateway.
// Default: Dynamic routing (BGP).
//
StaticRoutes *[]*string `field:"optional" json:"staticRoutes" yaml:"staticRoutes"`
// The tunnel options for the VPN connection.
//
// At most two elements (one per tunnel).
// Duplicates not allowed.
// Default: Amazon generated tunnel options.
//
TunnelOptions *[]*VpnTunnelOption `field:"optional" json:"tunnelOptions" yaml:"tunnelOptions"`
}
Example:
// Across all tunnels in the account/region
allDataOut := ec2.VpnConnection_MetricAllTunnelDataOut()
// For a specific vpn connection
vpnConnection := vpc.addVpnConnection(jsii.String("Dynamic"), &VpnConnectionOptions{
Ip: jsii.String("1.2.3.4"),
})
state := vpnConnection.metricTunnelState()
type VpnConnectionProps ¶
type VpnConnectionProps struct {
// The ip address of the customer gateway.
Ip *string `field:"required" json:"ip" yaml:"ip"`
// The ASN of the customer gateway.
// Default: 65000.
//
Asn *float64 `field:"optional" json:"asn" yaml:"asn"`
// The static routes to be routed from the VPN gateway to the customer gateway.
// Default: Dynamic routing (BGP).
//
StaticRoutes *[]*string `field:"optional" json:"staticRoutes" yaml:"staticRoutes"`
// The tunnel options for the VPN connection.
//
// At most two elements (one per tunnel).
// Duplicates not allowed.
// Default: Amazon generated tunnel options.
//
TunnelOptions *[]*VpnTunnelOption `field:"optional" json:"tunnelOptions" yaml:"tunnelOptions"`
// The VPC to connect to.
Vpc IVpc `field:"required" json:"vpc" yaml:"vpc"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
var secretValue secretValue
var vpc vpc
vpnConnectionProps := &VpnConnectionProps{
Ip: jsii.String("ip"),
Vpc: vpc,
// the properties below are optional
Asn: jsii.Number(123),
StaticRoutes: []*string{
jsii.String("staticRoutes"),
},
TunnelOptions: []vpnTunnelOption{
&vpnTunnelOption{
PreSharedKey: jsii.String("preSharedKey"),
PreSharedKeySecret: secretValue,
TunnelInsideCidr: jsii.String("tunnelInsideCidr"),
},
},
}
type VpnConnectionType ¶
type VpnConnectionType string
The VPN connection type.
Example:
stack := awscdk.Newstack()
myVpc := awsec2alpha.NewVpcV2(this, jsii.String("Vpc"))
vpnGateway := myVpc.EnableVpnGatewayV2(&VPNGatewayV2Options{
VpnRoutePropagation: []subnetSelection{
&subnetSelection{
SubnetType: awscdk.SubnetType_PUBLIC,
},
},
Type: awscdk.VpnConnectionType_IPSEC_1,
})
routeTable := awsec2alpha.NewRouteTable(stack, jsii.String("routeTable"), &RouteTableProps{
Vpc: myVpc,
})
awsec2alpha.NewRoute(stack, jsii.String("route"), &RouteProps{
Destination: jsii.String("172.31.0.0/24"),
Target: map[string]iRouteTarget{
"gateway": vpnGateway,
},
RouteTable: routeTable,
})
const ( // The IPsec 1 VPN connection type. VpnConnectionType_IPSEC_1 VpnConnectionType = "IPSEC_1" // Dummy member TODO: remove once https://github.com/aws/jsii/issues/231 is fixed. VpnConnectionType_DUMMY VpnConnectionType = "DUMMY" )
type VpnGateway ¶
type VpnGateway interface {
awscdk.Resource
IVpnGateway
// The environment this resource belongs to.
//
// For resources that are created and managed by the CDK
// (generally, those created by creating new class instances like Role, Bucket, etc.),
// this is always the same as the environment of the stack they belong to;
// however, for imported resources
// (those obtained from static methods like fromRoleArn, fromBucketName, etc.),
// that might be different than the stack they were imported into.
Env() *awscdk.ResourceEnvironment
// The virtual private gateway Id.
GatewayId() *string
// The tree node.
Node() constructs.Node
// Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
//
// This value will resolve to one of the following:
// - a concrete value (e.g. `"my-awesome-bucket"`)
// - `undefined`, when a name should be generated by CloudFormation
// - a concrete name generated automatically during synthesis, in
// cross-environment scenarios.
PhysicalName() *string
// The stack in which this resource is defined.
Stack() awscdk.Stack
// Apply the given removal policy to this resource.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
GeneratePhysicalName() *string
// Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`).
//
// Normally, this token will resolve to `arnAttr`, but if the resource is
// referenced across environments, `arnComponents` will be used to synthesize
// a concrete ARN with the resource's physical name. Make sure to reference
// `this.physicalName` in `arnComponents`.
GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
// Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`).
//
// Normally, this token will resolve to `nameAttr`, but if the resource is
// referenced across environments, it will be resolved to `this.physicalName`,
// which will be a concrete name.
GetResourceNameAttribute(nameAttr *string) *string
// Returns a string representation of this construct.
ToString() *string
}
The VPN Gateway that shall be added to the VPC.
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"
vpnGateway := awscdk.Aws_ec2.NewVpnGateway(this, jsii.String("MyVpnGateway"), &VpnGatewayProps{
Type: jsii.String("type"),
// the properties below are optional
AmazonSideAsn: jsii.Number(123),
})
func NewVpnGateway ¶
func NewVpnGateway(scope constructs.Construct, id *string, props *VpnGatewayProps) VpnGateway
type VpnGatewayProps ¶
type VpnGatewayProps struct {
// Default type ipsec.1.
Type *string `field:"required" json:"type" yaml:"type"`
// Explicitly specify an Asn or let aws pick an Asn for you.
// Default: 65000.
//
AmazonSideAsn *float64 `field:"optional" json:"amazonSideAsn" yaml:"amazonSideAsn"`
}
The VpnGateway Properties.
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"
vpnGatewayProps := &VpnGatewayProps{
Type: jsii.String("type"),
// the properties below are optional
AmazonSideAsn: jsii.Number(123),
}
type VpnTunnelOption ¶
type VpnTunnelOption struct {
//
// Allowed characters are
// alphanumeric characters period `.` and underscores `_`. Must be between 8
// and 64 characters in length and cannot start with zero (0).
// Default: an Amazon generated pre-shared key.
//
// Deprecated: Use `preSharedKeySecret` instead.
PreSharedKey *string `field:"optional" json:"preSharedKey" yaml:"preSharedKey"`
//
// Allowed characters are
// alphanumeric characters period `.` and underscores `_`. Must be between 8
// and 64 characters in length and cannot start with zero (0).
// Default: an Amazon generated pre-shared key.
//
PreSharedKeySecret awscdk.SecretValue `field:"optional" json:"preSharedKeySecret" yaml:"preSharedKeySecret"`
// The range of inside IP addresses for the tunnel.
//
// Any specified CIDR blocks must be
// unique across all VPN connections that use the same virtual private gateway.
// A size /30 CIDR block from the 169.254.0.0/16 range.
// Default: an Amazon generated inside IP CIDR.
//
TunnelInsideCidr *string `field:"optional" json:"tunnelInsideCidr" yaml:"tunnelInsideCidr"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
var secretValue secretValue
vpnTunnelOption := &VpnTunnelOption{
PreSharedKey: jsii.String("preSharedKey"),
PreSharedKeySecret: secretValue,
TunnelInsideCidr: jsii.String("tunnelInsideCidr"),
}
type WindowsImage ¶
type WindowsImage interface {
GenericSSMParameterImage
// Name of the SSM parameter we're looking up.
ParameterName() *string
// Return the image to use in the given context.
GetImage(scope constructs.Construct) *MachineImageConfig
}
Select the latest version of the indicated Windows version.
This Machine Image automatically updates to the latest version on every deployment. Be aware this will cause your instances to be replaced when a new version of the image becomes available. Do not store stateful information on the instance if you are using this image.
The AMI ID is selected using the values published to the SSM parameter store.
Example:
// Pick a Windows edition to use
windows := ec2.NewWindowsImage(ec2.WindowsVersion_WINDOWS_SERVER_2019_ENGLISH_FULL_BASE)
// Pick the right Amazon Linux edition. All arguments shown are optional
// and will default to these values when omitted.
amznLinux := ec2.NewAmazonLinuxImage(&AmazonLinuxImageProps{
Generation: ec2.AmazonLinuxGeneration_AMAZON_LINUX,
Edition: ec2.AmazonLinuxEdition_STANDARD,
Virtualization: ec2.AmazonLinuxVirt_HVM,
Storage: ec2.AmazonLinuxStorage_GENERAL_PURPOSE,
})
// For other custom (Linux) images, instantiate a `GenericLinuxImage` with
// a map giving the AMI to in for each region:
linux := ec2.NewGenericLinuxImage(map[string]*string{
"us-east-1": jsii.String("ami-97785bed"),
"eu-west-1": jsii.String("ami-12345678"),
})
func NewWindowsImage ¶
func NewWindowsImage(version WindowsVersion, props *WindowsImageProps) WindowsImage
type WindowsImageProps ¶
type WindowsImageProps struct {
// Initial user data.
// Default: - Empty UserData for Windows machines.
//
UserData UserData `field:"optional" json:"userData" yaml:"userData"`
}
Configuration options for WindowsImage.
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"
var userData userData
windowsImageProps := &WindowsImageProps{
UserData: userData,
}
type WindowsUserDataOptions ¶ added in v2.46.0
type WindowsUserDataOptions struct {
// Set to true to set this userdata to persist through an instance reboot;
//
// allowing
// it to run on every instance start.
// By default, UserData is run only once during the first instance launch.
//
// For more information, see:
// https://aws.amazon.com/premiumsupport/knowledge-center/execute-user-data-ec2/
// https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2-windows-user-data.html#user-data-scripts
// Default: false.
//
Persist *bool `field:"optional" json:"persist" yaml:"persist"`
}
Options when constructing UserData for Windows.
Example:
windowsUserData := ec2.UserData_ForWindows(&WindowsUserDataOptions{
Persist: jsii.Boolean(true),
})
type WindowsVersion ¶
type WindowsVersion string
The Windows version to use for the WindowsImage.
Example:
// Pick a Windows edition to use
windows := ec2.NewWindowsImage(ec2.WindowsVersion_WINDOWS_SERVER_2019_ENGLISH_FULL_BASE)
// Pick the right Amazon Linux edition. All arguments shown are optional
// and will default to these values when omitted.
amznLinux := ec2.NewAmazonLinuxImage(&AmazonLinuxImageProps{
Generation: ec2.AmazonLinuxGeneration_AMAZON_LINUX,
Edition: ec2.AmazonLinuxEdition_STANDARD,
Virtualization: ec2.AmazonLinuxVirt_HVM,
Storage: ec2.AmazonLinuxStorage_GENERAL_PURPOSE,
})
// For other custom (Linux) images, instantiate a `GenericLinuxImage` with
// a map giving the AMI to in for each region:
linux := ec2.NewGenericLinuxImage(map[string]*string{
"us-east-1": jsii.String("ami-97785bed"),
"eu-west-1": jsii.String("ami-12345678"),
})
const ( // EKS Optimized - Start. WindowsVersion_WINDOWS_SERVER_2019_ENGLISH_CORE_EKS_OPTIMIZED_1_22 WindowsVersion = "WINDOWS_SERVER_2019_ENGLISH_CORE_EKS_OPTIMIZED_1_22" WindowsVersion_WINDOWS_SERVER_2019_ENGLISH_FULL_EKS_OPTIMIZED_1_22 WindowsVersion = "WINDOWS_SERVER_2019_ENGLISH_FULL_EKS_OPTIMIZED_1_22" WindowsVersion_WINDOWS_SERVER_2019_ENGLISH_CORE_EKS_OPTIMIZED_1_23 WindowsVersion = "WINDOWS_SERVER_2019_ENGLISH_CORE_EKS_OPTIMIZED_1_23" WindowsVersion_WINDOWS_SERVER_2019_ENGLISH_FULL_EKS_OPTIMIZED_1_23 WindowsVersion = "WINDOWS_SERVER_2019_ENGLISH_FULL_EKS_OPTIMIZED_1_23" WindowsVersion_WINDOWS_SERVER_2019_ENGLISH_CORE_EKS_OPTIMIZED_1_24 WindowsVersion = "WINDOWS_SERVER_2019_ENGLISH_CORE_EKS_OPTIMIZED_1_24" WindowsVersion_WINDOWS_SERVER_2019_ENGLISH_FULL_EKS_OPTIMIZED_1_24 WindowsVersion = "WINDOWS_SERVER_2019_ENGLISH_FULL_EKS_OPTIMIZED_1_24" WindowsVersion_WINDOWS_SERVER_2019_ENGLISH_CORE_EKS_OPTIMIZED_1_25 WindowsVersion = "WINDOWS_SERVER_2019_ENGLISH_CORE_EKS_OPTIMIZED_1_25" WindowsVersion_WINDOWS_SERVER_2019_ENGLISH_FULL_EKS_OPTIMIZED_1_25 WindowsVersion = "WINDOWS_SERVER_2019_ENGLISH_FULL_EKS_OPTIMIZED_1_25" WindowsVersion_WINDOWS_SERVER_2019_ENGLISH_CORE_EKS_OPTIMIZED_1_26 WindowsVersion = "WINDOWS_SERVER_2019_ENGLISH_CORE_EKS_OPTIMIZED_1_26" WindowsVersion_WINDOWS_SERVER_2019_ENGLISH_FULL_EKS_OPTIMIZED_1_26 WindowsVersion = "WINDOWS_SERVER_2019_ENGLISH_FULL_EKS_OPTIMIZED_1_26" WindowsVersion_WINDOWS_SERVER_2019_ENGLISH_CORE_EKS_OPTIMIZED_1_27 WindowsVersion = "WINDOWS_SERVER_2019_ENGLISH_CORE_EKS_OPTIMIZED_1_27" WindowsVersion_WINDOWS_SERVER_2019_ENGLISH_FULL_EKS_OPTIMIZED_1_27 WindowsVersion = "WINDOWS_SERVER_2019_ENGLISH_FULL_EKS_OPTIMIZED_1_27" WindowsVersion_WINDOWS_SERVER_2019_ENGLISH_CORE_EKS_OPTIMIZED_1_28 WindowsVersion = "WINDOWS_SERVER_2019_ENGLISH_CORE_EKS_OPTIMIZED_1_28" WindowsVersion_WINDOWS_SERVER_2019_ENGLISH_FULL_EKS_OPTIMIZED_1_28 WindowsVersion = "WINDOWS_SERVER_2019_ENGLISH_FULL_EKS_OPTIMIZED_1_28" WindowsVersion_WINDOWS_SERVER_2022_ENGLISH_CORE_EKS_OPTIMIZED_1_23 WindowsVersion = "WINDOWS_SERVER_2022_ENGLISH_CORE_EKS_OPTIMIZED_1_23" WindowsVersion_WINDOWS_SERVER_2022_ENGLISH_FULL_EKS_OPTIMIZED_1_23 WindowsVersion = "WINDOWS_SERVER_2022_ENGLISH_FULL_EKS_OPTIMIZED_1_23" WindowsVersion_WINDOWS_SERVER_2022_ENGLISH_CORE_EKS_OPTIMIZED_1_24 WindowsVersion = "WINDOWS_SERVER_2022_ENGLISH_CORE_EKS_OPTIMIZED_1_24" WindowsVersion_WINDOWS_SERVER_2022_ENGLISH_FULL_EKS_OPTIMIZED_1_24 WindowsVersion = "WINDOWS_SERVER_2022_ENGLISH_FULL_EKS_OPTIMIZED_1_24" WindowsVersion_WINDOWS_SERVER_2022_ENGLISH_CORE_EKS_OPTIMIZED_1_25 WindowsVersion = "WINDOWS_SERVER_2022_ENGLISH_CORE_EKS_OPTIMIZED_1_25" WindowsVersion_WINDOWS_SERVER_2022_ENGLISH_FULL_EKS_OPTIMIZED_1_25 WindowsVersion = "WINDOWS_SERVER_2022_ENGLISH_FULL_EKS_OPTIMIZED_1_25" WindowsVersion_WINDOWS_SERVER_2022_ENGLISH_CORE_EKS_OPTIMIZED_1_26 WindowsVersion = "WINDOWS_SERVER_2022_ENGLISH_CORE_EKS_OPTIMIZED_1_26" WindowsVersion_WINDOWS_SERVER_2022_ENGLISH_FULL_EKS_OPTIMIZED_1_26 WindowsVersion = "WINDOWS_SERVER_2022_ENGLISH_FULL_EKS_OPTIMIZED_1_26" WindowsVersion_WINDOWS_SERVER_2022_ENGLISH_CORE_EKS_OPTIMIZED_1_27 WindowsVersion = "WINDOWS_SERVER_2022_ENGLISH_CORE_EKS_OPTIMIZED_1_27" WindowsVersion_WINDOWS_SERVER_2022_ENGLISH_FULL_EKS_OPTIMIZED_1_27 WindowsVersion = "WINDOWS_SERVER_2022_ENGLISH_FULL_EKS_OPTIMIZED_1_27" WindowsVersion_WINDOWS_SERVER_2022_ENGLISH_CORE_EKS_OPTIMIZED_1_28 WindowsVersion = "WINDOWS_SERVER_2022_ENGLISH_CORE_EKS_OPTIMIZED_1_28" WindowsVersion_WINDOWS_SERVER_2022_ENGLISH_FULL_EKS_OPTIMIZED_1_28 WindowsVersion = "WINDOWS_SERVER_2022_ENGLISH_FULL_EKS_OPTIMIZED_1_28" // 1709 - Start. WindowsVersion_WINDOWS_SERVER_1709_ENGLISH_CORE_CONTAINERSLATEST WindowsVersion = "WINDOWS_SERVER_1709_ENGLISH_CORE_CONTAINERSLATEST" WindowsVersion_WINDOWS_SERVER_1709_ENGLISH_CORE_BASE WindowsVersion = "WINDOWS_SERVER_1709_ENGLISH_CORE_BASE" // 1803 - Start. WindowsVersion_WINDOWS_SERVER_1803_ENGLISH_CORE_BASE WindowsVersion = "WINDOWS_SERVER_1803_ENGLISH_CORE_BASE" WindowsVersion_WINDOWS_SERVER_1803_ENGLISH_CORE_CONTAINERSLATEST WindowsVersion = "WINDOWS_SERVER_1803_ENGLISH_CORE_CONTAINERSLATEST" // 1809 - Start. WindowsVersion_WINDOWS_SERVER_1809_ENGLISH_CORE_BASE WindowsVersion = "WINDOWS_SERVER_1809_ENGLISH_CORE_BASE" WindowsVersion_WINDOWS_SERVER_1809_ENGLISH_CORE_CONTAINERSLATEST WindowsVersion = "WINDOWS_SERVER_1809_ENGLISH_CORE_CONTAINERSLATEST" // 2003 - Start. WindowsVersion_WINDOWS_SERVER_2003_R2_SP2_LANGUAGE_PACKS_32BIT_BASE WindowsVersion = "WINDOWS_SERVER_2003_R2_SP2_LANGUAGE_PACKS_32BIT_BASE" WindowsVersion_WINDOWS_SERVER_2003_R2_SP2_ENGLISH_64BIT_SQL_2005_SP4_EXPRESS WindowsVersion = "WINDOWS_SERVER_2003_R2_SP2_ENGLISH_64BIT_SQL_2005_SP4_EXPRESS" WindowsVersion_WINDOWS_SERVER_2003_R2_SP2_LANGUAGE_PACKS_64BIT_SQL_2005_SP4_STANDARD WindowsVersion = "WINDOWS_SERVER_2003_R2_SP2_LANGUAGE_PACKS_64BIT_SQL_2005_SP4_STANDARD" WindowsVersion_WINDOWS_SERVER_2003_R2_SP2_ENGLISH_32BIT_BASE WindowsVersion = "WINDOWS_SERVER_2003_R2_SP2_ENGLISH_32BIT_BASE" WindowsVersion_WINDOWS_SERVER_2003_R2_SP2_ENGLISH_64BIT_BASE WindowsVersion = "WINDOWS_SERVER_2003_R2_SP2_ENGLISH_64BIT_BASE" WindowsVersion_WINDOWS_SERVER_2003_R2_SP2_LANGUAGE_PACKS_64BIT_SQL_2005_SP4_EXPRESS WindowsVersion = "WINDOWS_SERVER_2003_R2_SP2_LANGUAGE_PACKS_64BIT_SQL_2005_SP4_EXPRESS" WindowsVersion_WINDOWS_SERVER_2003_R2_SP2_ENGLISH_64BIT_SQL_2005_SP4_STANDARD WindowsVersion = "WINDOWS_SERVER_2003_R2_SP2_ENGLISH_64BIT_SQL_2005_SP4_STANDARD" WindowsVersion_WINDOWS_SERVER_2003_R2_SP2_LANGUAGE_PACKS_64BIT_BASE WindowsVersion = "WINDOWS_SERVER_2003_R2_SP2_LANGUAGE_PACKS_64BIT_BASE" // 2007 - Start. WindowsVersion_WINDOWS_SERVER_2007_R2_SP1_LANGUAGE_PACKS_64BIT_BASE WindowsVersion = "WINDOWS_SERVER_2007_R2_SP1_LANGUAGE_PACKS_64BIT_BASE" // 2008 - Start. WindowsVersion_WINDOWS_SERVER_2008_SP2_ENGLISH_64BIT_SQL_2008_SP4_EXPRESS WindowsVersion = "WINDOWS_SERVER_2008_SP2_ENGLISH_64BIT_SQL_2008_SP4_EXPRESS" WindowsVersion_WINDOWS_SERVER_2008_R2_SP1_ENGLISH_64BIT_SQL_2008_R2_SP3_WEB WindowsVersion = "WINDOWS_SERVER_2008_R2_SP1_ENGLISH_64BIT_SQL_2008_R2_SP3_WEB" WindowsVersion_WINDOWS_SERVER_2008_R2_SP1_ENGLISH_64BIT_SQL_2012_SP4_EXPRESS WindowsVersion = "WINDOWS_SERVER_2008_R2_SP1_ENGLISH_64BIT_SQL_2012_SP4_EXPRESS" WindowsVersion_WINDOWS_SERVER_2008_R2_SP1_KOREAN_64BIT_BASE WindowsVersion = "WINDOWS_SERVER_2008_R2_SP1_KOREAN_64BIT_BASE" WindowsVersion_WINDOWS_SERVER_2008_R2_SP1_CHINESE_HONG_KONG_SAR_64BIT_BASE WindowsVersion = "WINDOWS_SERVER_2008_R2_SP1_CHINESE_HONG_KONG_SAR_64BIT_BASE" WindowsVersion_WINDOWS_SERVER_2008_R2_SP1_CHINESE_PRC_64BIT_BASE WindowsVersion = "WINDOWS_SERVER_2008_R2_SP1_CHINESE_PRC_64BIT_BASE" WindowsVersion_WINDOWS_SERVER_2008_R2_SP1_ENGLISH_64BIT_SQL_2008_R2_SP3_EXPRESS WindowsVersion = "WINDOWS_SERVER_2008_R2_SP1_ENGLISH_64BIT_SQL_2008_R2_SP3_EXPRESS" WindowsVersion_WINDOWS_SERVER_2008_SP2_ENGLISH_32BIT_BASE WindowsVersion = "WINDOWS_SERVER_2008_SP2_ENGLISH_32BIT_BASE" WindowsVersion_WINDOWS_SERVER_2008_R2_SP1_ENGLISH_64BIT_SQL_2012_SP4_WEB WindowsVersion = "WINDOWS_SERVER_2008_R2_SP1_ENGLISH_64BIT_SQL_2012_SP4_WEB" WindowsVersion_WINDOWS_SERVER_2008_R2_SP1_JAPANESE_64BIT_BASE WindowsVersion = "WINDOWS_SERVER_2008_R2_SP1_JAPANESE_64BIT_BASE" WindowsVersion_WINDOWS_SERVER_2008_SP2_ENGLISH_64BIT_SQL_2008_SP4_STANDARD WindowsVersion = "WINDOWS_SERVER_2008_SP2_ENGLISH_64BIT_SQL_2008_SP4_STANDARD" WindowsVersion_WINDOWS_SERVER_2008_R2_SP1_JAPANESE_64BIT_SQL_2012_SP4_EXPRESS WindowsVersion = "WINDOWS_SERVER_2008_R2_SP1_JAPANESE_64BIT_SQL_2012_SP4_EXPRESS" WindowsVersion_WINDOWS_SERVER_2008_R2_SP1_JAPANESE_64BIT_SQL_2008_R2_SP3_WEB WindowsVersion = "WINDOWS_SERVER_2008_R2_SP1_JAPANESE_64BIT_SQL_2008_R2_SP3_WEB" WindowsVersion_WINDOWS_SERVER_2008_R2_SP1_JAPANESE_64BIT_SQL_2012_SP4_STANDARD WindowsVersion = "WINDOWS_SERVER_2008_R2_SP1_JAPANESE_64BIT_SQL_2012_SP4_STANDARD" WindowsVersion_WINDOWS_SERVER_2008_R2_SP1_JAPANESE_64BIT_SQL_2008_R2_SP3_STANDARD WindowsVersion = "WINDOWS_SERVER_2008_R2_SP1_JAPANESE_64BIT_SQL_2008_R2_SP3_STANDARD" WindowsVersion_WINDOWS_SERVER_2008_SP2_ENGLISH_64BIT_BASE WindowsVersion = "WINDOWS_SERVER_2008_SP2_ENGLISH_64BIT_BASE" WindowsVersion_WINDOWS_SERVER_2008_R2_SP1_ENGLISH_64BIT_SQL_2012_SP4_ENTERPRISE WindowsVersion = "WINDOWS_SERVER_2008_R2_SP1_ENGLISH_64BIT_SQL_2012_SP4_ENTERPRISE" WindowsVersion_WINDOWS_SERVER_2008_R2_SP1_JAPANESE_64BIT_SQL_2008_R2_SP3_EXPRESS WindowsVersion = "WINDOWS_SERVER_2008_R2_SP1_JAPANESE_64BIT_SQL_2008_R2_SP3_EXPRESS" WindowsVersion_WINDOWS_SERVER_2008_R2_SP1_PORTUGUESE_BRAZIL_64BIT_BASE WindowsVersion = "WINDOWS_SERVER_2008_R2_SP1_PORTUGUESE_BRAZIL_64BIT_BASE" WindowsVersion_WINDOWS_SERVER_2008_R2_SP1_LANGUAGE_PACKS_64BIT_SQL_2008_R2_SP3_STANDARD WindowsVersion = "WINDOWS_SERVER_2008_R2_SP1_LANGUAGE_PACKS_64BIT_SQL_2008_R2_SP3_STANDARD" WindowsVersion_WINDOWS_SERVER_2008_R2_SP1_ENGLISH_61BIT_SQL_2012_RTM_SP2_ENTERPRISE WindowsVersion = "WINDOWS_SERVER_2008_R2_SP1_ENGLISH_61BIT_SQL_2012_RTM_SP2_ENTERPRISE" WindowsVersion_WINDOWS_SERVER_2008_R2_SP1_ENGLISH_64BIT_SQL_2012_SP4_STANDARD WindowsVersion = "WINDOWS_SERVER_2008_R2_SP1_ENGLISH_64BIT_SQL_2012_SP4_STANDARD" WindowsVersion_WINDOWS_SERVER_2008_SP2_PORTUGUESE_BRAZIL_32BIT_BASE WindowsVersion = "WINDOWS_SERVER_2008_SP2_PORTUGUESE_BRAZIL_32BIT_BASE" WindowsVersion_WINDOWS_SERVER_2008_R2_SP1_ENGLISH_64BIT_BASE WindowsVersion = "WINDOWS_SERVER_2008_R2_SP1_ENGLISH_64BIT_BASE" WindowsVersion_WINDOWS_SERVER_2008_R2_SP1_LANGUAGE_PACKS_64BIT_SQL_2008_R2_SP3_EXPRESS WindowsVersion = "WINDOWS_SERVER_2008_R2_SP1_LANGUAGE_PACKS_64BIT_SQL_2008_R2_SP3_EXPRESS" WindowsVersion_WINDOWS_SERVER_2008_R2_SP1_ENGLISH_64BIT_CORE_SQL_2012_SP4_STANDARD WindowsVersion = "WINDOWS_SERVER_2008_R2_SP1_ENGLISH_64BIT_CORE_SQL_2012_SP4_STANDARD" WindowsVersion_WINDOWS_SERVER_2008_R2_SP1_ENGLISH_64BIT_CORE WindowsVersion = "WINDOWS_SERVER_2008_R2_SP1_ENGLISH_64BIT_CORE" WindowsVersion_WINDOWS_SERVER_2008_R2_SP1_ENGLISH_64BIT_SQL_2008_R2_SP3_STANDARD WindowsVersion = "WINDOWS_SERVER_2008_R2_SP1_ENGLISH_64BIT_SQL_2008_R2_SP3_STANDARD" WindowsVersion_WINDOWS_SERVER_2008_R2_SP1_ENGLISH_64BIT_SHAREPOINT_2010_SP2_FOUNDATION WindowsVersion = "WINDOWS_SERVER_2008_R2_SP1_ENGLISH_64BIT_SHAREPOINT_2010_SP2_FOUNDATION" // 2012 - Start. WindowsVersion_WINDOWS_SERVER_2012_R2_RTM_CHINESE_SIMPLIFIED_64BIT_BASE WindowsVersion = "WINDOWS_SERVER_2012_R2_RTM_CHINESE_SIMPLIFIED_64BIT_BASE" WindowsVersion_WINDOWS_SERVER_2012_R2_RTM_CHINESE_TRADITIONAL_64BIT_BASE WindowsVersion = "WINDOWS_SERVER_2012_R2_RTM_CHINESE_TRADITIONAL_64BIT_BASE" WindowsVersion_WINDOWS_SERVER_2012_R2_RTM_DUTCH_64BIT_BASE WindowsVersion = "WINDOWS_SERVER_2012_R2_RTM_DUTCH_64BIT_BASE" WindowsVersion_WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2014_SP2_ENTERPRISE WindowsVersion = "WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2014_SP2_ENTERPRISE" WindowsVersion_WINDOWS_SERVER_2012_R2_RTM_HUNGARIAN_64BIT_BASE WindowsVersion = "WINDOWS_SERVER_2012_R2_RTM_HUNGARIAN_64BIT_BASE" WindowsVersion_WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_BASE WindowsVersion = "WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_BASE" WindowsVersion_WINDOWS_SERVER_2012_RTM_ENGLISH_64BIT_SQL_2008_R2_SP3_EXPRESS WindowsVersion = "WINDOWS_SERVER_2012_RTM_ENGLISH_64BIT_SQL_2008_R2_SP3_EXPRESS" WindowsVersion_WINDOWS_SERVER_2012_R2_SP1_PORTUGUESE_BRAZIL_64BIT_CORE WindowsVersion = "WINDOWS_SERVER_2012_R2_SP1_PORTUGUESE_BRAZIL_64BIT_CORE" WindowsVersion_WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2016_SP2_STANDARD WindowsVersion = "WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2016_SP2_STANDARD" WindowsVersion_WINDOWS_SERVER_2012_RTM_ENGLISH_64BIT_SQL_2014_SP2_EXPRESS WindowsVersion = "WINDOWS_SERVER_2012_RTM_ENGLISH_64BIT_SQL_2014_SP2_EXPRESS" WindowsVersion_WINDOWS_SERVER_2012_RTM_ITALIAN_64BIT_BASE WindowsVersion = "WINDOWS_SERVER_2012_RTM_ITALIAN_64BIT_BASE" WindowsVersion_WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2016_SP1_EXPRESS WindowsVersion = "WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2016_SP1_EXPRESS" WindowsVersion_WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_SQL_2016_SP2_WEB WindowsVersion = "WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_SQL_2016_SP2_WEB" WindowsVersion_WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2014_SP3_STANDARD WindowsVersion = "WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2014_SP3_STANDARD" WindowsVersion_WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2016_SP2_EXPRESS WindowsVersion = "WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2016_SP2_EXPRESS" WindowsVersion_WINDOWS_SERVER_2012_R2_RTM_ENGLISH_DEEP_LEARNING WindowsVersion = "WINDOWS_SERVER_2012_R2_RTM_ENGLISH_DEEP_LEARNING" WindowsVersion_WINDOWS_SERVER_2012_R2_RTM_GERMAN_64BIT_BASE WindowsVersion = "WINDOWS_SERVER_2012_R2_RTM_GERMAN_64BIT_BASE" WindowsVersion_WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_SQL_2016_SP1_EXPRESS WindowsVersion = "WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_SQL_2016_SP1_EXPRESS" WindowsVersion_WINDOWS_SERVER_2012_R2_RTM_RUSSIAN_64BIT_BASE WindowsVersion = "WINDOWS_SERVER_2012_R2_RTM_RUSSIAN_64BIT_BASE" WindowsVersion_WINDOWS_SERVER_2012_RTM_CHINESE_TRADITIONAL_HONG_KONG_SAR_64BIT_BASE WindowsVersion = "WINDOWS_SERVER_2012_RTM_CHINESE_TRADITIONAL_HONG_KONG_SAR_64BIT_BASE" WindowsVersion_WINDOWS_SERVER_2012_RTM_HUNGARIAN_64BIT_BASE WindowsVersion = "WINDOWS_SERVER_2012_RTM_HUNGARIAN_64BIT_BASE" WindowsVersion_WINDOWS_SERVER_2012_RTM_JAPANESE_64BIT_SQL_2014_SP3_STANDARD WindowsVersion = "WINDOWS_SERVER_2012_RTM_JAPANESE_64BIT_SQL_2014_SP3_STANDARD" WindowsVersion_WINDOWS_SERVER_2012_RTM_FRENCH_64BIT_BASE WindowsVersion = "WINDOWS_SERVER_2012_RTM_FRENCH_64BIT_BASE" WindowsVersion_WINDOWS_SERVER_2012_R2_RTM_FRENCH_64BIT_BASE WindowsVersion = "WINDOWS_SERVER_2012_R2_RTM_FRENCH_64BIT_BASE" WindowsVersion_WINDOWS_SERVER_2012_R2_RTM_POLISH_64BIT_BASE WindowsVersion = "WINDOWS_SERVER_2012_R2_RTM_POLISH_64BIT_BASE" WindowsVersion_WINDOWS_SERVER_2012_RTM_ENGLISH_64BIT_SQL_2012_SP4_EXPRESS WindowsVersion = "WINDOWS_SERVER_2012_RTM_ENGLISH_64BIT_SQL_2012_SP4_EXPRESS" WindowsVersion_WINDOWS_SERVER_2012_RTM_ENGLISH_64BIT_SQL_2014_SP3_STANDARD WindowsVersion = "WINDOWS_SERVER_2012_RTM_ENGLISH_64BIT_SQL_2014_SP3_STANDARD" WindowsVersion_WINDOWS_SERVER_2012_RTM_JAPANESE_64BIT_2012_SP4_STANDARD WindowsVersion = "WINDOWS_SERVER_2012_RTM_JAPANESE_64BIT_2012_SP4_STANDARD" WindowsVersion_WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2014_SP2_EXPRESS WindowsVersion = "WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2014_SP2_EXPRESS" WindowsVersion_WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2014_SP3_WEB WindowsVersion = "WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2014_SP3_WEB" WindowsVersion_WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_SQL_2016_SP1_WEB WindowsVersion = "WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_SQL_2016_SP1_WEB" WindowsVersion_WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_CORE WindowsVersion = "WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_CORE" WindowsVersion_WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2014_SP2_WEB WindowsVersion = "WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2014_SP2_WEB" WindowsVersion_WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2014_SP3_ENTERPRISE WindowsVersion = "WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2014_SP3_ENTERPRISE" WindowsVersion_WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_SQL_2016_SP2_STANDARD WindowsVersion = "WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_SQL_2016_SP2_STANDARD" WindowsVersion_WINDOWS_SERVER_2012_RTM_ENGLISH_64BIT_2014_SP3_WEB WindowsVersion = "WINDOWS_SERVER_2012_RTM_ENGLISH_64BIT_2014_SP3_WEB" WindowsVersion_WINDOWS_SERVER_2012_RTM_SWEDISH_64BIT_BASE WindowsVersion = "WINDOWS_SERVER_2012_RTM_SWEDISH_64BIT_BASE" WindowsVersion_WINDOWS_SERVER_2012_R2_RTM_PORTUGUESE_BRAZIL_64BIT_BASE WindowsVersion = "WINDOWS_SERVER_2012_R2_RTM_PORTUGUESE_BRAZIL_64BIT_BASE" WindowsVersion_WINDOWS_SERVER_2012_R2_RTM_PORTUGUESE_PORTUGAL_64BIT_BASE WindowsVersion = "WINDOWS_SERVER_2012_R2_RTM_PORTUGUESE_PORTUGAL_64BIT_BASE" WindowsVersion_WINDOWS_SERVER_2012_R2_RTM_SWEDISH_64BIT_BASE WindowsVersion = "WINDOWS_SERVER_2012_R2_RTM_SWEDISH_64BIT_BASE" WindowsVersion_WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2012_SP4_ENTERPRISE WindowsVersion = "WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2012_SP4_ENTERPRISE" WindowsVersion_WINDOWS_SERVER_2012_RTM_CHINESE_TRADITIONAL_64BIT_BASE WindowsVersion = "WINDOWS_SERVER_2012_RTM_CHINESE_TRADITIONAL_64BIT_BASE" WindowsVersion_WINDOWS_SERVER_2012_RTM_ENGLISH_64BIT_SQL_2014_SP2_STANDARD WindowsVersion = "WINDOWS_SERVER_2012_RTM_ENGLISH_64BIT_SQL_2014_SP2_STANDARD" WindowsVersion_WINDOWS_SERVER_2012_RTM_CZECH_64BIT_BASE WindowsVersion = "WINDOWS_SERVER_2012_RTM_CZECH_64BIT_BASE" WindowsVersion_WINDOWS_SERVER_2012_RTM_TURKISH_64BIT_BASE WindowsVersion = "WINDOWS_SERVER_2012_RTM_TURKISH_64BIT_BASE" WindowsVersion_WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_HYPERV WindowsVersion = "WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_HYPERV" WindowsVersion_WINDOWS_SERVER_2012_RTM_KOREAN_64BIT_BASE WindowsVersion = "WINDOWS_SERVER_2012_RTM_KOREAN_64BIT_BASE" WindowsVersion_WINDOWS_SERVER_2012_RTM_RUSSIAN_64BIT_BASE WindowsVersion = "WINDOWS_SERVER_2012_RTM_RUSSIAN_64BIT_BASE" WindowsVersion_WINDOWS_SERVER_2012_R2_RTM_ENGLISH_FULL_BASE WindowsVersion = "WINDOWS_SERVER_2012_R2_RTM_ENGLISH_FULL_BASE" WindowsVersion_WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2014_SP2_STANDARD WindowsVersion = "WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2014_SP2_STANDARD" WindowsVersion_WINDOWS_SERVER_2012_R2_RTM_ITALIAN_64BIT_BASE WindowsVersion = "WINDOWS_SERVER_2012_R2_RTM_ITALIAN_64BIT_BASE" WindowsVersion_WINDOWS_SERVER_2012_RTM_ENGLISH_64BIT_BASE WindowsVersion = "WINDOWS_SERVER_2012_RTM_ENGLISH_64BIT_BASE" WindowsVersion_WINDOWS_SERVER_2012_RTM_ENGLISH_64BIT_SQL_2008_R2_SP3_STANDARD WindowsVersion = "WINDOWS_SERVER_2012_RTM_ENGLISH_64BIT_SQL_2008_R2_SP3_STANDARD" WindowsVersion_WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_SQL_2016_SP1_STANDARD WindowsVersion = "WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_SQL_2016_SP1_STANDARD" WindowsVersion_WINDOWS_SERVER_2012_RTM_ENGLISH_64BIT_SQL_2007_R2_SP3_WEB WindowsVersion = "WINDOWS_SERVER_2012_RTM_ENGLISH_64BIT_SQL_2007_R2_SP3_WEB" WindowsVersion_WINDOWS_SERVER_2012_RTM_JAPANESE_64BIT_SQL_2014_SP2_WEB WindowsVersion = "WINDOWS_SERVER_2012_RTM_JAPANESE_64BIT_SQL_2014_SP2_WEB" WindowsVersion_WINDOWS_SERVER_2012_RTM_JAPANESE_64BIT_SQL_2014_SP2_EXPRESS WindowsVersion = "WINDOWS_SERVER_2012_RTM_JAPANESE_64BIT_SQL_2014_SP2_EXPRESS" WindowsVersion_WINDOWS_SERVER_2012_R2_RTM_CZECH_64BIT_BASE WindowsVersion = "WINDOWS_SERVER_2012_R2_RTM_CZECH_64BIT_BASE" WindowsVersion_WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2016_SP1_STANDARD WindowsVersion = "WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2016_SP1_STANDARD" WindowsVersion_WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_SQL_2014_SP2_EXPRESS WindowsVersion = "WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_SQL_2014_SP2_EXPRESS" WindowsVersion_WINDOWS_SERVER_2012_RTM_ENGLISH_64BIT_SQL_2012_SP4_STANDARD WindowsVersion = "WINDOWS_SERVER_2012_RTM_ENGLISH_64BIT_SQL_2012_SP4_STANDARD" WindowsVersion_WINDOWS_SERVER_2012_SP2_PORTUGUESE_BRAZIL_64BIT_BASE WindowsVersion = "WINDOWS_SERVER_2012_SP2_PORTUGUESE_BRAZIL_64BIT_BASE" WindowsVersion_WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2016_SP1_WEB WindowsVersion = "WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2016_SP1_WEB" WindowsVersion_WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_SQL_2014_SP3_EXPRESS WindowsVersion = "WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_SQL_2014_SP3_EXPRESS" WindowsVersion_WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_SQL_2016_SP2_ENTERPRISE WindowsVersion = "WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_SQL_2016_SP2_ENTERPRISE" WindowsVersion_WINDOWS_SERVER_2012_RTM_JAPANESE_64BIT_BASE WindowsVersion = "WINDOWS_SERVER_2012_RTM_JAPANESE_64BIT_BASE" WindowsVersion_WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_SQL_2016_SP1_ENTERPRISE WindowsVersion = "WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_SQL_2016_SP1_ENTERPRISE" WindowsVersion_WINDOWS_SERVER_2012_RTM_JAPANESE_64BIT_SQL_2016_SP2_EXPRESS WindowsVersion = "WINDOWS_SERVER_2012_RTM_JAPANESE_64BIT_SQL_2016_SP2_EXPRESS" WindowsVersion_WINDOWS_SERVER_2012_RTM_ENGLISH_64BIT_SQL_2014_SP3_EXPRESS WindowsVersion = "WINDOWS_SERVER_2012_RTM_ENGLISH_64BIT_SQL_2014_SP3_EXPRESS" WindowsVersion_WINDOWS_SERVER_2012_RTM_JAPANESE_64BIT_SQL_2014_SP2_STANDARD WindowsVersion = "WINDOWS_SERVER_2012_RTM_JAPANESE_64BIT_SQL_2014_SP2_STANDARD" WindowsVersion_WINDOWS_SERVER_2012_RTM_ENGLISH_FULL_BASE WindowsVersion = "WINDOWS_SERVER_2012_RTM_ENGLISH_FULL_BASE" WindowsVersion_WINDOWS_SERVER_2012_R2_ENGLISH_STIG_FULL WindowsVersion = "WINDOWS_SERVER_2012_R2_ENGLISH_STIG_FULL" WindowsVersion_WINDOWS_SERVER_2012_RTM_PORTUGUESE_PORTUGAL_64BIT_BASE WindowsVersion = "WINDOWS_SERVER_2012_RTM_PORTUGUESE_PORTUGAL_64BIT_BASE" WindowsVersion_WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2016_SP1_ENTERPRISE WindowsVersion = "WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2016_SP1_ENTERPRISE" WindowsVersion_WINDOWS_SERVER_2012_RTM_ENGLISH_64BIT_SQL_2014_SP2_WEB WindowsVersion = "WINDOWS_SERVER_2012_RTM_ENGLISH_64BIT_SQL_2014_SP2_WEB" WindowsVersion_WINDOWS_SERVER_2012_RTM_JAPANESE_64BIT_SQL_2008_R2_SP3_EXPRESS WindowsVersion = "WINDOWS_SERVER_2012_RTM_JAPANESE_64BIT_SQL_2008_R2_SP3_EXPRESS" WindowsVersion_WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_BASE WindowsVersion = "WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_BASE" WindowsVersion_WINDOWS_SERVER_2012_RTM_PORTUGUESE_BRAZIL_64BIT_BASE WindowsVersion = "WINDOWS_SERVER_2012_RTM_PORTUGUESE_BRAZIL_64BIT_BASE" WindowsVersion_WINDOWS_SERVER_2012_R2_RTM_ENGLISH_P3 WindowsVersion = "WINDOWS_SERVER_2012_R2_RTM_ENGLISH_P3" WindowsVersion_WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_SQL_2014_SP3_STANDARD WindowsVersion = "WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_SQL_2014_SP3_STANDARD" WindowsVersion_WINDOWS_SERVER_2012_R2_RTM_SPANISH_64BIT_BASE WindowsVersion = "WINDOWS_SERVER_2012_R2_RTM_SPANISH_64BIT_BASE" WindowsVersion_WINDOWS_SERVER_2012_RTM_JAPANESE_64BIT_SQL_2014_SP3_EXPRESS WindowsVersion = "WINDOWS_SERVER_2012_RTM_JAPANESE_64BIT_SQL_2014_SP3_EXPRESS" WindowsVersion_WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_SQL_2016_SP3_STANDARD WindowsVersion = "WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_SQL_2016_SP3_STANDARD" WindowsVersion_WINDOWS_SERVER_2012_R2_ENGLISH_STIG_CORE WindowsVersion = "WINDOWS_SERVER_2012_R2_ENGLISH_STIG_CORE" WindowsVersion_WINDOWS_SERVER_2012_R2_RTM_TURKISH_64BIT_BASE WindowsVersion = "WINDOWS_SERVER_2012_R2_RTM_TURKISH_64BIT_BASE" WindowsVersion_WINDOWS_SERVER_2012_RTM_JAPANESE_64BIT_SQL_2012_SP4_WEB WindowsVersion = "WINDOWS_SERVER_2012_RTM_JAPANESE_64BIT_SQL_2012_SP4_WEB" WindowsVersion_WINDOWS_SERVER_2012_RTM_POLISH_64BIT_BASE WindowsVersion = "WINDOWS_SERVER_2012_RTM_POLISH_64BIT_BASE" WindowsVersion_WINDOWS_SERVER_2012_RTM_SPANISH_64BIT_BASE WindowsVersion = "WINDOWS_SERVER_2012_RTM_SPANISH_64BIT_BASE" WindowsVersion_WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2016_SP2_WEB WindowsVersion = "WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2016_SP2_WEB" WindowsVersion_WINDOWS_SERVER_2012_R2_RTM_KOREAN_64BIT_BASE WindowsVersion = "WINDOWS_SERVER_2012_R2_RTM_KOREAN_64BIT_BASE" WindowsVersion_WINDOWS_SERVER_2012_RTM_DUTCH_64BIT_BASE WindowsVersion = "WINDOWS_SERVER_2012_RTM_DUTCH_64BIT_BASE" WindowsVersion_WINDOWS_SERVER_2012_R2_RTM_CHINESE_TRADITIONAL_HONG_KONG_64BIT_BASE WindowsVersion = "WINDOWS_SERVER_2012_R2_RTM_CHINESE_TRADITIONAL_HONG_KONG_64BIT_BASE" WindowsVersion_WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2014_SP3_EXPRESS WindowsVersion = "WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2014_SP3_EXPRESS" WindowsVersion_WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2016_SP2_ENTERPRISE WindowsVersion = "WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2016_SP2_ENTERPRISE" WindowsVersion_WINDOWS_SERVER_2012_RTM_CHINESE_SIMPLIFIED_64BIT_BASE WindowsVersion = "WINDOWS_SERVER_2012_RTM_CHINESE_SIMPLIFIED_64BIT_BASE" WindowsVersion_WINDOWS_SERVER_2012_RTM_ENGLISH_64BIT_SQL_2012_SP4_WEB WindowsVersion = "WINDOWS_SERVER_2012_RTM_ENGLISH_64BIT_SQL_2012_SP4_WEB" WindowsVersion_WINDOWS_SERVER_2012_RTM_JAPANESE_64BIT_SQL_2014_SP3_WEB WindowsVersion = "WINDOWS_SERVER_2012_RTM_JAPANESE_64BIT_SQL_2014_SP3_WEB" WindowsVersion_WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_SQL_2016_SP3_EXPRESS WindowsVersion = "WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_SQL_2016_SP3_EXPRESS" WindowsVersion_WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_SQL_2016_SP3_WEB WindowsVersion = "WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_SQL_2016_SP3_WEB" WindowsVersion_WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2016_SP3_STANDARD WindowsVersion = "WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2016_SP3_STANDARD" WindowsVersion_WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2016_SP3_EXPRESS WindowsVersion = "WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2016_SP3_EXPRESS" WindowsVersion_WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2016_SP3_WEB WindowsVersion = "WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2016_SP3_WEB" WindowsVersion_WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_SQL_2014_SP2_STANDARD WindowsVersion = "WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_SQL_2014_SP2_STANDARD" WindowsVersion_WINDOWS_SERVER_2012_RTM_JAPANESE_64BIT_SQL_2012_SP4_EXPRESS WindowsVersion = "WINDOWS_SERVER_2012_RTM_JAPANESE_64BIT_SQL_2012_SP4_EXPRESS" WindowsVersion_WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_SQL_2016_SP3_ENTERPRISE WindowsVersion = "WINDOWS_SERVER_2012_R2_RTM_JAPANESE_64BIT_SQL_2016_SP3_ENTERPRISE" WindowsVersion_WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2016_SP3_ENTERPRISE WindowsVersion = "WINDOWS_SERVER_2012_R2_RTM_ENGLISH_64BIT_SQL_2016_SP3_ENTERPRISE" // 2016 - Start. WindowsVersion_WINDOWS_SERVER_2016_ENGLISH_CORE_CONTAINERS WindowsVersion = "WINDOWS_SERVER_2016_ENGLISH_CORE_CONTAINERS" WindowsVersion_WINDOWS_SERVER_2016_ENGLISH_CORE_SQL_2016_SP1_WEB WindowsVersion = "WINDOWS_SERVER_2016_ENGLISH_CORE_SQL_2016_SP1_WEB" WindowsVersion_WINDOWS_SERVER_2016_GERMAN_FULL_BASE WindowsVersion = "WINDOWS_SERVER_2016_GERMAN_FULL_BASE" WindowsVersion_WINDOWS_SERVER_2016_ENGLISH_CORE_SQL_2016_SP1_EXPRESS WindowsVersion = "WINDOWS_SERVER_2016_ENGLISH_CORE_SQL_2016_SP1_EXPRESS" WindowsVersion_WINDOWS_SERVER_2016_ENGLISH_DEEP_LEARNING WindowsVersion = "WINDOWS_SERVER_2016_ENGLISH_DEEP_LEARNING" WindowsVersion_WINDOWS_SERVER_2016_JAPANESE_FULL_FQL_2016_SP2_WEB WindowsVersion = "WINDOWS_SERVER_2016_JAPANESE_FULL_FQL_2016_SP2_WEB" WindowsVersion_WINDOWS_SERVER_2016_KOREAN_FULL_BASE WindowsVersion = "WINDOWS_SERVER_2016_KOREAN_FULL_BASE" WindowsVersion_WINDOWS_SERVER_2016_KOREAN_FULL_SQL_2016_SP2_STANDARD WindowsVersion = "WINDOWS_SERVER_2016_KOREAN_FULL_SQL_2016_SP2_STANDARD" WindowsVersion_WINDOWS_SERVER_2016_POLISH_FULL_BASE WindowsVersion = "WINDOWS_SERVER_2016_POLISH_FULL_BASE" WindowsVersion_WINDOWS_SERVER_2016_ENGLISH_FULL_CONTAINERS WindowsVersion = "WINDOWS_SERVER_2016_ENGLISH_FULL_CONTAINERS" WindowsVersion_WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2016_SP1_STANDARD WindowsVersion = "WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2016_SP1_STANDARD" WindowsVersion_WINDOWS_SERVER_2016_RUSSIAN_FULL_BASE WindowsVersion = "WINDOWS_SERVER_2016_RUSSIAN_FULL_BASE" WindowsVersion_WINDOWS_SERVER_2016_ENGLISH_CORE_SQL_2016_SP2_ENTERPRISE WindowsVersion = "WINDOWS_SERVER_2016_ENGLISH_CORE_SQL_2016_SP2_ENTERPRISE" WindowsVersion_WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2016_SP1_EXPRESS WindowsVersion = "WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2016_SP1_EXPRESS" WindowsVersion_WINDOWS_SERVER_2016_ITALIAN_FULL_BASE WindowsVersion = "WINDOWS_SERVER_2016_ITALIAN_FULL_BASE" WindowsVersion_WINDOWS_SERVER_2016_SPANISH_FULL_BASE WindowsVersion = "WINDOWS_SERVER_2016_SPANISH_FULL_BASE" WindowsVersion_WINDOWS_SERVER_2012_RTM_GERMAN_64BIT_BASE WindowsVersion = "WINDOWS_SERVER_2012_RTM_GERMAN_64BIT_BASE" WindowsVersion_WINDOWS_SERVER_2012_RTM_JAPANESE_64BIT_SQL_2008_R2_SP3_STANDARD WindowsVersion = "WINDOWS_SERVER_2012_RTM_JAPANESE_64BIT_SQL_2008_R2_SP3_STANDARD" WindowsVersion_WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2016_SP2_STANDARD WindowsVersion = "WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2016_SP2_STANDARD" WindowsVersion_WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2016_SP2_ENTERPRISE WindowsVersion = "WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2016_SP2_ENTERPRISE" WindowsVersion_WINDOWS_SERVER_2016_ENGLISH_FULL_HYPERV WindowsVersion = "WINDOWS_SERVER_2016_ENGLISH_FULL_HYPERV" WindowsVersion_WINDOWS_SERVER_2016_ENGLISH_CORE_CONTAINERSLATEST WindowsVersion = "WINDOWS_SERVER_2016_ENGLISH_CORE_CONTAINERSLATEST" WindowsVersion_WINDOWS_SERVER_2016_DUTCH_FULL_BASE WindowsVersion = "WINDOWS_SERVER_2016_DUTCH_FULL_BASE" WindowsVersion_WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2016_SP2_EXPRESS WindowsVersion = "WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2016_SP2_EXPRESS" WindowsVersion_WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2017_ENTERPRISE WindowsVersion = "WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2017_ENTERPRISE" WindowsVersion_WINDOWS_SERVER_2016_HUNGARIAN_FULL_BASE WindowsVersion = "WINDOWS_SERVER_2016_HUNGARIAN_FULL_BASE" WindowsVersion_WINDOWS_SERVER_2016_KOREAN_FULL_SQL_2016_SP1_STANDARD WindowsVersion = "WINDOWS_SERVER_2016_KOREAN_FULL_SQL_2016_SP1_STANDARD" WindowsVersion_WINDOWS_SERVER_2016_ENGLISH_CORE_BASE WindowsVersion = "WINDOWS_SERVER_2016_ENGLISH_CORE_BASE" WindowsVersion_WINDOWS_SERVER_2016_ENGLISH_FULL_BASE WindowsVersion = "WINDOWS_SERVER_2016_ENGLISH_FULL_BASE" WindowsVersion_WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2017_WEB WindowsVersion = "WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2017_WEB" WindowsVersion_WINDOWS_SERVER_2016_ENGLISH_CORE_SQL_2016_SP1_ENTERPRISE WindowsVersion = "WINDOWS_SERVER_2016_ENGLISH_CORE_SQL_2016_SP1_ENTERPRISE" WindowsVersion_WINDOWS_SERVER_2016_JAPANESE_FULL_SQL_2016_SP1_WEB WindowsVersion = "WINDOWS_SERVER_2016_JAPANESE_FULL_SQL_2016_SP1_WEB" WindowsVersion_WINDOWS_SERVER_2016_SWEDISH_FULL_BASE WindowsVersion = "WINDOWS_SERVER_2016_SWEDISH_FULL_BASE" WindowsVersion_WINDOWS_SERVER_2016_TURKISH_FULL_BASE WindowsVersion = "WINDOWS_SERVER_2016_TURKISH_FULL_BASE" WindowsVersion_WINDOWS_SERVER_2016_PORTUGUESE_BRAZIL_FULL_BASE WindowsVersion = "WINDOWS_SERVER_2016_PORTUGUESE_BRAZIL_FULL_BASE" WindowsVersion_WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2019_STANDARD WindowsVersion = "WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2019_STANDARD" WindowsVersion_WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2014_SP3_STANDARD WindowsVersion = "WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2014_SP3_STANDARD" WindowsVersion_WINDOWS_SERVER_2016_JAPANESE_FULL_SQL_2016_SP3_ENTERPRISE WindowsVersion = "WINDOWS_SERVER_2016_JAPANESE_FULL_SQL_2016_SP3_ENTERPRISE" WindowsVersion_WINDOWS_SERVER_2016_ENGLISH_64BIT_SQL_2012_SP4_ENTERPRISE WindowsVersion = "WINDOWS_SERVER_2016_ENGLISH_64BIT_SQL_2012_SP4_ENTERPRISE" WindowsVersion_WINDOWS_SERVER_2016_ENGLISH_CORE_SQL_2016_SP1_STANDARD WindowsVersion = "WINDOWS_SERVER_2016_ENGLISH_CORE_SQL_2016_SP1_STANDARD" WindowsVersion_WINDOWS_SERVER_2016_ENGLISH_CORE_SQL_2016_SP2_EXPRESS WindowsVersion = "WINDOWS_SERVER_2016_ENGLISH_CORE_SQL_2016_SP2_EXPRESS" WindowsVersion_WINDOWS_SERVER_2016_ENGLISH_CORE_SQL_2016_SP2_WEB WindowsVersion = "WINDOWS_SERVER_2016_ENGLISH_CORE_SQL_2016_SP2_WEB" WindowsVersion_WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2017_STANDARD WindowsVersion = "WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2017_STANDARD" WindowsVersion_WINDOWS_SERVER_2016_PORTUGUESE_PORTUGAL_FULL_BASE WindowsVersion = "WINDOWS_SERVER_2016_PORTUGUESE_PORTUGAL_FULL_BASE" WindowsVersion_WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2014_SP3_ENTERPRISE WindowsVersion = "WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2014_SP3_ENTERPRISE" WindowsVersion_WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2019_ENTERPRISE WindowsVersion = "WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2019_ENTERPRISE" WindowsVersion_WINDOWS_SERVER_2016_JAPANESE_FULL_SQL_2017_STANDARD WindowsVersion = "WINDOWS_SERVER_2016_JAPANESE_FULL_SQL_2017_STANDARD" WindowsVersion_WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2019_EXPRESS WindowsVersion = "WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2019_EXPRESS" WindowsVersion_WINDOWS_SERVER_2016_JAPANESE_FULL_SQL_2017_WEB WindowsVersion = "WINDOWS_SERVER_2016_JAPANESE_FULL_SQL_2017_WEB" WindowsVersion_WINDOWS_SERVER_2016_ENGLISH_CORE_SQL_2016_SP3_WEB WindowsVersion = "WINDOWS_SERVER_2016_ENGLISH_CORE_SQL_2016_SP3_WEB" WindowsVersion_WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2016_SP3_ENTERPRISE WindowsVersion = "WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2016_SP3_ENTERPRISE" WindowsVersion_WINDOWS_SERVER_2016_ENGLISH_STIG_CORE WindowsVersion = "WINDOWS_SERVER_2016_ENGLISH_STIG_CORE" WindowsVersion_WINDOWS_SERVER_2016_KOREAN_FULL_SQL_2016_SP3_STANDARD WindowsVersion = "WINDOWS_SERVER_2016_KOREAN_FULL_SQL_2016_SP3_STANDARD" WindowsVersion_WINDOWS_SERVER_2016_ENGLISH_FULL_ECS_OPTIMIZED WindowsVersion = "WINDOWS_SERVER_2016_ENGLISH_FULL_ECS_OPTIMIZED" WindowsVersion_WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2016_SP3_STANDARD WindowsVersion = "WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2016_SP3_STANDARD" WindowsVersion_WINDOWS_SERVER_2016_JAPANESE_FULL_SQL_2017_ENTERPRISE WindowsVersion = "WINDOWS_SERVER_2016_JAPANESE_FULL_SQL_2017_ENTERPRISE" WindowsVersion_WINDOWS_SERVER_2016_JAPANESE_FULL_SQL_2016_SP2_EXPRESS WindowsVersion = "WINDOWS_SERVER_2016_JAPANESE_FULL_SQL_2016_SP2_EXPRESS" WindowsVersion_WINDOWS_SERVER_2016_JAPANESE_FULL_SQL_2019_WEB WindowsVersion = "WINDOWS_SERVER_2016_JAPANESE_FULL_SQL_2019_WEB" WindowsVersion_WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2016_SP3_WEB WindowsVersion = "WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2016_SP3_WEB" WindowsVersion_WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2016_SP1_WEB WindowsVersion = "WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2016_SP1_WEB" WindowsVersion_WINDOWS_SERVER_2016_ENGLISH_P3 WindowsVersion = "WINDOWS_SERVER_2016_ENGLISH_P3" WindowsVersion_WINDOWS_SERVER_2016_JAPANESE_FULL_SQL_2016_SP1_ENTERPRISE WindowsVersion = "WINDOWS_SERVER_2016_JAPANESE_FULL_SQL_2016_SP1_ENTERPRISE" WindowsVersion_WINDOWS_SERVER_2016_JAPANESE_FULL_BASE WindowsVersion = "WINDOWS_SERVER_2016_JAPANESE_FULL_BASE" WindowsVersion_WINDOWS_SERVER_2016_CHINESE_SIMPLIFIED_FULL_BASE WindowsVersion = "WINDOWS_SERVER_2016_CHINESE_SIMPLIFIED_FULL_BASE" WindowsVersion_WINDOWS_SERVER_2016_FRENCH_FULL_BASE WindowsVersion = "WINDOWS_SERVER_2016_FRENCH_FULL_BASE" WindowsVersion_WINDOWS_SERVER_2016_JAPANESE_FULL_SQL_2016_SP2_ENTERPRISE WindowsVersion = "WINDOWS_SERVER_2016_JAPANESE_FULL_SQL_2016_SP2_ENTERPRISE" WindowsVersion_WINDOWS_SERVER_2016_CZECH_FULL_BASE WindowsVersion = "WINDOWS_SERVER_2016_CZECH_FULL_BASE" WindowsVersion_WINDOWS_SERVER_2016_JAPANESE_FULL_SQL_2016_SP1_STANDARD WindowsVersion = "WINDOWS_SERVER_2016_JAPANESE_FULL_SQL_2016_SP1_STANDARD" WindowsVersion_WINDOWS_SERVER_2016_ENGLISH_CORE_SQL_2016_SP2_STANDARD WindowsVersion = "WINDOWS_SERVER_2016_ENGLISH_CORE_SQL_2016_SP2_STANDARD" WindowsVersion_WINDOWS_SERVER_2016_JAPANESE_FULL_SQL_2016_SP2_STANDARD WindowsVersion = "WINDOWS_SERVER_2016_JAPANESE_FULL_SQL_2016_SP2_STANDARD" WindowsVersion_WINDOWS_SERVER_2016_CHINESE_TRADITIONAL_FULL_BASE WindowsVersion = "WINDOWS_SERVER_2016_CHINESE_TRADITIONAL_FULL_BASE" WindowsVersion_WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2016_SP2_WEB WindowsVersion = "WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2016_SP2_WEB" WindowsVersion_WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2017_EXPRESS WindowsVersion = "WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2017_EXPRESS" WindowsVersion_WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2019_WEB WindowsVersion = "WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2019_WEB" WindowsVersion_WINDOWS_SERVER_2016_ENGLISH_CORE_SQL_2016_SP3_EXPRESS WindowsVersion = "WINDOWS_SERVER_2016_ENGLISH_CORE_SQL_2016_SP3_EXPRESS" WindowsVersion_WINDOWS_SERVER_2016_JAPANESE_FULL_SQL_2019_STANDARD WindowsVersion = "WINDOWS_SERVER_2016_JAPANESE_FULL_SQL_2019_STANDARD" WindowsVersion_WINDOWS_SERVER_2016_ENGLISH_TESLA WindowsVersion = "WINDOWS_SERVER_2016_ENGLISH_TESLA" WindowsVersion_WINDOWS_SERVER_2016_JAPANESE_FULL_SQL_2016_SP3_EXPRESS WindowsVersion = "WINDOWS_SERVER_2016_JAPANESE_FULL_SQL_2016_SP3_EXPRESS" WindowsVersion_WINDOWS_SERVER_2016_ENGLISH_STIG_FULL WindowsVersion = "WINDOWS_SERVER_2016_ENGLISH_STIG_FULL" WindowsVersion_WINDOWS_SERVER_2016_JAPANESE_FULL_SQL_2016_SP3_STANDARD WindowsVersion = "WINDOWS_SERVER_2016_JAPANESE_FULL_SQL_2016_SP3_STANDARD" WindowsVersion_WINDOWS_SERVER_2016_JAPANESE_FULL_SQL_2019_ENTERPRISE WindowsVersion = "WINDOWS_SERVER_2016_JAPANESE_FULL_SQL_2019_ENTERPRISE" WindowsVersion_WINDOWS_SERVER_2016_ENGLISH_CORE_SQL_2016_SP3_ENTERPRISE WindowsVersion = "WINDOWS_SERVER_2016_ENGLISH_CORE_SQL_2016_SP3_ENTERPRISE" WindowsVersion_WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2016_SP3_EXPRESS WindowsVersion = "WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2016_SP3_EXPRESS" WindowsVersion_WINDOWS_SERVER_2016_JAPANESE_FULL_SQL_2016_SP3_WEB WindowsVersion = "WINDOWS_SERVER_2016_JAPANESE_FULL_SQL_2016_SP3_WEB" WindowsVersion_WINDOWS_SERVER_2016_ENGLISH_CORE_SQL_2016_SP3_STANDARD WindowsVersion = "WINDOWS_SERVER_2016_ENGLISH_CORE_SQL_2016_SP3_STANDARD" WindowsVersion_WINDOWS_SERVER_2016_JAPANESE_FULL_SQL_2016_SP1_EXPRESS WindowsVersion = "WINDOWS_SERVER_2016_JAPANESE_FULL_SQL_2016_SP1_EXPRESS" WindowsVersion_WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2016_SP1_ENTERPRISE WindowsVersion = "WINDOWS_SERVER_2016_ENGLISH_FULL_SQL_2016_SP1_ENTERPRISE" // 2019 - Start. WindowsVersion_WINDOWS_SERVER_2019_ENGLISH_FULL_SQL_2017_WEB WindowsVersion = "WINDOWS_SERVER_2019_ENGLISH_FULL_SQL_2017_WEB" WindowsVersion_WINDOWS_SERVER_2019_FRENCH_FULL_BASE WindowsVersion = "WINDOWS_SERVER_2019_FRENCH_FULL_BASE" WindowsVersion_WINDOWS_SERVER_2019_KOREAN_FULL_BASE WindowsVersion = "WINDOWS_SERVER_2019_KOREAN_FULL_BASE" WindowsVersion_WINDOWS_SERVER_2019_ITALIAN_FULL_BASE WindowsVersion = "WINDOWS_SERVER_2019_ITALIAN_FULL_BASE" WindowsVersion_WINDOWS_SERVER_2019_CHINESE_SIMPLIFIED_FULL_BASE WindowsVersion = "WINDOWS_SERVER_2019_CHINESE_SIMPLIFIED_FULL_BASE" WindowsVersion_WINDOWS_SERVER_2019_ENGLISH_FULL_SQL_2016_SP2_WEB WindowsVersion = "WINDOWS_SERVER_2019_ENGLISH_FULL_SQL_2016_SP2_WEB" WindowsVersion_WINDOWS_SERVER_2019_ENGLISH_FULL_HYPERV WindowsVersion = "WINDOWS_SERVER_2019_ENGLISH_FULL_HYPERV" WindowsVersion_WINDOWS_SERVER_2019_ENGLISH_FULL_SQL_2016_SP2_STANDARD WindowsVersion = "WINDOWS_SERVER_2019_ENGLISH_FULL_SQL_2016_SP2_STANDARD" WindowsVersion_WINDOWS_SERVER_2019_HUNGARIAN_FULL_BASE WindowsVersion = "WINDOWS_SERVER_2019_HUNGARIAN_FULL_BASE" WindowsVersion_WINDOWS_SERVER_2019_ENGLISH_FULL_SQL_2016_SP2_EXPRESS WindowsVersion = "WINDOWS_SERVER_2019_ENGLISH_FULL_SQL_2016_SP2_EXPRESS" WindowsVersion_WINDOWS_SERVER_2019_TURKISH_FULL_BASE WindowsVersion = "WINDOWS_SERVER_2019_TURKISH_FULL_BASE" WindowsVersion_WINDOWS_SERVER_2019_ENGLISH_FULL_SQL_2019_STANDARD WindowsVersion = "WINDOWS_SERVER_2019_ENGLISH_FULL_SQL_2019_STANDARD" WindowsVersion_WINDOWS_SERVER_2019_ENGLISH_FULL_SQL_2017_STANDARD WindowsVersion = "WINDOWS_SERVER_2019_ENGLISH_FULL_SQL_2017_STANDARD" WindowsVersion_WINDOWS_SERVER_2019_ENGLISH_CORE_CONTAINERSLATEST WindowsVersion = "WINDOWS_SERVER_2019_ENGLISH_CORE_CONTAINERSLATEST" WindowsVersion_WINDOWS_SERVER_2019_ENGLISH_FULL_SQL_2017_EXPRESS WindowsVersion = "WINDOWS_SERVER_2019_ENGLISH_FULL_SQL_2017_EXPRESS" WindowsVersion_WINDOWS_SERVER_2019_JAPANESE_FULL_BASE WindowsVersion = "WINDOWS_SERVER_2019_JAPANESE_FULL_BASE" WindowsVersion_WINDOWS_SERVER_2019_RUSSIAN_FULL_BASE WindowsVersion = "WINDOWS_SERVER_2019_RUSSIAN_FULL_BASE" WindowsVersion_WINDOWS_SERVER_2019_CHINESE_TRADITIONAL_FULL_BASE WindowsVersion = "WINDOWS_SERVER_2019_CHINESE_TRADITIONAL_FULL_BASE" WindowsVersion_WINDOWS_SERVER_2019_ENGLISH_CORE_BASE WindowsVersion = "WINDOWS_SERVER_2019_ENGLISH_CORE_BASE" WindowsVersion_WINDOWS_SERVER_2019_ENGLISH_FULL_BASE WindowsVersion = "WINDOWS_SERVER_2019_ENGLISH_FULL_BASE" WindowsVersion_WINDOWS_SERVER_2019_JAPANESE_FULL_SQL_2022_STANDARD WindowsVersion = "WINDOWS_SERVER_2019_JAPANESE_FULL_SQL_2022_STANDARD" WindowsVersion_WINDOWS_SERVER_2019_JAPANESE_FULL_SQL_2022_ENTERPRISE WindowsVersion = "WINDOWS_SERVER_2019_JAPANESE_FULL_SQL_2022_ENTERPRISE" WindowsVersion_WINDOWS_SERVER_2019_ENGLISH_TESLA WindowsVersion = "WINDOWS_SERVER_2019_ENGLISH_TESLA" WindowsVersion_WINDOWS_SERVER_2019_ENGLISH_FULL_SQL_2019_ENTERPRISE WindowsVersion = "WINDOWS_SERVER_2019_ENGLISH_FULL_SQL_2019_ENTERPRISE" WindowsVersion_WINDOWS_SERVER_2019_SPANISH_FULL_BASE WindowsVersion = "WINDOWS_SERVER_2019_SPANISH_FULL_BASE" WindowsVersion_WINDOWS_SERVER_2019_ENGLISH_FULL_SQL_2022_ENTERPRISE WindowsVersion = "WINDOWS_SERVER_2019_ENGLISH_FULL_SQL_2022_ENTERPRISE" WindowsVersion_WINDOWS_SERVER_2019_ENGLISH_STIG_FULL WindowsVersion = "WINDOWS_SERVER_2019_ENGLISH_STIG_FULL" WindowsVersion_WINDOWS_SERVER_2019_ENGLISH_FULL_SQL_2016_SP3_WEB WindowsVersion = "WINDOWS_SERVER_2019_ENGLISH_FULL_SQL_2016_SP3_WEB" WindowsVersion_WINDOWS_SERVER_2019_ENGLISH_FULL_SQL_2016_SP3_STANDARD WindowsVersion = "WINDOWS_SERVER_2019_ENGLISH_FULL_SQL_2016_SP3_STANDARD" WindowsVersion_WINDOWS_SERVER_2019_JAPANESE_FULL_SQL_2017_ENTERPRISE WindowsVersion = "WINDOWS_SERVER_2019_JAPANESE_FULL_SQL_2017_ENTERPRISE" WindowsVersion_WINDOWS_SERVER_2019_ENGLISH_FULL_SQL_2016_SP2_ENTERPRISE WindowsVersion = "WINDOWS_SERVER_2019_ENGLISH_FULL_SQL_2016_SP2_ENTERPRISE" WindowsVersion_WINDOWS_SERVER_2019_PORTUGUESE_PORTUGAL_FULL_BASE WindowsVersion = "WINDOWS_SERVER_2019_PORTUGUESE_PORTUGAL_FULL_BASE" WindowsVersion_WINDOWS_SERVER_2019_SWEDISH_FULL_BASE WindowsVersion = "WINDOWS_SERVER_2019_SWEDISH_FULL_BASE" WindowsVersion_WINDOWS_SERVER_2019_ENGLISH_FULL_SQL_2022_EXPRESS WindowsVersion = "WINDOWS_SERVER_2019_ENGLISH_FULL_SQL_2022_EXPRESS" WindowsVersion_WINDOWS_SERVER_2019_JAPANESE_FULL_SQL_2022_WEB WindowsVersion = "WINDOWS_SERVER_2019_JAPANESE_FULL_SQL_2022_WEB" WindowsVersion_WINDOWS_SERVER_2019_ENGLISH_FULL_SQL_2016_SP3_ENTERPRISE WindowsVersion = "WINDOWS_SERVER_2019_ENGLISH_FULL_SQL_2016_SP3_ENTERPRISE" WindowsVersion_WINDOWS_SERVER_2019_ENGLISH_FULL_SQL_2022_WEB WindowsVersion = "WINDOWS_SERVER_2019_ENGLISH_FULL_SQL_2022_WEB" WindowsVersion_WINDOWS_SERVER_2019_ENGLISH_FULL_SQL_2019_WEB WindowsVersion = "WINDOWS_SERVER_2019_ENGLISH_FULL_SQL_2019_WEB" WindowsVersion_WINDOWS_SERVER_2019_PORTUGUESE_BRAZIL_FULL_BASE WindowsVersion = "WINDOWS_SERVER_2019_PORTUGUESE_BRAZIL_FULL_BASE" WindowsVersion_WINDOWS_SERVER_2019_ENGLISH_FULL_CONTAINERSLATEST WindowsVersion = "WINDOWS_SERVER_2019_ENGLISH_FULL_CONTAINERSLATEST" WindowsVersion_WINDOWS_SERVER_2019_ENGLISH_FULL_SQL_2017_ENTERPRISE WindowsVersion = "WINDOWS_SERVER_2019_ENGLISH_FULL_SQL_2017_ENTERPRISE" WindowsVersion_WINDOWS_SERVER_2019_JAPANESE_FULL_SQL_2019_ENTERPRISE WindowsVersion = "WINDOWS_SERVER_2019_JAPANESE_FULL_SQL_2019_ENTERPRISE" WindowsVersion_WINDOWS_SERVER_2019_ENGLISH_FULL_SQL_2019_EXPRESS WindowsVersion = "WINDOWS_SERVER_2019_ENGLISH_FULL_SQL_2019_EXPRESS" WindowsVersion_WINDOWS_SERVER_2019_JAPANESE_FULL_SQL_2017_WEB WindowsVersion = "WINDOWS_SERVER_2019_JAPANESE_FULL_SQL_2017_WEB" WindowsVersion_WINDOWS_SERVER_2019_ENGLISH_FULL_SQL_2016_SP3_EXPRESS WindowsVersion = "WINDOWS_SERVER_2019_ENGLISH_FULL_SQL_2016_SP3_EXPRESS" WindowsVersion_WINDOWS_SERVER_2019_ENGLISH_STIG_CORE WindowsVersion = "WINDOWS_SERVER_2019_ENGLISH_STIG_CORE" WindowsVersion_WINDOWS_SERVER_2019_ENGLISH_CORE_ECS_OPTIMIZED WindowsVersion = "WINDOWS_SERVER_2019_ENGLISH_CORE_ECS_OPTIMIZED" WindowsVersion_WINDOWS_SERVER_2019_ENGLISH_FULL_SQL_2022_STANDARD WindowsVersion = "WINDOWS_SERVER_2019_ENGLISH_FULL_SQL_2022_STANDARD" WindowsVersion_WINDOWS_SERVER_2019_JAPANESE_FULL_SQL_2017_STANDARD WindowsVersion = "WINDOWS_SERVER_2019_JAPANESE_FULL_SQL_2017_STANDARD" WindowsVersion_WINDOWS_SERVER_2019_JAPANESE_FULL_SQL_2019_WEB WindowsVersion = "WINDOWS_SERVER_2019_JAPANESE_FULL_SQL_2019_WEB" WindowsVersion_WINDOWS_SERVER_2019_ENGLISH_FULL_ECS_OPTIMIZED WindowsVersion = "WINDOWS_SERVER_2019_ENGLISH_FULL_ECS_OPTIMIZED" WindowsVersion_WINDOWS_SERVER_2019_ENGLISH_DEEP_LEARNING WindowsVersion = "WINDOWS_SERVER_2019_ENGLISH_DEEP_LEARNING" WindowsVersion_WINDOWS_SERVER_2019_JAPANESE_FULL_SQL_2019_STANDARD WindowsVersion = "WINDOWS_SERVER_2019_JAPANESE_FULL_SQL_2019_STANDARD" WindowsVersion_WINDOWS_SERVER_2019_CZECH_FULL_BASE WindowsVersion = "WINDOWS_SERVER_2019_CZECH_FULL_BASE" WindowsVersion_WINDOWS_SERVER_2019_POLISH_FULL_BASE WindowsVersion = "WINDOWS_SERVER_2019_POLISH_FULL_BASE" WindowsVersion_WINDOWS_SERVER_2019_GERMAN_FULL_BASE WindowsVersion = "WINDOWS_SERVER_2019_GERMAN_FULL_BASE" WindowsVersion_WINDOWS_SERVER_2019_DUTCH_FULL_BASE WindowsVersion = "WINDOWS_SERVER_2019_DUTCH_FULL_BASE" // 2022 - Start. WindowsVersion_WINDOWS_SERVER_2022_ENGLISH_STIG_FULL WindowsVersion = "WINDOWS_SERVER_2022_ENGLISH_STIG_FULL" WindowsVersion_WINDOWS_SERVER_2022_JAPANESE_FULL_SQL_2022_WEB WindowsVersion = "WINDOWS_SERVER_2022_JAPANESE_FULL_SQL_2022_WEB" WindowsVersion_WINDOWS_SERVER_2022_ENGLISH_FULL_SQL_2022_WEB WindowsVersion = "WINDOWS_SERVER_2022_ENGLISH_FULL_SQL_2022_WEB" WindowsVersion_WINDOWS_SERVER_2022_ENGLISH_STIG_CORE WindowsVersion = "WINDOWS_SERVER_2022_ENGLISH_STIG_CORE" WindowsVersion_WINDOWS_SERVER_2022_JAPANESE_FULL_SQL_2019_ENTERPRISE WindowsVersion = "WINDOWS_SERVER_2022_JAPANESE_FULL_SQL_2019_ENTERPRISE" WindowsVersion_WINDOWS_SERVER_2022_PORTUGUESE_BRAZIL_FULL_BASE WindowsVersion = "WINDOWS_SERVER_2022_PORTUGUESE_BRAZIL_FULL_BASE" WindowsVersion_WINDOWS_SERVER_2022_ITALIAN_FULL_BASE WindowsVersion = "WINDOWS_SERVER_2022_ITALIAN_FULL_BASE" WindowsVersion_WINDOWS_SERVER_2022_ENGLISH_FULL_CONTAINERSLATEST WindowsVersion = "WINDOWS_SERVER_2022_ENGLISH_FULL_CONTAINERSLATEST" WindowsVersion_WINDOWS_SERVER_2022_RUSSIAN_FULL_BASE WindowsVersion = "WINDOWS_SERVER_2022_RUSSIAN_FULL_BASE" WindowsVersion_WINDOWS_SERVER_2022_ENGLISH_FULL_SQL_2019_EXPRESS WindowsVersion = "WINDOWS_SERVER_2022_ENGLISH_FULL_SQL_2019_EXPRESS" WindowsVersion_WINDOWS_SERVER_2022_POLISH_FULL_BASE WindowsVersion = "WINDOWS_SERVER_2022_POLISH_FULL_BASE" WindowsVersion_WINDOWS_SERVER_2022_ENGLISH_CORE_BASE WindowsVersion = "WINDOWS_SERVER_2022_ENGLISH_CORE_BASE" WindowsVersion_WINDOWS_SERVER_2022_HUNGARIAN_FULL_BASE WindowsVersion = "WINDOWS_SERVER_2022_HUNGARIAN_FULL_BASE" WindowsVersion_WINDOWS_SERVER_2022_ENGLISH_FULL_SQL_2017_EXPRESS WindowsVersion = "WINDOWS_SERVER_2022_ENGLISH_FULL_SQL_2017_EXPRESS" WindowsVersion_WINDOWS_SERVER_2022_GERMAN_FULL_BASE WindowsVersion = "WINDOWS_SERVER_2022_GERMAN_FULL_BASE" WindowsVersion_WINDOWS_SERVER_2022_ENGLISH_CORE_CONTAINERSLATEST WindowsVersion = "WINDOWS_SERVER_2022_ENGLISH_CORE_CONTAINERSLATEST" WindowsVersion_WINDOWS_SERVER_2022_ENGLISH_FULL_SQL_2019_STANDARD WindowsVersion = "WINDOWS_SERVER_2022_ENGLISH_FULL_SQL_2019_STANDARD" WindowsVersion_WINDOWS_SERVER_2022_JAPANESE_FULL_SQL_2017_WEB WindowsVersion = "WINDOWS_SERVER_2022_JAPANESE_FULL_SQL_2017_WEB" WindowsVersion_WINDOWS_SERVER_2022_ENGLISH_FULL_SQL_2017_WEB WindowsVersion = "WINDOWS_SERVER_2022_ENGLISH_FULL_SQL_2017_WEB" WindowsVersion_WINDOWS_SERVER_2022_JAPANESE_FULL_BASE WindowsVersion = "WINDOWS_SERVER_2022_JAPANESE_FULL_BASE" WindowsVersion_WINDOWS_SERVER_2022_KOREAN_FULL_BASE WindowsVersion = "WINDOWS_SERVER_2022_KOREAN_FULL_BASE" WindowsVersion_WINDOWS_SERVER_2022_JAPANESE_FULL_SQL_2017_ENTERPRISE WindowsVersion = "WINDOWS_SERVER_2022_JAPANESE_FULL_SQL_2017_ENTERPRISE" WindowsVersion_WINDOWS_SERVER_2022_JAPANESE_FULL_SQL_2019_STANDARD WindowsVersion = "WINDOWS_SERVER_2022_JAPANESE_FULL_SQL_2019_STANDARD" WindowsVersion_WINDOWS_SERVER_2022_CHINESE_SIMPLIFIED_FULL_BASE WindowsVersion = "WINDOWS_SERVER_2022_CHINESE_SIMPLIFIED_FULL_BASE" WindowsVersion_WINDOWS_SERVER_2022_ENGLISH_FULL_SQL_2019_WEB WindowsVersion = "WINDOWS_SERVER_2022_ENGLISH_FULL_SQL_2019_WEB" WindowsVersion_WINDOWS_SERVER_2022_SPANISH_FULL_BASE WindowsVersion = "WINDOWS_SERVER_2022_SPANISH_FULL_BASE" WindowsVersion_WINDOWS_SERVER_2022_ENGLISH_CORE_ECS_OPTIMIZED WindowsVersion = "WINDOWS_SERVER_2022_ENGLISH_CORE_ECS_OPTIMIZED" WindowsVersion_WINDOWS_SERVER_2022_ENGLISH_FULL_SQL_2017_STANDARD WindowsVersion = "WINDOWS_SERVER_2022_ENGLISH_FULL_SQL_2017_STANDARD" WindowsVersion_WINDOWS_SERVER_2022_CHINESE_TRADITIONAL_FULL_BASE WindowsVersion = "WINDOWS_SERVER_2022_CHINESE_TRADITIONAL_FULL_BASE" WindowsVersion_WINDOWS_SERVER_2022_ENGLISH_FULL_SQL_2019_ENTERPRISE WindowsVersion = "WINDOWS_SERVER_2022_ENGLISH_FULL_SQL_2019_ENTERPRISE" WindowsVersion_WINDOWS_SERVER_2022_FRENCH_FULL_BASE WindowsVersion = "WINDOWS_SERVER_2022_FRENCH_FULL_BASE" WindowsVersion_WINDOWS_SERVER_2022_JAPANESE_FULL_SQL_2017_STANDARD WindowsVersion = "WINDOWS_SERVER_2022_JAPANESE_FULL_SQL_2017_STANDARD" WindowsVersion_WINDOWS_SERVER_2022_ENGLISH_FULL_BASE WindowsVersion = "WINDOWS_SERVER_2022_ENGLISH_FULL_BASE" WindowsVersion_WINDOWS_SERVER_2022_JAPANESE_FULL_SQL_2019_WEB WindowsVersion = "WINDOWS_SERVER_2022_JAPANESE_FULL_SQL_2019_WEB" WindowsVersion_WINDOWS_SERVER_2022_TURKISH_FULL_BASE WindowsVersion = "WINDOWS_SERVER_2022_TURKISH_FULL_BASE" WindowsVersion_WINDOWS_SERVER_2022_ENGLISH_FULL_SQL_2017_ENTERPRISE WindowsVersion = "WINDOWS_SERVER_2022_ENGLISH_FULL_SQL_2017_ENTERPRISE" WindowsVersion_WINDOWS_SERVER_2022_PORTUGUESE_PORTUGAL_FULL_BASE WindowsVersion = "WINDOWS_SERVER_2022_PORTUGUESE_PORTUGAL_FULL_BASE" WindowsVersion_WINDOWS_SERVER_2022_CZECH_FULL_BASE WindowsVersion = "WINDOWS_SERVER_2022_CZECH_FULL_BASE" WindowsVersion_WINDOWS_SERVER_2022_ENGLISH_FULL_ECS_OPTIMIZED WindowsVersion = "WINDOWS_SERVER_2022_ENGLISH_FULL_ECS_OPTIMIZED" WindowsVersion_WINDOWS_SERVER_2022_DUTCH_FULL_BASE WindowsVersion = "WINDOWS_SERVER_2022_DUTCH_FULL_BASE" WindowsVersion_WINDOWS_SERVER_2022_SWEDISH_FULL_BASE WindowsVersion = "WINDOWS_SERVER_2022_SWEDISH_FULL_BASE" WindowsVersion_WINDOWS_SERVER_2022_ENGLISH_FULL_SQL_2022_ENTERPRISE WindowsVersion = "WINDOWS_SERVER_2022_ENGLISH_FULL_SQL_2022_ENTERPRISE" WindowsVersion_WINDOWS_SERVER_2022_ENGLISH_FULL_SQL_2022_EXPRESS WindowsVersion = "WINDOWS_SERVER_2022_ENGLISH_FULL_SQL_2022_EXPRESS" WindowsVersion_WINDOWS_SERVER_2022_ENGLISH_FULL_SQL_2022_STANDARD WindowsVersion = "WINDOWS_SERVER_2022_ENGLISH_FULL_SQL_2022_STANDARD" WindowsVersion_WINDOWS_SERVER_2022_JAPANESE_FULL_SQL_2022_STANDARD WindowsVersion = "WINDOWS_SERVER_2022_JAPANESE_FULL_SQL_2022_STANDARD" WindowsVersion_WINDOWS_SERVER_2022_JAPANESE_FULL_SQL_2022_ENTERPRISE WindowsVersion = "WINDOWS_SERVER_2022_JAPANESE_FULL_SQL_2022_ENTERPRISE" )
Source Files
¶
- AclCidr.go
- AclCidrConfig.go
- AclCidr__checks.go
- AclIcmp.go
- AclPortRange.go
- AclTraffic.go
- AclTrafficConfig.go
- AclTraffic__checks.go
- Action.go
- AddRouteOptions.go
- AddressFamily.go
- AllocateCidrRequest.go
- AllocateIpv6CidrRequest.go
- AllocateVpcIpv6CidrRequest.go
- AllocatedSubnet.go
- AmazonLinux2022ImageSsmParameter.go
- AmazonLinux2022ImageSsmParameterProps.go
- AmazonLinux2022ImageSsmParameter__checks.go
- AmazonLinux2022Kernel.go
- AmazonLinux2022Kernel__checks.go
- AmazonLinux2023ImageSsmParameter.go
- AmazonLinux2023ImageSsmParameterProps.go
- AmazonLinux2023ImageSsmParameter__checks.go
- AmazonLinux2023Kernel.go
- AmazonLinux2023Kernel__checks.go
- AmazonLinux2ImageSsmParameter.go
- AmazonLinux2ImageSsmParameterProps.go
- AmazonLinux2ImageSsmParameter__checks.go
- AmazonLinux2Kernel.go
- AmazonLinux2Kernel__checks.go
- AmazonLinuxCpuType.go
- AmazonLinuxEdition.go
- AmazonLinuxGeneration.go
- AmazonLinuxImage.go
- AmazonLinuxImageProps.go
- AmazonLinuxImageSsmParameterBase.go
- AmazonLinuxImageSsmParameterBaseOptions.go
- AmazonLinuxImageSsmParameterBaseProps.go
- AmazonLinuxImageSsmParameterBase__checks.go
- AmazonLinuxImageSsmParameterCommonOptions.go
- AmazonLinuxImage__checks.go
- AmazonLinuxKernel.go
- AmazonLinuxStorage.go
- AmazonLinuxVirt.go
- ApplyCloudFormationInitOptions.go
- AttachInitOptions.go
- AwsIpamProps.go
- BastionHostLinux.go
- BastionHostLinuxProps.go
- BastionHostLinux__checks.go
- BlockDevice.go
- BlockDeviceVolume.go
- BlockDeviceVolume__checks.go
- CfnCapacityReservation.go
- CfnCapacityReservationFleet.go
- CfnCapacityReservationFleetProps.go
- CfnCapacityReservationFleet_InstanceTypeSpecificationProperty.go
- CfnCapacityReservationFleet_TagSpecificationProperty.go
- CfnCapacityReservationFleet__checks.go
- CfnCapacityReservationProps.go
- CfnCapacityReservation_TagSpecificationProperty.go
- CfnCapacityReservation__checks.go
- CfnCarrierGateway.go
- CfnCarrierGatewayProps.go
- CfnCarrierGateway__checks.go
- CfnClientVpnAuthorizationRule.go
- CfnClientVpnAuthorizationRuleProps.go
- CfnClientVpnAuthorizationRule__checks.go
- CfnClientVpnEndpoint.go
- CfnClientVpnEndpointProps.go
- CfnClientVpnEndpoint_CertificateAuthenticationRequestProperty.go
- CfnClientVpnEndpoint_ClientAuthenticationRequestProperty.go
- CfnClientVpnEndpoint_ClientConnectOptionsProperty.go
- CfnClientVpnEndpoint_ClientLoginBannerOptionsProperty.go
- CfnClientVpnEndpoint_ConnectionLogOptionsProperty.go
- CfnClientVpnEndpoint_DirectoryServiceAuthenticationRequestProperty.go
- CfnClientVpnEndpoint_FederatedAuthenticationRequestProperty.go
- CfnClientVpnEndpoint_TagSpecificationProperty.go
- CfnClientVpnEndpoint__checks.go
- CfnClientVpnRoute.go
- CfnClientVpnRouteProps.go
- CfnClientVpnRoute__checks.go
- CfnClientVpnTargetNetworkAssociation.go
- CfnClientVpnTargetNetworkAssociationProps.go
- CfnClientVpnTargetNetworkAssociation__checks.go
- CfnCustomerGateway.go
- CfnCustomerGatewayProps.go
- CfnCustomerGateway__checks.go
- CfnDHCPOptions.go
- CfnDHCPOptionsProps.go
- CfnDHCPOptions__checks.go
- CfnEC2Fleet.go
- CfnEC2FleetProps.go
- CfnEC2Fleet_AcceleratorCountRequestProperty.go
- CfnEC2Fleet_AcceleratorTotalMemoryMiBRequestProperty.go
- CfnEC2Fleet_BaselineEbsBandwidthMbpsRequestProperty.go
- CfnEC2Fleet_CapacityRebalanceProperty.go
- CfnEC2Fleet_CapacityReservationOptionsRequestProperty.go
- CfnEC2Fleet_FleetLaunchTemplateConfigRequestProperty.go
- CfnEC2Fleet_FleetLaunchTemplateOverridesRequestProperty.go
- CfnEC2Fleet_FleetLaunchTemplateSpecificationRequestProperty.go
- CfnEC2Fleet_InstanceRequirementsRequestProperty.go
- CfnEC2Fleet_MaintenanceStrategiesProperty.go
- CfnEC2Fleet_MemoryGiBPerVCpuRequestProperty.go
- CfnEC2Fleet_MemoryMiBRequestProperty.go
- CfnEC2Fleet_NetworkBandwidthGbpsRequestProperty.go
- CfnEC2Fleet_NetworkInterfaceCountRequestProperty.go
- CfnEC2Fleet_OnDemandOptionsRequestProperty.go
- CfnEC2Fleet_PlacementProperty.go
- CfnEC2Fleet_SpotOptionsRequestProperty.go
- CfnEC2Fleet_TagSpecificationProperty.go
- CfnEC2Fleet_TargetCapacitySpecificationRequestProperty.go
- CfnEC2Fleet_TotalLocalStorageGBRequestProperty.go
- CfnEC2Fleet_VCpuCountRangeRequestProperty.go
- CfnEC2Fleet__checks.go
- CfnEIP.go
- CfnEIPAssociation.go
- CfnEIPAssociationProps.go
- CfnEIPAssociation__checks.go
- CfnEIPProps.go
- CfnEIP__checks.go
- CfnEgressOnlyInternetGateway.go
- CfnEgressOnlyInternetGatewayProps.go
- CfnEgressOnlyInternetGateway__checks.go
- CfnEnclaveCertificateIamRoleAssociation.go
- CfnEnclaveCertificateIamRoleAssociationProps.go
- CfnEnclaveCertificateIamRoleAssociation__checks.go
- CfnFlowLog.go
- CfnFlowLogProps.go
- CfnFlowLog_DestinationOptionsProperty.go
- CfnFlowLog__checks.go
- CfnGatewayRouteTableAssociation.go
- CfnGatewayRouteTableAssociationProps.go
- CfnGatewayRouteTableAssociation__checks.go
- CfnHost.go
- CfnHostProps.go
- CfnHost__checks.go
- CfnIPAM.go
- CfnIPAMAllocation.go
- CfnIPAMAllocationProps.go
- CfnIPAMAllocation__checks.go
- CfnIPAMPool.go
- CfnIPAMPoolCidr.go
- CfnIPAMPoolCidrProps.go
- CfnIPAMPoolCidr__checks.go
- CfnIPAMPoolProps.go
- CfnIPAMPool_ProvisionedCidrProperty.go
- CfnIPAMPool_SourceResourceProperty.go
- CfnIPAMPool__checks.go
- CfnIPAMProps.go
- CfnIPAMResourceDiscovery.go
- CfnIPAMResourceDiscoveryAssociation.go
- CfnIPAMResourceDiscoveryAssociationProps.go
- CfnIPAMResourceDiscoveryAssociation__checks.go
- CfnIPAMResourceDiscoveryProps.go
- CfnIPAMResourceDiscovery_IpamOperatingRegionProperty.go
- CfnIPAMResourceDiscovery__checks.go
- CfnIPAMScope.go
- CfnIPAMScopeProps.go
- CfnIPAMScope__checks.go
- CfnIPAM_IpamOperatingRegionProperty.go
- CfnIPAM__checks.go
- CfnInstance.go
- CfnInstanceConnectEndpoint.go
- CfnInstanceConnectEndpointProps.go
- CfnInstanceConnectEndpoint__checks.go
- CfnInstanceProps.go
- CfnInstance_AssociationParameterProperty.go
- CfnInstance_BlockDeviceMappingProperty.go
- CfnInstance_CpuOptionsProperty.go
- CfnInstance_CreditSpecificationProperty.go
- CfnInstance_EbsProperty.go
- CfnInstance_ElasticGpuSpecificationProperty.go
- CfnInstance_ElasticInferenceAcceleratorProperty.go
- CfnInstance_EnclaveOptionsProperty.go
- CfnInstance_HibernationOptionsProperty.go
- CfnInstance_InstanceIpv6AddressProperty.go
- CfnInstance_LaunchTemplateSpecificationProperty.go
- CfnInstance_LicenseSpecificationProperty.go
- CfnInstance_NetworkInterfaceProperty.go
- CfnInstance_NoDeviceProperty.go
- CfnInstance_PrivateDnsNameOptionsProperty.go
- CfnInstance_PrivateIpAddressSpecificationProperty.go
- CfnInstance_SsmAssociationProperty.go
- CfnInstance_StateProperty.go
- CfnInstance_VolumeProperty.go
- CfnInstance__checks.go
- CfnInternetGateway.go
- CfnInternetGatewayProps.go
- CfnInternetGateway__checks.go
- CfnKeyPair.go
- CfnKeyPairProps.go
- CfnKeyPair__checks.go
- CfnLaunchTemplate.go
- CfnLaunchTemplateProps.go
- CfnLaunchTemplate_AcceleratorCountProperty.go
- CfnLaunchTemplate_AcceleratorTotalMemoryMiBProperty.go
- CfnLaunchTemplate_BaselineEbsBandwidthMbpsProperty.go
- CfnLaunchTemplate_BlockDeviceMappingProperty.go
- CfnLaunchTemplate_CapacityReservationSpecificationProperty.go
- CfnLaunchTemplate_CapacityReservationTargetProperty.go
- CfnLaunchTemplate_ConnectionTrackingSpecificationProperty.go
- CfnLaunchTemplate_CpuOptionsProperty.go
- CfnLaunchTemplate_CreditSpecificationProperty.go
- CfnLaunchTemplate_EbsProperty.go
- CfnLaunchTemplate_ElasticGpuSpecificationProperty.go
- CfnLaunchTemplate_EnaSrdSpecificationProperty.go
- CfnLaunchTemplate_EnaSrdUdpSpecificationProperty.go
- CfnLaunchTemplate_EnclaveOptionsProperty.go
- CfnLaunchTemplate_HibernationOptionsProperty.go
- CfnLaunchTemplate_IamInstanceProfileProperty.go
- CfnLaunchTemplate_InstanceMarketOptionsProperty.go
- CfnLaunchTemplate_InstanceRequirementsProperty.go
- CfnLaunchTemplate_Ipv4PrefixSpecificationProperty.go
- CfnLaunchTemplate_Ipv6AddProperty.go
- CfnLaunchTemplate_Ipv6PrefixSpecificationProperty.go
- CfnLaunchTemplate_LaunchTemplateDataProperty.go
- CfnLaunchTemplate_LaunchTemplateElasticInferenceAcceleratorProperty.go
- CfnLaunchTemplate_LaunchTemplateTagSpecificationProperty.go
- CfnLaunchTemplate_LicenseSpecificationProperty.go
- CfnLaunchTemplate_MaintenanceOptionsProperty.go
- CfnLaunchTemplate_MemoryGiBPerVCpuProperty.go
- CfnLaunchTemplate_MemoryMiBProperty.go
- CfnLaunchTemplate_MetadataOptionsProperty.go
- CfnLaunchTemplate_MonitoringProperty.go
- CfnLaunchTemplate_NetworkBandwidthGbpsProperty.go
- CfnLaunchTemplate_NetworkInterfaceCountProperty.go
- CfnLaunchTemplate_NetworkInterfaceProperty.go
- CfnLaunchTemplate_PlacementProperty.go
- CfnLaunchTemplate_PrivateDnsNameOptionsProperty.go
- CfnLaunchTemplate_PrivateIpAddProperty.go
- CfnLaunchTemplate_SpotOptionsProperty.go
- CfnLaunchTemplate_TagSpecificationProperty.go
- CfnLaunchTemplate_TotalLocalStorageGBProperty.go
- CfnLaunchTemplate_VCpuCountProperty.go
- CfnLaunchTemplate__checks.go
- CfnLocalGatewayRoute.go
- CfnLocalGatewayRouteProps.go
- CfnLocalGatewayRouteTable.go
- CfnLocalGatewayRouteTableProps.go
- CfnLocalGatewayRouteTableVPCAssociation.go
- CfnLocalGatewayRouteTableVPCAssociationProps.go
- CfnLocalGatewayRouteTableVPCAssociation__checks.go
- CfnLocalGatewayRouteTableVirtualInterfaceGroupAssociation.go
- CfnLocalGatewayRouteTableVirtualInterfaceGroupAssociationProps.go
- CfnLocalGatewayRouteTableVirtualInterfaceGroupAssociation__checks.go
- CfnLocalGatewayRouteTable__checks.go
- CfnLocalGatewayRoute__checks.go
- CfnNatGateway.go
- CfnNatGatewayProps.go
- CfnNatGateway__checks.go
- CfnNetworkAcl.go
- CfnNetworkAclEntry.go
- CfnNetworkAclEntryProps.go
- CfnNetworkAclEntry_IcmpProperty.go
- CfnNetworkAclEntry_PortRangeProperty.go
- CfnNetworkAclEntry__checks.go
- CfnNetworkAclProps.go
- CfnNetworkAcl__checks.go
- CfnNetworkInsightsAccessScope.go
- CfnNetworkInsightsAccessScopeAnalysis.go
- CfnNetworkInsightsAccessScopeAnalysisProps.go
- CfnNetworkInsightsAccessScopeAnalysis__checks.go
- CfnNetworkInsightsAccessScopeProps.go
- CfnNetworkInsightsAccessScope_AccessScopePathRequestProperty.go
- CfnNetworkInsightsAccessScope_PacketHeaderStatementRequestProperty.go
- CfnNetworkInsightsAccessScope_PathStatementRequestProperty.go
- CfnNetworkInsightsAccessScope_ResourceStatementRequestProperty.go
- CfnNetworkInsightsAccessScope_ThroughResourcesStatementRequestProperty.go
- CfnNetworkInsightsAccessScope__checks.go
- CfnNetworkInsightsAnalysis.go
- CfnNetworkInsightsAnalysisProps.go
- CfnNetworkInsightsAnalysis_AdditionalDetailProperty.go
- CfnNetworkInsightsAnalysis_AlternatePathHintProperty.go
- CfnNetworkInsightsAnalysis_AnalysisAclRuleProperty.go
- CfnNetworkInsightsAnalysis_AnalysisComponentProperty.go
- CfnNetworkInsightsAnalysis_AnalysisLoadBalancerListenerProperty.go
- CfnNetworkInsightsAnalysis_AnalysisLoadBalancerTargetProperty.go
- CfnNetworkInsightsAnalysis_AnalysisPacketHeaderProperty.go
- CfnNetworkInsightsAnalysis_AnalysisRouteTableRouteProperty.go
- CfnNetworkInsightsAnalysis_AnalysisSecurityGroupRuleProperty.go
- CfnNetworkInsightsAnalysis_ExplanationProperty.go
- CfnNetworkInsightsAnalysis_PathComponentProperty.go
- CfnNetworkInsightsAnalysis_PortRangeProperty.go
- CfnNetworkInsightsAnalysis_TransitGatewayRouteTableRouteProperty.go
- CfnNetworkInsightsAnalysis__checks.go
- CfnNetworkInsightsPath.go
- CfnNetworkInsightsPathProps.go
- CfnNetworkInsightsPath_FilterPortRangeProperty.go
- CfnNetworkInsightsPath_PathFilterProperty.go
- CfnNetworkInsightsPath__checks.go
- CfnNetworkInterface.go
- CfnNetworkInterfaceAttachment.go
- CfnNetworkInterfaceAttachmentProps.go
- CfnNetworkInterfaceAttachment_EnaSrdSpecificationProperty.go
- CfnNetworkInterfaceAttachment_EnaSrdUdpSpecificationProperty.go
- CfnNetworkInterfaceAttachment__checks.go
- CfnNetworkInterfacePermission.go
- CfnNetworkInterfacePermissionProps.go
- CfnNetworkInterfacePermission__checks.go
- CfnNetworkInterfaceProps.go
- CfnNetworkInterface_ConnectionTrackingSpecificationProperty.go
- CfnNetworkInterface_InstanceIpv6AddressProperty.go
- CfnNetworkInterface_Ipv4PrefixSpecificationProperty.go
- CfnNetworkInterface_Ipv6PrefixSpecificationProperty.go
- CfnNetworkInterface_PrivateIpAddressSpecificationProperty.go
- CfnNetworkInterface__checks.go
- CfnNetworkPerformanceMetricSubscription.go
- CfnNetworkPerformanceMetricSubscriptionProps.go
- CfnNetworkPerformanceMetricSubscription__checks.go
- CfnPlacementGroup.go
- CfnPlacementGroupProps.go
- CfnPlacementGroup__checks.go
- CfnPrefixList.go
- CfnPrefixListProps.go
- CfnPrefixList_EntryProperty.go
- CfnPrefixList__checks.go
- CfnRoute.go
- CfnRouteProps.go
- CfnRouteTable.go
- CfnRouteTableProps.go
- CfnRouteTable__checks.go
- CfnRoute__checks.go
- CfnSecurityGroup.go
- CfnSecurityGroupEgress.go
- CfnSecurityGroupEgressProps.go
- CfnSecurityGroupEgress__checks.go
- CfnSecurityGroupIngress.go
- CfnSecurityGroupIngressProps.go
- CfnSecurityGroupIngress__checks.go
- CfnSecurityGroupProps.go
- CfnSecurityGroup_EgressProperty.go
- CfnSecurityGroup_IngressProperty.go
- CfnSecurityGroup__checks.go
- CfnSnapshotBlockPublicAccess.go
- CfnSnapshotBlockPublicAccessProps.go
- CfnSnapshotBlockPublicAccess__checks.go
- CfnSpotFleet.go
- CfnSpotFleetProps.go
- CfnSpotFleet_AcceleratorCountRequestProperty.go
- CfnSpotFleet_AcceleratorTotalMemoryMiBRequestProperty.go
- CfnSpotFleet_BaselineEbsBandwidthMbpsRequestProperty.go
- CfnSpotFleet_BlockDeviceMappingProperty.go
- CfnSpotFleet_ClassicLoadBalancerProperty.go
- CfnSpotFleet_ClassicLoadBalancersConfigProperty.go
- CfnSpotFleet_EbsBlockDeviceProperty.go
- CfnSpotFleet_FleetLaunchTemplateSpecificationProperty.go
- CfnSpotFleet_GroupIdentifierProperty.go
- CfnSpotFleet_IamInstanceProfileSpecificationProperty.go
- CfnSpotFleet_InstanceIpv6AddressProperty.go
- CfnSpotFleet_InstanceNetworkInterfaceSpecificationProperty.go
- CfnSpotFleet_InstanceRequirementsRequestProperty.go
- CfnSpotFleet_LaunchTemplateConfigProperty.go
- CfnSpotFleet_LaunchTemplateOverridesProperty.go
- CfnSpotFleet_LoadBalancersConfigProperty.go
- CfnSpotFleet_MemoryGiBPerVCpuRequestProperty.go
- CfnSpotFleet_MemoryMiBRequestProperty.go
- CfnSpotFleet_NetworkBandwidthGbpsRequestProperty.go
- CfnSpotFleet_NetworkInterfaceCountRequestProperty.go
- CfnSpotFleet_PrivateIpAddressSpecificationProperty.go
- CfnSpotFleet_SpotCapacityRebalanceProperty.go
- CfnSpotFleet_SpotFleetLaunchSpecificationProperty.go
- CfnSpotFleet_SpotFleetMonitoringProperty.go
- CfnSpotFleet_SpotFleetRequestConfigDataProperty.go
- CfnSpotFleet_SpotFleetTagSpecificationProperty.go
- CfnSpotFleet_SpotMaintenanceStrategiesProperty.go
- CfnSpotFleet_SpotPlacementProperty.go
- CfnSpotFleet_TargetGroupProperty.go
- CfnSpotFleet_TargetGroupsConfigProperty.go
- CfnSpotFleet_TotalLocalStorageGBRequestProperty.go
- CfnSpotFleet_VCpuCountRangeRequestProperty.go
- CfnSpotFleet__checks.go
- CfnSubnet.go
- CfnSubnetCidrBlock.go
- CfnSubnetCidrBlockProps.go
- CfnSubnetCidrBlock__checks.go
- CfnSubnetNetworkAclAssociation.go
- CfnSubnetNetworkAclAssociationProps.go
- CfnSubnetNetworkAclAssociation__checks.go
- CfnSubnetProps.go
- CfnSubnetRouteTableAssociation.go
- CfnSubnetRouteTableAssociationProps.go
- CfnSubnetRouteTableAssociation__checks.go
- CfnSubnet_PrivateDnsNameOptionsOnLaunchProperty.go
- CfnSubnet__checks.go
- CfnTrafficMirrorFilter.go
- CfnTrafficMirrorFilterProps.go
- CfnTrafficMirrorFilterRule.go
- CfnTrafficMirrorFilterRuleProps.go
- CfnTrafficMirrorFilterRule_TrafficMirrorPortRangeProperty.go
- CfnTrafficMirrorFilterRule__checks.go
- CfnTrafficMirrorFilter__checks.go
- CfnTrafficMirrorSession.go
- CfnTrafficMirrorSessionProps.go
- CfnTrafficMirrorSession__checks.go
- CfnTrafficMirrorTarget.go
- CfnTrafficMirrorTargetProps.go
- CfnTrafficMirrorTarget__checks.go
- CfnTransitGateway.go
- CfnTransitGatewayAttachment.go
- CfnTransitGatewayAttachmentProps.go
- CfnTransitGatewayAttachment_OptionsProperty.go
- CfnTransitGatewayAttachment__checks.go
- CfnTransitGatewayConnect.go
- CfnTransitGatewayConnectProps.go
- CfnTransitGatewayConnect_TransitGatewayConnectOptionsProperty.go
- CfnTransitGatewayConnect__checks.go
- CfnTransitGatewayMulticastDomain.go
- CfnTransitGatewayMulticastDomainAssociation.go
- CfnTransitGatewayMulticastDomainAssociationProps.go
- CfnTransitGatewayMulticastDomainAssociation__checks.go
- CfnTransitGatewayMulticastDomainProps.go
- CfnTransitGatewayMulticastDomain_OptionsProperty.go
- CfnTransitGatewayMulticastDomain__checks.go
- CfnTransitGatewayMulticastGroupMember.go
- CfnTransitGatewayMulticastGroupMemberProps.go
- CfnTransitGatewayMulticastGroupMember__checks.go
- CfnTransitGatewayMulticastGroupSource.go
- CfnTransitGatewayMulticastGroupSourceProps.go
- CfnTransitGatewayMulticastGroupSource__checks.go
- CfnTransitGatewayPeeringAttachment.go
- CfnTransitGatewayPeeringAttachmentProps.go
- CfnTransitGatewayPeeringAttachment_PeeringAttachmentStatusProperty.go
- CfnTransitGatewayPeeringAttachment__checks.go
- CfnTransitGatewayProps.go
- CfnTransitGatewayRoute.go
- CfnTransitGatewayRouteProps.go
- CfnTransitGatewayRouteTable.go
- CfnTransitGatewayRouteTableAssociation.go
- CfnTransitGatewayRouteTableAssociationProps.go
- CfnTransitGatewayRouteTableAssociation__checks.go
- CfnTransitGatewayRouteTablePropagation.go
- CfnTransitGatewayRouteTablePropagationProps.go
- CfnTransitGatewayRouteTablePropagation__checks.go
- CfnTransitGatewayRouteTableProps.go
- CfnTransitGatewayRouteTable__checks.go
- CfnTransitGatewayRoute__checks.go
- CfnTransitGatewayVpcAttachment.go
- CfnTransitGatewayVpcAttachmentProps.go
- CfnTransitGatewayVpcAttachment_OptionsProperty.go
- CfnTransitGatewayVpcAttachment__checks.go
- CfnTransitGateway__checks.go
- CfnVPC.go
- CfnVPCCidrBlock.go
- CfnVPCCidrBlockProps.go
- CfnVPCCidrBlock__checks.go
- CfnVPCDHCPOptionsAssociation.go
- CfnVPCDHCPOptionsAssociationProps.go
- CfnVPCDHCPOptionsAssociation__checks.go
- CfnVPCEndpoint.go
- CfnVPCEndpointConnectionNotification.go
- CfnVPCEndpointConnectionNotificationProps.go
- CfnVPCEndpointConnectionNotification__checks.go
- CfnVPCEndpointProps.go
- CfnVPCEndpointService.go
- CfnVPCEndpointServicePermissions.go
- CfnVPCEndpointServicePermissionsProps.go
- CfnVPCEndpointServicePermissions__checks.go
- CfnVPCEndpointServiceProps.go
- CfnVPCEndpointService__checks.go
- CfnVPCEndpoint__checks.go
- CfnVPCGatewayAttachment.go
- CfnVPCGatewayAttachmentProps.go
- CfnVPCGatewayAttachment__checks.go
- CfnVPCPeeringConnection.go
- CfnVPCPeeringConnectionProps.go
- CfnVPCPeeringConnection__checks.go
- CfnVPCProps.go
- CfnVPC__checks.go
- CfnVPNConnection.go
- CfnVPNConnectionProps.go
- CfnVPNConnectionRoute.go
- CfnVPNConnectionRouteProps.go
- CfnVPNConnectionRoute__checks.go
- CfnVPNConnection_VpnTunnelOptionsSpecificationProperty.go
- CfnVPNConnection__checks.go
- CfnVPNGateway.go
- CfnVPNGatewayProps.go
- CfnVPNGatewayRoutePropagation.go
- CfnVPNGatewayRoutePropagationProps.go
- CfnVPNGatewayRoutePropagation__checks.go
- CfnVPNGateway__checks.go
- CfnVerifiedAccessEndpoint.go
- CfnVerifiedAccessEndpointProps.go
- CfnVerifiedAccessEndpoint_LoadBalancerOptionsProperty.go
- CfnVerifiedAccessEndpoint_NetworkInterfaceOptionsProperty.go
- CfnVerifiedAccessEndpoint_SseSpecificationProperty.go
- CfnVerifiedAccessEndpoint__checks.go
- CfnVerifiedAccessGroup.go
- CfnVerifiedAccessGroupProps.go
- CfnVerifiedAccessGroup_SseSpecificationProperty.go
- CfnVerifiedAccessGroup__checks.go
- CfnVerifiedAccessInstance.go
- CfnVerifiedAccessInstanceProps.go
- CfnVerifiedAccessInstance_CloudWatchLogsProperty.go
- CfnVerifiedAccessInstance_KinesisDataFirehoseProperty.go
- CfnVerifiedAccessInstance_S3Property.go
- CfnVerifiedAccessInstance_VerifiedAccessLogsProperty.go
- CfnVerifiedAccessInstance_VerifiedAccessTrustProviderProperty.go
- CfnVerifiedAccessInstance__checks.go
- CfnVerifiedAccessTrustProvider.go
- CfnVerifiedAccessTrustProviderProps.go
- CfnVerifiedAccessTrustProvider_DeviceOptionsProperty.go
- CfnVerifiedAccessTrustProvider_OidcOptionsProperty.go
- CfnVerifiedAccessTrustProvider_SseSpecificationProperty.go
- CfnVerifiedAccessTrustProvider__checks.go
- CfnVolume.go
- CfnVolumeAttachment.go
- CfnVolumeAttachmentProps.go
- CfnVolumeAttachment__checks.go
- CfnVolumeProps.go
- CfnVolume__checks.go
- ClientVpnAuthorizationRule.go
- ClientVpnAuthorizationRuleOptions.go
- ClientVpnAuthorizationRuleProps.go
- ClientVpnAuthorizationRule__checks.go
- ClientVpnEndpoint.go
- ClientVpnEndpointAttributes.go
- ClientVpnEndpointOptions.go
- ClientVpnEndpointProps.go
- ClientVpnEndpoint__checks.go
- ClientVpnRoute.go
- ClientVpnRouteOptions.go
- ClientVpnRouteProps.go
- ClientVpnRouteTarget.go
- ClientVpnRouteTarget__checks.go
- ClientVpnRoute__checks.go
- ClientVpnSessionTimeout.go
- ClientVpnUserBasedAuthentication.go
- ClientVpnUserBasedAuthentication__checks.go
- CloudFormationInit.go
- CloudFormationInit__checks.go
- CommonNetworkAclEntryOptions.go
- ConfigSetProps.go
- ConfigureNatOptions.go
- ConnectionRule.go
- Connections.go
- ConnectionsProps.go
- Connections__checks.go
- CpuCredits.go
- CreateIpv6CidrBlocksRequest.go
- DefaultInstanceTenancy.go
- DestinationOptions.go
- EbsDeviceOptions.go
- EbsDeviceOptionsBase.go
- EbsDeviceProps.go
- EbsDeviceSnapshotOptions.go
- EbsDeviceVolumeType.go
- EnableVpnGatewayOptions.go
- ExecuteFileOptions.go
- FlowLog.go
- FlowLogDestination.go
- FlowLogDestinationConfig.go
- FlowLogDestinationType.go
- FlowLogDestination__checks.go
- FlowLogFileFormat.go
- FlowLogMaxAggregationInterval.go
- FlowLogOptions.go
- FlowLogProps.go
- FlowLogResourceType.go
- FlowLogResourceType__checks.go
- FlowLogTrafficType.go
- FlowLog__checks.go
- GatewayConfig.go
- GatewayVpcEndpoint.go
- GatewayVpcEndpointAwsService.go
- GatewayVpcEndpointAwsService__checks.go
- GatewayVpcEndpointOptions.go
- GatewayVpcEndpointProps.go
- GatewayVpcEndpoint__checks.go
- GenericLinuxImage.go
- GenericLinuxImageProps.go
- GenericLinuxImage__checks.go
- GenericSSMParameterImage.go
- GenericSSMParameterImage__checks.go
- GenericWindowsImage.go
- GenericWindowsImageProps.go
- GenericWindowsImage__checks.go
- IClientVpnConnectionHandler.go
- IClientVpnEndpoint.go
- IClientVpnEndpoint__checks.go
- IConnectable.go
- IFlowLog.go
- IGatewayVpcEndpoint.go
- IGatewayVpcEndpointService.go
- IInstance.go
- IInstance__checks.go
- IInterfaceVpcEndpoint.go
- IInterfaceVpcEndpointService.go
- IInterfaceVpcEndpoint__checks.go
- IIpAddresses.go
- IIpAddresses__checks.go
- IIpv6Addresses.go
- IIpv6Addresses__checks.go
- IKeyPair.go
- ILaunchTemplate.go
- IMachineImage.go
- IMachineImage__checks.go
- INetworkAcl.go
- INetworkAclEntry.go
- INetworkAcl__checks.go
- IPeer.go
- IPlacementGroup.go
- IPrefixList.go
- IPrivateSubnet.go
- IPublicSubnet.go
- IRouteTable.go
- ISecurityGroup.go
- ISecurityGroup__checks.go
- ISubnet.go
- ISubnetNetworkAclAssociation.go
- ISubnet__checks.go
- IVolume.go
- IVolume__checks.go
- IVpc.go
- IVpcEndpoint.go
- IVpcEndpointService.go
- IVpcEndpointServiceLoadBalancer.go
- IVpc__checks.go
- IVpnConnection.go
- IVpnConnection__checks.go
- IVpnGateway.go
- InitCommand.go
- InitCommandOptions.go
- InitCommandWaitDuration.go
- InitCommandWaitDuration__checks.go
- InitCommand__checks.go
- InitConfig.go
- InitConfig__checks.go
- InitElement.go
- InitFile.go
- InitFileAssetOptions.go
- InitFileOptions.go
- InitFile__checks.go
- InitGroup.go
- InitGroup__checks.go
- InitPackage.go
- InitPackage__checks.go
- InitService.go
- InitServiceOptions.go
- InitServiceRestartHandle.go
- InitService__checks.go
- InitSource.go
- InitSourceAssetOptions.go
- InitSourceOptions.go
- InitSource__checks.go
- InitUser.go
- InitUserOptions.go
- InitUser__checks.go
- Instance.go
- InstanceArchitecture.go
- InstanceClass.go
- InstanceInitiatedShutdownBehavior.go
- InstanceProps.go
- InstanceRequireImdsv2Aspect.go
- InstanceRequireImdsv2AspectProps.go
- InstanceRequireImdsv2Aspect__checks.go
- InstanceSize.go
- InstanceType.go
- InstanceType__checks.go
- Instance__checks.go
- InterfaceVpcEndpoint.go
- InterfaceVpcEndpointAttributes.go
- InterfaceVpcEndpointAwsService.go
- InterfaceVpcEndpointAwsServiceProps.go
- InterfaceVpcEndpointAwsService__checks.go
- InterfaceVpcEndpointOptions.go
- InterfaceVpcEndpointProps.go
- InterfaceVpcEndpointService.go
- InterfaceVpcEndpointService__checks.go
- InterfaceVpcEndpoint__checks.go
- IpAddresses.go
- IpAddresses__checks.go
- IpProtocol.go
- Ipv6Addresses.go
- KeyPair.go
- KeyPairAttributes.go
- KeyPairFormat.go
- KeyPairProps.go
- KeyPairType.go
- KeyPair__checks.go
- LaunchTemplate.go
- LaunchTemplateAttributes.go
- LaunchTemplateHttpTokens.go
- LaunchTemplateProps.go
- LaunchTemplateRequireImdsv2Aspect.go
- LaunchTemplateRequireImdsv2AspectProps.go
- LaunchTemplateRequireImdsv2Aspect__checks.go
- LaunchTemplateSpecialVersions.go
- LaunchTemplateSpotOptions.go
- LaunchTemplate__checks.go
- LinuxUserDataOptions.go
- LocationPackageOptions.go
- LogFormat.go
- LogFormat__checks.go
- LookupMachineImage.go
- LookupMachineImageProps.go
- LookupMachineImage__checks.go
- MachineImage.go
- MachineImageConfig.go
- MachineImage__checks.go
- MultipartBody.go
- MultipartBodyOptions.go
- MultipartBody__checks.go
- MultipartUserData.go
- MultipartUserDataOptions.go
- MultipartUserData__checks.go
- NamedPackageOptions.go
- NatGatewayProps.go
- NatGatewayProvider.go
- NatGatewayProvider__checks.go
- NatInstanceImage.go
- NatInstanceImage__checks.go
- NatInstanceProps.go
- NatInstanceProvider.go
- NatInstanceProviderV2.go
- NatInstanceProviderV2__checks.go
- NatInstanceProvider__checks.go
- NatProvider.go
- NatProvider__checks.go
- NatTrafficDirection.go
- NetworkAcl.go
- NetworkAclEntry.go
- NetworkAclEntryProps.go
- NetworkAclEntry__checks.go
- NetworkAclProps.go
- NetworkAcl__checks.go
- OperatingSystemType.go
- Peer.go
- Peer__checks.go
- PlacementGroup.go
- PlacementGroupProps.go
- PlacementGroupSpreadLevel.go
- PlacementGroupStrategy.go
- PlacementGroup__checks.go
- Port.go
- PortProps.go
- Port__checks.go
- PrefixList.go
- PrefixListOptions.go
- PrefixListProps.go
- PrefixList__checks.go
- PrivateSubnet.go
- PrivateSubnetAttributes.go
- PrivateSubnetProps.go
- PrivateSubnet__checks.go
- Protocol.go
- PublicSubnet.go
- PublicSubnetAttributes.go
- PublicSubnetProps.go
- PublicSubnet__checks.go
- RequestedSubnet.go
- ResolveSsmParameterAtLaunchImage.go
- ResolveSsmParameterAtLaunchImage__checks.go
- RouterType.go
- RuleScope.go
- S3DestinationOptions.go
- S3DownloadOptions.go
- SecurityGroup.go
- SecurityGroupImportOptions.go
- SecurityGroupProps.go
- SecurityGroup__checks.go
- SelectedSubnets.go
- ServiceManager.go
- SpotInstanceInterruption.go
- SpotRequestType.go
- SsmParameterImageOptions.go
- Subnet.go
- SubnetAttributes.go
- SubnetConfiguration.go
- SubnetFilter.go
- SubnetFilter__checks.go
- SubnetIpamOptions.go
- SubnetNetworkAclAssociation.go
- SubnetNetworkAclAssociationProps.go
- SubnetNetworkAclAssociation__checks.go
- SubnetProps.go
- SubnetSelection.go
- SubnetType.go
- Subnet__checks.go
- SystemdConfigFileOptions.go
- TrafficDirection.go
- TransportProtocol.go
- UserData.go
- UserData__checks.go
- Volume.go
- VolumeAttributes.go
- VolumeProps.go
- Volume__checks.go
- Vpc.go
- VpcAttributes.go
- VpcEndpoint.go
- VpcEndpointService.go
- VpcEndpointServiceProps.go
- VpcEndpointService__checks.go
- VpcEndpointType.go
- VpcEndpoint__checks.go
- VpcIpamOptions.go
- VpcLookupOptions.go
- VpcProps.go
- Vpc__checks.go
- VpnConnection.go
- VpnConnectionAttributes.go
- VpnConnectionBase.go
- VpnConnectionBase__checks.go
- VpnConnectionOptions.go
- VpnConnectionProps.go
- VpnConnectionType.go
- VpnConnection__checks.go
- VpnGateway.go
- VpnGatewayProps.go
- VpnGateway__checks.go
- VpnPort.go
- VpnTunnelOption.go
- WindowsImage.go
- WindowsImageProps.go
- WindowsImage__checks.go
- WindowsUserDataOptions.go
- WindowsVersion.go
- main.go
Directories
Click to show internal directories.
Click to hide internal directories.