Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The ec2Vpcs resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.AwsConnector/ec2Vpcs resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.AwsConnector/ec2Vpcs@2024-12-01' = {
location: 'string'
name: 'string'
properties: {
arn: 'string'
awsAccountId: 'string'
awsProperties: {
cidrBlock: 'string'
cidrBlockAssociations: [
'string'
]
defaultNetworkAcl: 'string'
defaultSecurityGroup: 'string'
enableDnsHostnames: bool
enableDnsSupport: bool
instanceTenancy: 'string'
ipv4IpamPoolId: 'string'
ipv4NetmaskLength: int
ipv6CidrBlocks: [
'string'
]
tags: [
{
key: 'string'
value: 'string'
}
]
vpcId: 'string'
}
awsRegion: 'string'
awsSourceSchema: 'string'
awsTags: {
{customized property}: 'string'
}
publicCloudConnectorsResourceId: 'string'
publicCloudResourceName: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.AwsConnector/ec2Vpcs
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^(?=.{0,259}[^\s.]$)(?!.*[<>%&\?/#]) (required) |
| properties | The resource-specific properties for this resource. | Ec2VpcProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
AwsEc2VpcProperties
| Name | Description | Value |
|---|---|---|
| cidrBlock | 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 eitherCidrBlock or Ipv4IpamPoolId. |
string |
| cidrBlockAssociations | Property cidrBlockAssociations | string[] |
| defaultNetworkAcl | Property defaultNetworkAcl | string |
| defaultSecurityGroup | Property defaultSecurityGroup | string |
| enableDnsHostnames | 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. You can only enable DNS hostnames if you've enabled DNS support. | bool |
| enableDnsSupport | 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. | bool |
| instanceTenancy | 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. |
string |
| ipv4IpamPoolId | The ID of an IPv4 IPAM pool you want to use for allocating this VPC's CIDR. For more information, see What is IPAM? in the Amazon VPC IPAM User Guide. You must specify eitherCidrBlock or Ipv4IpamPoolId. |
string |
| ipv4NetmaskLength | 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? in the Amazon VPC IPAM User Guide. | int |
| ipv6CidrBlocks | Property ipv6CidrBlocks | string[] |
| tags | The tags for the VPC. | TagAutoGenerated22[] |
| vpcId | Property vpcId | string |
Ec2VpcProperties
| Name | Description | Value |
|---|---|---|
| arn | Amazon Resource Name (ARN) | string |
| awsAccountId | AWS Account ID | string |
| awsProperties | AWS Properties | AwsEc2VpcProperties |
| awsRegion | AWS Region | string |
| awsSourceSchema | AWS Source Schema | string |
| awsTags | AWS Tags | Ec2VpcPropertiesAwsTags |
| publicCloudConnectorsResourceId | Public Cloud Connectors Resource ID | string |
| publicCloudResourceName | Public Cloud Resource Name | string |
Ec2VpcPropertiesAwsTags
| Name | Description | Value |
|---|
TagAutoGenerated22
| Name | Description | Value |
|---|---|---|
| key | The tag key. | string |
| value | The tag value. | string |
TrackedResourceTags
| Name | Description | Value |
|---|
ARM template resource definition
The ec2Vpcs resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.AwsConnector/ec2Vpcs resource, add the following JSON to your template.
{
"type": "Microsoft.AwsConnector/ec2Vpcs",
"apiVersion": "2024-12-01",
"name": "string",
"location": "string",
"properties": {
"arn": "string",
"awsAccountId": "string",
"awsProperties": {
"cidrBlock": "string",
"cidrBlockAssociations": [ "string" ],
"defaultNetworkAcl": "string",
"defaultSecurityGroup": "string",
"enableDnsHostnames": "bool",
"enableDnsSupport": "bool",
"instanceTenancy": "string",
"ipv4IpamPoolId": "string",
"ipv4NetmaskLength": "int",
"ipv6CidrBlocks": [ "string" ],
"tags": [
{
"key": "string",
"value": "string"
}
],
"vpcId": "string"
},
"awsRegion": "string",
"awsSourceSchema": "string",
"awsTags": {
"{customized property}": "string"
},
"publicCloudConnectorsResourceId": "string",
"publicCloudResourceName": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.AwsConnector/ec2Vpcs
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2024-12-01' |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^(?=.{0,259}[^\s.]$)(?!.*[<>%&\?/#]) (required) |
| properties | The resource-specific properties for this resource. | Ec2VpcProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.AwsConnector/ec2Vpcs' |
AwsEc2VpcProperties
| Name | Description | Value |
|---|---|---|
| cidrBlock | 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 eitherCidrBlock or Ipv4IpamPoolId. |
string |
| cidrBlockAssociations | Property cidrBlockAssociations | string[] |
| defaultNetworkAcl | Property defaultNetworkAcl | string |
| defaultSecurityGroup | Property defaultSecurityGroup | string |
| enableDnsHostnames | 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. You can only enable DNS hostnames if you've enabled DNS support. | bool |
| enableDnsSupport | 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. | bool |
| instanceTenancy | 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. |
string |
| ipv4IpamPoolId | The ID of an IPv4 IPAM pool you want to use for allocating this VPC's CIDR. For more information, see What is IPAM? in the Amazon VPC IPAM User Guide. You must specify eitherCidrBlock or Ipv4IpamPoolId. |
string |
| ipv4NetmaskLength | 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? in the Amazon VPC IPAM User Guide. | int |
| ipv6CidrBlocks | Property ipv6CidrBlocks | string[] |
| tags | The tags for the VPC. | TagAutoGenerated22[] |
| vpcId | Property vpcId | string |
Ec2VpcProperties
| Name | Description | Value |
|---|---|---|
| arn | Amazon Resource Name (ARN) | string |
| awsAccountId | AWS Account ID | string |
| awsProperties | AWS Properties | AwsEc2VpcProperties |
| awsRegion | AWS Region | string |
| awsSourceSchema | AWS Source Schema | string |
| awsTags | AWS Tags | Ec2VpcPropertiesAwsTags |
| publicCloudConnectorsResourceId | Public Cloud Connectors Resource ID | string |
| publicCloudResourceName | Public Cloud Resource Name | string |
Ec2VpcPropertiesAwsTags
| Name | Description | Value |
|---|
TagAutoGenerated22
| Name | Description | Value |
|---|---|---|
| key | The tag key. | string |
| value | The tag value. | string |
TrackedResourceTags
| Name | Description | Value |
|---|
Usage Examples
Terraform (AzAPI provider) resource definition
The ec2Vpcs resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.AwsConnector/ec2Vpcs resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.AwsConnector/ec2Vpcs@2024-12-01"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
arn = "string"
awsAccountId = "string"
awsProperties = {
cidrBlock = "string"
cidrBlockAssociations = [
"string"
]
defaultNetworkAcl = "string"
defaultSecurityGroup = "string"
enableDnsHostnames = bool
enableDnsSupport = bool
instanceTenancy = "string"
ipv4IpamPoolId = "string"
ipv4NetmaskLength = int
ipv6CidrBlocks = [
"string"
]
tags = [
{
key = "string"
value = "string"
}
]
vpcId = "string"
}
awsRegion = "string"
awsSourceSchema = "string"
awsTags = {
{customized property} = "string"
}
publicCloudConnectorsResourceId = "string"
publicCloudResourceName = "string"
}
}
}
Property Values
Microsoft.AwsConnector/ec2Vpcs
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^(?=.{0,259}[^\s.]$)(?!.*[<>%&\?/#]) (required) |
| properties | The resource-specific properties for this resource. | Ec2VpcProperties |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.AwsConnector/ec2Vpcs@2024-12-01" |
AwsEc2VpcProperties
| Name | Description | Value |
|---|---|---|
| cidrBlock | 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 eitherCidrBlock or Ipv4IpamPoolId. |
string |
| cidrBlockAssociations | Property cidrBlockAssociations | string[] |
| defaultNetworkAcl | Property defaultNetworkAcl | string |
| defaultSecurityGroup | Property defaultSecurityGroup | string |
| enableDnsHostnames | 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. You can only enable DNS hostnames if you've enabled DNS support. | bool |
| enableDnsSupport | 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. | bool |
| instanceTenancy | 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. |
string |
| ipv4IpamPoolId | The ID of an IPv4 IPAM pool you want to use for allocating this VPC's CIDR. For more information, see What is IPAM? in the Amazon VPC IPAM User Guide. You must specify eitherCidrBlock or Ipv4IpamPoolId. |
string |
| ipv4NetmaskLength | 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? in the Amazon VPC IPAM User Guide. | int |
| ipv6CidrBlocks | Property ipv6CidrBlocks | string[] |
| tags | The tags for the VPC. | TagAutoGenerated22[] |
| vpcId | Property vpcId | string |
Ec2VpcProperties
| Name | Description | Value |
|---|---|---|
| arn | Amazon Resource Name (ARN) | string |
| awsAccountId | AWS Account ID | string |
| awsProperties | AWS Properties | AwsEc2VpcProperties |
| awsRegion | AWS Region | string |
| awsSourceSchema | AWS Source Schema | string |
| awsTags | AWS Tags | Ec2VpcPropertiesAwsTags |
| publicCloudConnectorsResourceId | Public Cloud Connectors Resource ID | string |
| publicCloudResourceName | Public Cloud Resource Name | string |
Ec2VpcPropertiesAwsTags
| Name | Description | Value |
|---|
TagAutoGenerated22
| Name | Description | Value |
|---|---|---|
| key | The tag key. | string |
| value | The tag value. | string |
TrackedResourceTags
| Name | Description | Value |
|---|