From 8fe29ce598e5d0ad5bb181a11b3c0341716743ff Mon Sep 17 00:00:00 2001 From: Florian Stadler Date: Wed, 13 Nov 2024 20:20:51 +0100 Subject: [PATCH] Fix docs of VPC SubnetSpecs (#1425) - **Fix docs of VPC SubnetSpecs** - **Regenerate schema** - **Regenerate SDK** Fixes https://github.com/pulumi/pulumi-awsx/issues/1423 --- schema.json | 2 +- schemagen/pkg/gen/ec2.go | 2 +- sdk/dotnet/Ec2/Vpc.cs | 2 +- sdk/go/awsx/ec2/vpc.go | 4 ++-- sdk/java/src/main/java/com/pulumi/awsx/ec2/VpcArgs.java | 8 ++++---- sdk/nodejs/ec2/vpc.ts | 2 +- sdk/python/pulumi_awsx/ec2/vpc.py | 6 +++--- 7 files changed, 13 insertions(+), 13 deletions(-) diff --git a/schema.json b/schema.json index 20b73a1f1..f496e15fb 100644 --- a/schema.json +++ b/schema.json @@ -2125,7 +2125,7 @@ "plain": true }, "plain": true, - "description": "A list of subnet specs that should be deployed to each AZ specified in availabilityZoneNames. Optional. Defaults to a (smaller) public subnet and a (larger) private subnet based on the size of the CIDR block for the VPC. Private subnets are allocated CIDR block ranges first, followed by Private subnets, and Isolated subnets are allocated last." + "description": "A list of subnet specs that should be deployed to each AZ specified in availabilityZoneNames. Optional. Defaults to a (smaller) public subnet and a (larger) private subnet based on the size of the CIDR block for the VPC. Private subnets are allocated CIDR block ranges first, followed by Public subnets, and Isolated subnets are allocated last." }, "subnetStrategy": { "$ref": "#/types/awsx:ec2:SubnetAllocationStrategy", diff --git a/schemagen/pkg/gen/ec2.go b/schemagen/pkg/gen/ec2.go index c0e58cb29..35aa85260 100644 --- a/schemagen/pkg/gen/ec2.go +++ b/schemagen/pkg/gen/ec2.go @@ -130,7 +130,7 @@ func vpcResource(awsSpec schema.PackageSpec) schema.ResourceSpec { }, }, subnetSpecs: { - Description: fmt.Sprintf("A list of subnet specs that should be deployed to each AZ specified in %s. Optional. Defaults to a (smaller) public subnet and a (larger) private subnet based on the size of the CIDR block for the VPC. Private subnets are allocated CIDR block ranges first, followed by Private subnets, and Isolated subnets are allocated last.", availabilityZoneNames), + Description: fmt.Sprintf("A list of subnet specs that should be deployed to each AZ specified in %s. Optional. Defaults to a (smaller) public subnet and a (larger) private subnet based on the size of the CIDR block for the VPC. Private subnets are allocated CIDR block ranges first, followed by Public subnets, and Isolated subnets are allocated last.", availabilityZoneNames), TypeSpec: plainArrayOfPlainComplexType("SubnetSpec"), }, "vpcEndpointSpecs": { diff --git a/sdk/dotnet/Ec2/Vpc.cs b/sdk/dotnet/Ec2/Vpc.cs index f38b52565..6f27acc81 100644 --- a/sdk/dotnet/Ec2/Vpc.cs +++ b/sdk/dotnet/Ec2/Vpc.cs @@ -268,7 +268,7 @@ public List AvailabilityZoneNames private List? _subnetSpecs; /// - /// A list of subnet specs that should be deployed to each AZ specified in availabilityZoneNames. Optional. Defaults to a (smaller) public subnet and a (larger) private subnet based on the size of the CIDR block for the VPC. Private subnets are allocated CIDR block ranges first, followed by Private subnets, and Isolated subnets are allocated last. + /// A list of subnet specs that should be deployed to each AZ specified in availabilityZoneNames. Optional. Defaults to a (smaller) public subnet and a (larger) private subnet based on the size of the CIDR block for the VPC. Private subnets are allocated CIDR block ranges first, followed by Public subnets, and Isolated subnets are allocated last. /// public List SubnetSpecs { diff --git a/sdk/go/awsx/ec2/vpc.go b/sdk/go/awsx/ec2/vpc.go index 501fabe66..febdb968a 100644 --- a/sdk/go/awsx/ec2/vpc.go +++ b/sdk/go/awsx/ec2/vpc.go @@ -144,7 +144,7 @@ type vpcArgs struct { NatGateways *NatGatewayConfiguration `pulumi:"natGateways"` // A number of availability zones to which the subnets defined in subnetSpecs will be deployed. Optional, defaults to the first 3 AZs in the current region. NumberOfAvailabilityZones *int `pulumi:"numberOfAvailabilityZones"` - // A list of subnet specs that should be deployed to each AZ specified in availabilityZoneNames. Optional. Defaults to a (smaller) public subnet and a (larger) private subnet based on the size of the CIDR block for the VPC. Private subnets are allocated CIDR block ranges first, followed by Private subnets, and Isolated subnets are allocated last. + // A list of subnet specs that should be deployed to each AZ specified in availabilityZoneNames. Optional. Defaults to a (smaller) public subnet and a (larger) private subnet based on the size of the CIDR block for the VPC. Private subnets are allocated CIDR block ranges first, followed by Public subnets, and Isolated subnets are allocated last. SubnetSpecs []SubnetSpec `pulumi:"subnetSpecs"` // The strategy to use when allocating subnets for the VPC. Optional. Defaults to `Legacy`. SubnetStrategy *SubnetAllocationStrategy `pulumi:"subnetStrategy"` @@ -188,7 +188,7 @@ type VpcArgs struct { NatGateways *NatGatewayConfigurationArgs // A number of availability zones to which the subnets defined in subnetSpecs will be deployed. Optional, defaults to the first 3 AZs in the current region. NumberOfAvailabilityZones *int - // A list of subnet specs that should be deployed to each AZ specified in availabilityZoneNames. Optional. Defaults to a (smaller) public subnet and a (larger) private subnet based on the size of the CIDR block for the VPC. Private subnets are allocated CIDR block ranges first, followed by Private subnets, and Isolated subnets are allocated last. + // A list of subnet specs that should be deployed to each AZ specified in availabilityZoneNames. Optional. Defaults to a (smaller) public subnet and a (larger) private subnet based on the size of the CIDR block for the VPC. Private subnets are allocated CIDR block ranges first, followed by Public subnets, and Isolated subnets are allocated last. SubnetSpecs []SubnetSpecArgs // The strategy to use when allocating subnets for the VPC. Optional. Defaults to `Legacy`. SubnetStrategy *SubnetAllocationStrategy diff --git a/sdk/java/src/main/java/com/pulumi/awsx/ec2/VpcArgs.java b/sdk/java/src/main/java/com/pulumi/awsx/ec2/VpcArgs.java index 9cbbd5c8d..f8b91e470 100644 --- a/sdk/java/src/main/java/com/pulumi/awsx/ec2/VpcArgs.java +++ b/sdk/java/src/main/java/com/pulumi/awsx/ec2/VpcArgs.java @@ -264,14 +264,14 @@ public Optional numberOfAvailabilityZones() { } /** - * A list of subnet specs that should be deployed to each AZ specified in availabilityZoneNames. Optional. Defaults to a (smaller) public subnet and a (larger) private subnet based on the size of the CIDR block for the VPC. Private subnets are allocated CIDR block ranges first, followed by Private subnets, and Isolated subnets are allocated last. + * A list of subnet specs that should be deployed to each AZ specified in availabilityZoneNames. Optional. Defaults to a (smaller) public subnet and a (larger) private subnet based on the size of the CIDR block for the VPC. Private subnets are allocated CIDR block ranges first, followed by Public subnets, and Isolated subnets are allocated last. * */ @Import(name="subnetSpecs") private @Nullable List subnetSpecs; /** - * @return A list of subnet specs that should be deployed to each AZ specified in availabilityZoneNames. Optional. Defaults to a (smaller) public subnet and a (larger) private subnet based on the size of the CIDR block for the VPC. Private subnets are allocated CIDR block ranges first, followed by Private subnets, and Isolated subnets are allocated last. + * @return A list of subnet specs that should be deployed to each AZ specified in availabilityZoneNames. Optional. Defaults to a (smaller) public subnet and a (larger) private subnet based on the size of the CIDR block for the VPC. Private subnets are allocated CIDR block ranges first, followed by Public subnets, and Isolated subnets are allocated last. * */ public Optional> subnetSpecs() { @@ -663,7 +663,7 @@ public Builder numberOfAvailabilityZones(@Nullable Integer numberOfAvailabilityZ } /** - * @param subnetSpecs A list of subnet specs that should be deployed to each AZ specified in availabilityZoneNames. Optional. Defaults to a (smaller) public subnet and a (larger) private subnet based on the size of the CIDR block for the VPC. Private subnets are allocated CIDR block ranges first, followed by Private subnets, and Isolated subnets are allocated last. + * @param subnetSpecs A list of subnet specs that should be deployed to each AZ specified in availabilityZoneNames. Optional. Defaults to a (smaller) public subnet and a (larger) private subnet based on the size of the CIDR block for the VPC. Private subnets are allocated CIDR block ranges first, followed by Public subnets, and Isolated subnets are allocated last. * * @return builder * @@ -674,7 +674,7 @@ public Builder subnetSpecs(@Nullable List subnetSpecs) { } /** - * @param subnetSpecs A list of subnet specs that should be deployed to each AZ specified in availabilityZoneNames. Optional. Defaults to a (smaller) public subnet and a (larger) private subnet based on the size of the CIDR block for the VPC. Private subnets are allocated CIDR block ranges first, followed by Private subnets, and Isolated subnets are allocated last. + * @param subnetSpecs A list of subnet specs that should be deployed to each AZ specified in availabilityZoneNames. Optional. Defaults to a (smaller) public subnet and a (larger) private subnet based on the size of the CIDR block for the VPC. Private subnets are allocated CIDR block ranges first, followed by Public subnets, and Isolated subnets are allocated last. * * @return builder * diff --git a/sdk/nodejs/ec2/vpc.ts b/sdk/nodejs/ec2/vpc.ts index 027bc654b..de1d8ea67 100644 --- a/sdk/nodejs/ec2/vpc.ts +++ b/sdk/nodejs/ec2/vpc.ts @@ -244,7 +244,7 @@ export interface VpcArgs { */ numberOfAvailabilityZones?: number; /** - * A list of subnet specs that should be deployed to each AZ specified in availabilityZoneNames. Optional. Defaults to a (smaller) public subnet and a (larger) private subnet based on the size of the CIDR block for the VPC. Private subnets are allocated CIDR block ranges first, followed by Private subnets, and Isolated subnets are allocated last. + * A list of subnet specs that should be deployed to each AZ specified in availabilityZoneNames. Optional. Defaults to a (smaller) public subnet and a (larger) private subnet based on the size of the CIDR block for the VPC. Private subnets are allocated CIDR block ranges first, followed by Public subnets, and Isolated subnets are allocated last. */ subnetSpecs?: inputs.ec2.SubnetSpecArgs[]; /** diff --git a/sdk/python/pulumi_awsx/ec2/vpc.py b/sdk/python/pulumi_awsx/ec2/vpc.py index 104743cde..e9ec8788a 100644 --- a/sdk/python/pulumi_awsx/ec2/vpc.py +++ b/sdk/python/pulumi_awsx/ec2/vpc.py @@ -61,7 +61,7 @@ def __init__(__self__, *, :param pulumi.Input[int] ipv6_netmask_length: Netmask length to request from IPAM Pool. Conflicts with `ipv6_cidr_block`. This can be omitted if IPAM pool as a `allocation_default_netmask_length` set. Valid values are from `44` to `60` in increments of 4. :param 'NatGatewayConfigurationArgs' nat_gateways: Configuration for NAT Gateways. Optional. If private and public subnets are both specified, defaults to one gateway per availability zone. Otherwise, no gateways will be created. :param int number_of_availability_zones: A number of availability zones to which the subnets defined in subnetSpecs will be deployed. Optional, defaults to the first 3 AZs in the current region. - :param Sequence['SubnetSpecArgs'] subnet_specs: A list of subnet specs that should be deployed to each AZ specified in availabilityZoneNames. Optional. Defaults to a (smaller) public subnet and a (larger) private subnet based on the size of the CIDR block for the VPC. Private subnets are allocated CIDR block ranges first, followed by Private subnets, and Isolated subnets are allocated last. + :param Sequence['SubnetSpecArgs'] subnet_specs: A list of subnet specs that should be deployed to each AZ specified in availabilityZoneNames. Optional. Defaults to a (smaller) public subnet and a (larger) private subnet based on the size of the CIDR block for the VPC. Private subnets are allocated CIDR block ranges first, followed by Public subnets, and Isolated subnets are allocated last. :param 'SubnetAllocationStrategy' subnet_strategy: The strategy to use when allocating subnets for the VPC. Optional. Defaults to `Legacy`. :param pulumi.Input[Mapping[str, pulumi.Input[str]]] tags: A map of tags to assign to the resource. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. :param Sequence['VpcEndpointSpecArgs'] vpc_endpoint_specs: A list of VPC Endpoints specs to be deployed as part of the VPC @@ -303,7 +303,7 @@ def number_of_availability_zones(self, value: Optional[int]): @pulumi.getter(name="subnetSpecs") def subnet_specs(self) -> Optional[Sequence['SubnetSpecArgs']]: """ - A list of subnet specs that should be deployed to each AZ specified in availabilityZoneNames. Optional. Defaults to a (smaller) public subnet and a (larger) private subnet based on the size of the CIDR block for the VPC. Private subnets are allocated CIDR block ranges first, followed by Private subnets, and Isolated subnets are allocated last. + A list of subnet specs that should be deployed to each AZ specified in availabilityZoneNames. Optional. Defaults to a (smaller) public subnet and a (larger) private subnet based on the size of the CIDR block for the VPC. Private subnets are allocated CIDR block ranges first, followed by Public subnets, and Isolated subnets are allocated last. """ return pulumi.get(self, "subnet_specs") @@ -433,7 +433,7 @@ def __init__(__self__, :param pulumi.Input[int] ipv6_netmask_length: Netmask length to request from IPAM Pool. Conflicts with `ipv6_cidr_block`. This can be omitted if IPAM pool as a `allocation_default_netmask_length` set. Valid values are from `44` to `60` in increments of 4. :param Union['NatGatewayConfigurationArgs', 'NatGatewayConfigurationArgsDict'] nat_gateways: Configuration for NAT Gateways. Optional. If private and public subnets are both specified, defaults to one gateway per availability zone. Otherwise, no gateways will be created. :param int number_of_availability_zones: A number of availability zones to which the subnets defined in subnetSpecs will be deployed. Optional, defaults to the first 3 AZs in the current region. - :param Sequence[Union['SubnetSpecArgs', 'SubnetSpecArgsDict']] subnet_specs: A list of subnet specs that should be deployed to each AZ specified in availabilityZoneNames. Optional. Defaults to a (smaller) public subnet and a (larger) private subnet based on the size of the CIDR block for the VPC. Private subnets are allocated CIDR block ranges first, followed by Private subnets, and Isolated subnets are allocated last. + :param Sequence[Union['SubnetSpecArgs', 'SubnetSpecArgsDict']] subnet_specs: A list of subnet specs that should be deployed to each AZ specified in availabilityZoneNames. Optional. Defaults to a (smaller) public subnet and a (larger) private subnet based on the size of the CIDR block for the VPC. Private subnets are allocated CIDR block ranges first, followed by Public subnets, and Isolated subnets are allocated last. :param 'SubnetAllocationStrategy' subnet_strategy: The strategy to use when allocating subnets for the VPC. Optional. Defaults to `Legacy`. :param pulumi.Input[Mapping[str, pulumi.Input[str]]] tags: A map of tags to assign to the resource. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. :param Sequence[Union['VpcEndpointSpecArgs', 'VpcEndpointSpecArgsDict']] vpc_endpoint_specs: A list of VPC Endpoints specs to be deployed as part of the VPC