< Back
Add-CfnEC2_NetworkInterfaceResource
Post
NAME Add-CfnEC2_NetworkInterfaceResource
SYNOPSIS
Describes a network interface in an Elastic Compute Cloud (EC2) instance for AWS CloudFormation.
SYNTAX
Add-CfnEC2_NetworkInterfaceResource [-ResourceName] <String> [-Description <String>] [-GroupSet <String[]>]
[-PrivateIpAddress <String>] [-PrivateIpAddresses <IDictionary[]>] [-SecondaryPrivateIpAddressCount <Int32>]
[-SourceDestCheck <Boolean>] [-SubnetId <String>] [-Tags <IDictionary>] [-DeletionPolicy <String>] [-Metadata
<Hashtable>] [-DependsOn <Array>] [[-PropertiesBlock] <ScriptBlock>] [-Condition <Object>] [<CommonParameters>]
DESCRIPTION
PARAMETERS
-ResourceName <String>
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Description <String>
The description of this network interface.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-GroupSet <String[]>
A list of security group IDs associated with this network interface.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PrivateIpAddress <String>
IP address of the interface within the subnet.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PrivateIpAddresses <IDictionary[]>
Assigns a list of private IP addresses 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 Amazon EC2 to automatically assign private IP addresses, use the SecondaryPrivateIpAddressCount property
and do not specify this property.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SecondaryPrivateIpAddressCount <Int32>
The number of secondary private IP addresses that Amazon EC2 automatically assigns to the network interface.
Amazon EC2 uses the value of the PrivateIpAddress property as the primary private IP address. If you don't
specify that property, Amazon EC2 automatically assigns both the primary and secondary private IP addresses.
Required? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-SourceDestCheck <Boolean>
Flag indicating whether traffic to or from the instance is validated.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-SubnetId <String>
The ID of the subnet to associate with the network interface.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Tags <IDictionary>
The tags that you want to attach.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DeletionPolicy <String>
With the DeletionPolicy attribute you can preserve or (in some cases) backup a resource when its stack is
deleted. You specify a DeletionPolicy attribute for each resource that you want to control. If a resource has
no DeletionPolicy attribute, AWS CloudFormation deletes the resource by default.
To keep a resource when its stack is deleted, specify Retain for that resource. You can use retain for any
resource. For example, you can retain a nested stack, S3 bucket, or EC2 instance so that you can continue to
use or modify those resources after you delete their stacks.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Metadata <Hashtable>
The Metadata attribute enables you to associate structured data with a resource. By adding a Metadata
attribute to a resource, you can add data in JSON format to the resource declaration. In addition, you can use
intrinsic functions (such as GetAtt and Ref), parameters, and pseudo parameters within the Metadata attribute
to add those interpreted values.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DependsOn <Array>
With the DependsOn attribute you can specify that the creation of a specific resource follows another. When
you add a DependsOn attribute to a resource, that resource is created only after the creation of the resource
specified in the DependsOn attribute. You can use the DependsOn attribute with any resource.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PropertiesBlock <ScriptBlock>
Allows you to declare a block of one or more Property statements.
A Properties block allows you to side-step the rigid, type-enforced literal properties of a typed resource,
and specify Property assignments that may include CloudFormation function calls or references, or computed
values.
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Condition <Object>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
RELATED LINKS
http://docs.aws.amazon.com/AWSCloudForm ... olicy.html
http://docs.aws.amazon.com/AWSCloudForm ... adata.html
http://docs.aws.amazon.com/AWSCloudForm ... ndson.html
http://docs.aws.amazon.com/AWSCloudForm ... e-ref.html
http://docs.aws.amazon.com/search/doc-s ... kInterface
SYNOPSIS
Describes a network interface in an Elastic Compute Cloud (EC2) instance for AWS CloudFormation.
SYNTAX
Add-CfnEC2_NetworkInterfaceResource [-ResourceName] <String> [-Description <String>] [-GroupSet <String[]>]
[-PrivateIpAddress <String>] [-PrivateIpAddresses <IDictionary[]>] [-SecondaryPrivateIpAddressCount <Int32>]
[-SourceDestCheck <Boolean>] [-SubnetId <String>] [-Tags <IDictionary>] [-DeletionPolicy <String>] [-Metadata
<Hashtable>] [-DependsOn <Array>] [[-PropertiesBlock] <ScriptBlock>] [-Condition <Object>] [<CommonParameters>]
DESCRIPTION
PARAMETERS
-ResourceName <String>
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Description <String>
The description of this network interface.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-GroupSet <String[]>
A list of security group IDs associated with this network interface.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PrivateIpAddress <String>
IP address of the interface within the subnet.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PrivateIpAddresses <IDictionary[]>
Assigns a list of private IP addresses 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 Amazon EC2 to automatically assign private IP addresses, use the SecondaryPrivateIpAddressCount property
and do not specify this property.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SecondaryPrivateIpAddressCount <Int32>
The number of secondary private IP addresses that Amazon EC2 automatically assigns to the network interface.
Amazon EC2 uses the value of the PrivateIpAddress property as the primary private IP address. If you don't
specify that property, Amazon EC2 automatically assigns both the primary and secondary private IP addresses.
Required? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-SourceDestCheck <Boolean>
Flag indicating whether traffic to or from the instance is validated.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-SubnetId <String>
The ID of the subnet to associate with the network interface.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Tags <IDictionary>
The tags that you want to attach.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DeletionPolicy <String>
With the DeletionPolicy attribute you can preserve or (in some cases) backup a resource when its stack is
deleted. You specify a DeletionPolicy attribute for each resource that you want to control. If a resource has
no DeletionPolicy attribute, AWS CloudFormation deletes the resource by default.
To keep a resource when its stack is deleted, specify Retain for that resource. You can use retain for any
resource. For example, you can retain a nested stack, S3 bucket, or EC2 instance so that you can continue to
use or modify those resources after you delete their stacks.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Metadata <Hashtable>
The Metadata attribute enables you to associate structured data with a resource. By adding a Metadata
attribute to a resource, you can add data in JSON format to the resource declaration. In addition, you can use
intrinsic functions (such as GetAtt and Ref), parameters, and pseudo parameters within the Metadata attribute
to add those interpreted values.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DependsOn <Array>
With the DependsOn attribute you can specify that the creation of a specific resource follows another. When
you add a DependsOn attribute to a resource, that resource is created only after the creation of the resource
specified in the DependsOn attribute. You can use the DependsOn attribute with any resource.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PropertiesBlock <ScriptBlock>
Allows you to declare a block of one or more Property statements.
A Properties block allows you to side-step the rigid, type-enforced literal properties of a typed resource,
and specify Property assignments that may include CloudFormation function calls or references, or computed
values.
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Condition <Object>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
RELATED LINKS
http://docs.aws.amazon.com/AWSCloudForm ... olicy.html
http://docs.aws.amazon.com/AWSCloudForm ... adata.html
http://docs.aws.amazon.com/AWSCloudForm ... ndson.html
http://docs.aws.amazon.com/AWSCloudForm ... e-ref.html
http://docs.aws.amazon.com/search/doc-s ... kInterface