Alibaba Cloud v3.34.0, Mar 17 23

alicloud.ecs.EcsPrefixList

Provides a ECS Prefix List resource.

For information about ECS Prefix List and how to use it, see What is Prefix List..

NOTE: Available in v1.152.0+.

Example Usage

Basic Usage

using System.Collections.Generic;
using Pulumi;
using AliCloud = Pulumi.AliCloud;

return await Deployment.RunAsync(() => 
{
    var @default = new AliCloud.Ecs.EcsPrefixList("default", new()
    {
        AddressFamily = "IPv4",
        Description = "description",
        Entries = new[]
        {
            new AliCloud.Ecs.Inputs.EcsPrefixListEntryArgs
            {
                Cidr = "192.168.0.0/24",
                Description = "description",
            },
        },
        MaxEntries = 2,
        PrefixListName = "tftest",
    });

});

package main

import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/ecs"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ecs.NewEcsPrefixList(ctx, "default", &ecs.EcsPrefixListArgs{
			AddressFamily: pulumi.String("IPv4"),
			Description:   pulumi.String("description"),
			Entries: ecs.EcsPrefixListEntryArray{
				&ecs.EcsPrefixListEntryArgs{
					Cidr:        pulumi.String("192.168.0.0/24"),
					Description: pulumi.String("description"),
				},
			},
			MaxEntries:     pulumi.Int(2),
			PrefixListName: pulumi.String("tftest"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.ecs.EcsPrefixList;
import com.pulumi.alicloud.ecs.EcsPrefixListArgs;
import com.pulumi.alicloud.ecs.inputs.EcsPrefixListEntryArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var default_ = new EcsPrefixList("default", EcsPrefixListArgs.builder()        
            .addressFamily("IPv4")
            .description("description")
            .entries(EcsPrefixListEntryArgs.builder()
                .cidr("192.168.0.0/24")
                .description("description")
                .build())
            .maxEntries(2)
            .prefixListName("tftest")
            .build());

    }
}

import pulumi
import pulumi_alicloud as alicloud

default = alicloud.ecs.EcsPrefixList("default",
    address_family="IPv4",
    description="description",
    entries=[alicloud.ecs.EcsPrefixListEntryArgs(
        cidr="192.168.0.0/24",
        description="description",
    )],
    max_entries=2,
    prefix_list_name="tftest")

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const _default = new alicloud.ecs.EcsPrefixList("default", {
    addressFamily: "IPv4",
    description: "description",
    entries: [{
        cidr: "192.168.0.0/24",
        description: "description",
    }],
    maxEntries: 2,
    prefixListName: "tftest",
});

resources:
  default:
    type: alicloud:ecs:EcsPrefixList
    properties:
      addressFamily: IPv4
      description: description
      entries:
        - cidr: 192.168.0.0/24
          description: description
      maxEntries: 2
      prefixListName: tftest

Create EcsPrefixList Resource

new EcsPrefixList(name: string, args: EcsPrefixListArgs, opts?: CustomResourceOptions);

@overload
def EcsPrefixList(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  address_family: Optional[str] = None,
                  description: Optional[str] = None,
                  entries: Optional[Sequence[EcsPrefixListEntryArgs]] = None,
                  max_entries: Optional[int] = None,
                  prefix_list_name: Optional[str] = None)
@overload
def EcsPrefixList(resource_name: str,
                  args: EcsPrefixListArgs,
                  opts: Optional[ResourceOptions] = None)

func NewEcsPrefixList(ctx *Context, name string, args EcsPrefixListArgs, opts ...ResourceOption) (*EcsPrefixList, error)

public EcsPrefixList(string name, EcsPrefixListArgs args, CustomResourceOptions? opts = null)

public EcsPrefixList(String name, EcsPrefixListArgs args)
public EcsPrefixList(String name, EcsPrefixListArgs args, CustomResourceOptions options)

type: alicloud:ecs:EcsPrefixList
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args EcsPrefixListArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args EcsPrefixListArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args EcsPrefixListArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args EcsPrefixListArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args EcsPrefixListArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

EcsPrefixList Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The EcsPrefixList resource accepts the following input properties:

AddressFamily string: The IP address family. Valid values: IPv4,IPv6.
Entries List<Pulumi.AliCloud.Ecs.Inputs.EcsPrefixListEntryArgs>: The Entry. The details see Block entry.
MaxEntries int: The maximum number of entries that the prefix list can contain. Valid values: 1 to 200.
PrefixListName string: The name of the prefix. The name must be 2 to 128 characters in length. It must start with a letter and cannot start with http://, https://, com.aliyun, or com.alibabacloud. It can contain letters, digits, colons (:), underscores (_), periods (.), and hyphens (-).
Description string: The description of the prefix list. The description must be 2 to 256 characters in length and cannot start with http:// or https://.

AddressFamily string: The IP address family. Valid values: IPv4,IPv6.
Entries []EcsPrefixListEntryArgs: The Entry. The details see Block entry.
MaxEntries int: The maximum number of entries that the prefix list can contain. Valid values: 1 to 200.
PrefixListName string: The name of the prefix. The name must be 2 to 128 characters in length. It must start with a letter and cannot start with http://, https://, com.aliyun, or com.alibabacloud. It can contain letters, digits, colons (:), underscores (_), periods (.), and hyphens (-).
Description string: The description of the prefix list. The description must be 2 to 256 characters in length and cannot start with http:// or https://.

addressFamily String: The IP address family. Valid values: IPv4,IPv6.
entries List<EcsPrefixListEntryArgs>: The Entry. The details see Block entry.
maxEntries Integer: The maximum number of entries that the prefix list can contain. Valid values: 1 to 200.
prefixListName String: The name of the prefix. The name must be 2 to 128 characters in length. It must start with a letter and cannot start with http://, https://, com.aliyun, or com.alibabacloud. It can contain letters, digits, colons (:), underscores (_), periods (.), and hyphens (-).
description String: The description of the prefix list. The description must be 2 to 256 characters in length and cannot start with http:// or https://.

addressFamily string: The IP address family. Valid values: IPv4,IPv6.
entries EcsPrefixListEntryArgs[]: The Entry. The details see Block entry.
maxEntries number: The maximum number of entries that the prefix list can contain. Valid values: 1 to 200.
prefixListName string: The name of the prefix. The name must be 2 to 128 characters in length. It must start with a letter and cannot start with http://, https://, com.aliyun, or com.alibabacloud. It can contain letters, digits, colons (:), underscores (_), periods (.), and hyphens (-).
description string: The description of the prefix list. The description must be 2 to 256 characters in length and cannot start with http:// or https://.

address_family str: The IP address family. Valid values: IPv4,IPv6.
entries Sequence[EcsPrefixListEntryArgs]: The Entry. The details see Block entry.
max_entries int: The maximum number of entries that the prefix list can contain. Valid values: 1 to 200.
prefix_list_name str: The name of the prefix. The name must be 2 to 128 characters in length. It must start with a letter and cannot start with http://, https://, com.aliyun, or com.alibabacloud. It can contain letters, digits, colons (:), underscores (_), periods (.), and hyphens (-).
description str: The description of the prefix list. The description must be 2 to 256 characters in length and cannot start with http:// or https://.

addressFamily String: The IP address family. Valid values: IPv4,IPv6.
entries List<Property Map>: The Entry. The details see Block entry.
maxEntries Number: The maximum number of entries that the prefix list can contain. Valid values: 1 to 200.
prefixListName String: The name of the prefix. The name must be 2 to 128 characters in length. It must start with a letter and cannot start with http://, https://, com.aliyun, or com.alibabacloud. It can contain letters, digits, colons (:), underscores (_), periods (.), and hyphens (-).
description String: The description of the prefix list. The description must be 2 to 256 characters in length and cannot start with http:// or https://.

Outputs

All input properties are implicitly available as output properties. Additionally, the EcsPrefixList resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing EcsPrefixList Resource

Get an existing EcsPrefixList resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: EcsPrefixListState, opts?: CustomResourceOptions): EcsPrefixList

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        address_family: Optional[str] = None,
        description: Optional[str] = None,
        entries: Optional[Sequence[EcsPrefixListEntryArgs]] = None,
        max_entries: Optional[int] = None,
        prefix_list_name: Optional[str] = None) -> EcsPrefixList

func GetEcsPrefixList(ctx *Context, name string, id IDInput, state *EcsPrefixListState, opts ...ResourceOption) (*EcsPrefixList, error)

public static EcsPrefixList Get(string name, Input<string> id, EcsPrefixListState? state, CustomResourceOptions? opts = null)

public static EcsPrefixList get(String name, Output<String> id, EcsPrefixListState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AddressFamily string: The IP address family. Valid values: IPv4,IPv6.
Description string: The description of the prefix list. The description must be 2 to 256 characters in length and cannot start with http:// or https://.
Entries List<Pulumi.AliCloud.Ecs.Inputs.EcsPrefixListEntryArgs>: The Entry. The details see Block entry.
MaxEntries int: The maximum number of entries that the prefix list can contain. Valid values: 1 to 200.
PrefixListName string: The name of the prefix. The name must be 2 to 128 characters in length. It must start with a letter and cannot start with http://, https://, com.aliyun, or com.alibabacloud. It can contain letters, digits, colons (:), underscores (_), periods (.), and hyphens (-).

AddressFamily string: The IP address family. Valid values: IPv4,IPv6.
Description string: The description of the prefix list. The description must be 2 to 256 characters in length and cannot start with http:// or https://.
Entries []EcsPrefixListEntryArgs: The Entry. The details see Block entry.
MaxEntries int: The maximum number of entries that the prefix list can contain. Valid values: 1 to 200.
PrefixListName string: The name of the prefix. The name must be 2 to 128 characters in length. It must start with a letter and cannot start with http://, https://, com.aliyun, or com.alibabacloud. It can contain letters, digits, colons (:), underscores (_), periods (.), and hyphens (-).

addressFamily String: The IP address family. Valid values: IPv4,IPv6.
description String: The description of the prefix list. The description must be 2 to 256 characters in length and cannot start with http:// or https://.
entries List<EcsPrefixListEntryArgs>: The Entry. The details see Block entry.
maxEntries Integer: The maximum number of entries that the prefix list can contain. Valid values: 1 to 200.
prefixListName String: The name of the prefix. The name must be 2 to 128 characters in length. It must start with a letter and cannot start with http://, https://, com.aliyun, or com.alibabacloud. It can contain letters, digits, colons (:), underscores (_), periods (.), and hyphens (-).

addressFamily string: The IP address family. Valid values: IPv4,IPv6.
description string: The description of the prefix list. The description must be 2 to 256 characters in length and cannot start with http:// or https://.
entries EcsPrefixListEntryArgs[]: The Entry. The details see Block entry.
maxEntries number: The maximum number of entries that the prefix list can contain. Valid values: 1 to 200.
prefixListName string: The name of the prefix. The name must be 2 to 128 characters in length. It must start with a letter and cannot start with http://, https://, com.aliyun, or com.alibabacloud. It can contain letters, digits, colons (:), underscores (_), periods (.), and hyphens (-).

address_family str: The IP address family. Valid values: IPv4,IPv6.
description str: The description of the prefix list. The description must be 2 to 256 characters in length and cannot start with http:// or https://.
entries Sequence[EcsPrefixListEntryArgs]: The Entry. The details see Block entry.
max_entries int: The maximum number of entries that the prefix list can contain. Valid values: 1 to 200.
prefix_list_name str: The name of the prefix. The name must be 2 to 128 characters in length. It must start with a letter and cannot start with http://, https://, com.aliyun, or com.alibabacloud. It can contain letters, digits, colons (:), underscores (_), periods (.), and hyphens (-).

addressFamily String: The IP address family. Valid values: IPv4,IPv6.
description String: The description of the prefix list. The description must be 2 to 256 characters in length and cannot start with http:// or https://.
entries List<Property Map>: The Entry. The details see Block entry.
maxEntries Number: The maximum number of entries that the prefix list can contain. Valid values: 1 to 200.
prefixListName String: The name of the prefix. The name must be 2 to 128 characters in length. It must start with a letter and cannot start with http://, https://, com.aliyun, or com.alibabacloud. It can contain letters, digits, colons (:), underscores (_), periods (.), and hyphens (-).

Supporting Types

EcsPrefixListEntry

Cidr string

The CIDR block in entry. This parameter is empty by default. Take note of the following items:

The total number of entries must not exceed the max_entries value.
CIDR block types are determined by the IP address family. You cannot combine IPv4 and IPv6 CIDR blocks in a single entry.
CIDR blocks must be unique across all entries in a prefix list. For example, you cannot specify 192.168.1.0/24 twice in the entries of the prefix list.
IP addresses are supported. The system converts IP addresses into CIDR blocks. For example, if you specify 192.168.1.100, the system converts it into the 192.168.1.100/32 CIDR block.
If an IPv6 CIDR block is used, the system converts it to the zero compression format and changes uppercase letters into lowercase ones. For example, if you specify 2001:0DB8:0000:0000:0000:0000:0000:0000/32, the system converts it into 2001:db8::/32.
For more information about CIDR blocks, see the "What is CIDR block?" section of the Network FAQ topic. * The total number of entries must not exceed the max_entries value.

Description string