CfnMountTargetProps
- class aws_cdk.aws_efs.CfnMountTargetProps(*, file_system_id, security_groups, subnet_id, ip_address=None, ip_address_type=None, ipv6_address=None)
Bases:
object
Properties for defining a
CfnMountTarget
.- Parameters:
file_system_id (
str
) – The ID of the file system for which to create the mount target.security_groups (
Sequence
[str
]) – VPC security group IDs, of the formsg-xxxxxxxx
. These must be for the same VPC as the subnet specified. The maximum number of security groups depends on account quota. For more information, see Amazon VPC Quotas in the Amazon VPC User Guide (see the Security Groups table). If you don’t specify a security group, then Amazon EFS uses the default security group for the subnet’s VPC.subnet_id (
str
) – The ID of the subnet to add the mount target in. For One Zone file systems, use the subnet that is associated with the file system’s Availability Zone. The subnet type must be the same type as theIpAddressType
.ip_address (
Optional
[str
]) – If theIpAddressType
for the mount target is IPv4 (IPV4_ONLY
orDUAL_STACK
), then specify the IPv4 address to use. If you do not specify anIpAddress
, then Amazon EFS selects an unused IP address from the subnet specified forSubnetId
.ip_address_type (
Optional
[str
]) – The IP address type for the mount target. The possible values areIPV4_ONLY
(only IPv4 addresses),IPV6_ONLY
(only IPv6 addresses), andDUAL_STACK
(dual-stack, both IPv4 and IPv6 addresses). If you don’t specify anIpAddressType
, thenIPV4_ONLY
is used. .. epigraph:: TheIPAddressType
must match the IP type of the subnet. Additionally, theIPAddressType
parameter overrides the value set as the default IP address for the subnet in the VPC. For example, if theIPAddressType
isIPV4_ONLY
andAssignIpv6AddressOnCreation
istrue
, then IPv4 is used for the mount target. For more information, see Modify the IP addressing attributes of your subnet .ipv6_address (
Optional
[str
]) – If theIPAddressType
for the mount target is IPv6 (IPV6_ONLY
orDUAL_STACK
), then specify the IPv6 address to use. If you do not specify anIpv6Address
, then Amazon EFS selects an unused IP address from the subnet specified forSubnetId
.
- See:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_efs as efs cfn_mount_target_props = efs.CfnMountTargetProps( file_system_id="fileSystemId", security_groups=["securityGroups"], subnet_id="subnetId", # the properties below are optional ip_address="ipAddress", ip_address_type="ipAddressType", ipv6_address="ipv6Address" )
Attributes
- file_system_id
The ID of the file system for which to create the mount target.
- ip_address
If the
IpAddressType
for the mount target is IPv4 (IPV4_ONLY
orDUAL_STACK
), then specify the IPv4 address to use.If you do not specify an
IpAddress
, then Amazon EFS selects an unused IP address from the subnet specified forSubnetId
.
- ip_address_type
The IP address type for the mount target.
The possible values are
IPV4_ONLY
(only IPv4 addresses),IPV6_ONLY
(only IPv6 addresses), andDUAL_STACK
(dual-stack, both IPv4 and IPv6 addresses). If you don’t specify anIpAddressType
, thenIPV4_ONLY
is used. .. epigraph:The ``IPAddressType`` must match the IP type of the subnet. Additionally, the ``IPAddressType`` parameter overrides the value set as the default IP address for the subnet in the VPC. For example, if the ``IPAddressType`` is ``IPV4_ONLY`` and ``AssignIpv6AddressOnCreation`` is ``true`` , then IPv4 is used for the mount target. For more information, see `Modify the IP addressing attributes of your subnet <https://docs.aws.amazon.com/vpc/latest/userguide/subnet-public-ip.html>`_ .
- ipv6_address
If the
IPAddressType
for the mount target is IPv6 (IPV6_ONLY
orDUAL_STACK
), then specify the IPv6 address to use.If you do not specify an
Ipv6Address
, then Amazon EFS selects an unused IP address from the subnet specified forSubnetId
.
- security_groups
VPC security group IDs, of the form
sg-xxxxxxxx
.These must be for the same VPC as the subnet specified. The maximum number of security groups depends on account quota. For more information, see Amazon VPC Quotas in the Amazon VPC User Guide (see the Security Groups table). If you don’t specify a security group, then Amazon EFS uses the default security group for the subnet’s VPC.
- subnet_id
The ID of the subnet to add the mount target in.
For One Zone file systems, use the subnet that is associated with the file system’s Availability Zone. The subnet type must be the same type as the
IpAddressType
.