Show / Hide Table of Contents

Class CfnMountTargetProps

Properties for defining a CfnMountTarget.

Inheritance
object
CfnMountTargetProps
Implements
ICfnMountTargetProps
Inherited Members
object.GetType()
object.MemberwiseClone()
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
Namespace: Amazon.CDK.AWS.EFS
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnMountTargetProps : ICfnMountTargetProps
Syntax (vb)
Public Class CfnMountTargetProps Implements ICfnMountTargetProps
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.EFS;

             var cfnMountTargetProps = new CfnMountTargetProps {
                 FileSystemId = "fileSystemId",
                 SecurityGroups = new [] { "securityGroups" },
                 SubnetId = "subnetId",

                 // the properties below are optional
                 IpAddress = "ipAddress",
                 IpAddressType = "ipAddressType",
                 Ipv6Address = "ipv6Address"
             };

Synopsis

Constructors

CfnMountTargetProps()

Properties for defining a CfnMountTarget.

Properties

FileSystemId

The ID of the file system for which to create the mount target.

IpAddress

If the IpAddressType for the mount target is IPv4 ( IPV4_ONLY or DUAL_STACK ), then specify the IPv4 address to use.

IpAddressType

The IP address type for the mount target.

Ipv6Address

If the IPAddressType for the mount target is IPv6 ( IPV6_ONLY or DUAL_STACK ), then specify the IPv6 address to use.

SecurityGroups

VPC security group IDs, of the form sg-xxxxxxxx .

SubnetId

The ID of the subnet to add the mount target in.

Constructors

CfnMountTargetProps()

Properties for defining a CfnMountTarget.

public CfnMountTargetProps()
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.EFS;

             var cfnMountTargetProps = new CfnMountTargetProps {
                 FileSystemId = "fileSystemId",
                 SecurityGroups = new [] { "securityGroups" },
                 SubnetId = "subnetId",

                 // the properties below are optional
                 IpAddress = "ipAddress",
                 IpAddressType = "ipAddressType",
                 Ipv6Address = "ipv6Address"
             };

Properties

FileSystemId

The ID of the file system for which to create the mount target.

public object FileSystemId { get; set; }
Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html#cfn-efs-mounttarget-filesystemid

Type union: either string or IFileSystemRef

IpAddress

If the IpAddressType for the mount target is IPv4 ( IPV4_ONLY or DUAL_STACK ), then specify the IPv4 address to use.

public string? IpAddress { get; set; }
Property Value

string

Remarks

If you do not specify an IpAddress , then Amazon EFS selects an unused IP address from the subnet specified for SubnetId .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html#cfn-efs-mounttarget-ipaddress

IpAddressType

The IP address type for the mount target.

public string? IpAddressType { get; set; }
Property Value

string

Remarks

The possible values are IPV4_ONLY (only IPv4 addresses), IPV6_ONLY (only IPv6 addresses), and DUAL_STACK (dual-stack, both IPv4 and IPv6 addresses). If you don’t specify an IpAddressType , then IPV4_ONLY is used.

The <code>IPAddressType</code> must match the IP type of the subnet. Additionally, the <code>IPAddressType</code> parameter overrides the value set as the default IP address for the subnet in the VPC. For example, if the <code>IPAddressType</code> is <code>IPV4_ONLY</code> and <code>AssignIpv6AddressOnCreation</code> is <code>true</code> , then IPv4 is used for the mount target. For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/subnet-public-ip.html">Modify the IP addressing attributes of your subnet</a> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html#cfn-efs-mounttarget-ipaddresstype

Ipv6Address

If the IPAddressType for the mount target is IPv6 ( IPV6_ONLY or DUAL_STACK ), then specify the IPv6 address to use.

public string? Ipv6Address { get; set; }
Property Value

string

Remarks

If you do not specify an Ipv6Address , then Amazon EFS selects an unused IP address from the subnet specified for SubnetId .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html#cfn-efs-mounttarget-ipv6address

SecurityGroups

VPC security group IDs, of the form sg-xxxxxxxx .

public object[] SecurityGroups { get; set; }
Property Value

object[]

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html#cfn-efs-mounttarget-securitygroups

Type union: (either string or ISecurityGroupRef)[]

SubnetId

The ID of the subnet to add the mount target in.

public object SubnetId { get; set; }
Property Value

object

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html#cfn-efs-mounttarget-subnetid

Type union: either string or ISubnetRef

Implements

ICfnMountTargetProps
Back to top Generated by DocFX