1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Waas
  5. AddressList
Oracle Cloud Infrastructure v2.2.0 published on Friday, Jul 12, 2024 by Pulumi

oci.Waas.AddressList

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.2.0 published on Friday, Jul 12, 2024 by Pulumi

    This resource provides the Address List resource in Oracle Cloud Infrastructure Web Application Acceleration and Security service.

    Creates an address list in a set compartment and allows it to be used in a WAAS policy and referenced by access rules. Addresses can be IP addresses and CIDR notations.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testAddressList = new oci.waas.AddressList("test_address_list", {
        addresses: addressListAddresses,
        compartmentId: compartmentId,
        displayName: addressListDisplayName,
        definedTags: {
            "Operations.CostCenter": "42",
        },
        freeformTags: {
            Department: "Finance",
        },
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_address_list = oci.waas.AddressList("test_address_list",
        addresses=address_list_addresses,
        compartment_id=compartment_id,
        display_name=address_list_display_name,
        defined_tags={
            "Operations.CostCenter": "42",
        },
        freeform_tags={
            "Department": "Finance",
        })
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/Waas"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := Waas.NewAddressList(ctx, "test_address_list", &Waas.AddressListArgs{
    			Addresses:     pulumi.Any(addressListAddresses),
    			CompartmentId: pulumi.Any(compartmentId),
    			DisplayName:   pulumi.Any(addressListDisplayName),
    			DefinedTags: pulumi.Map{
    				"Operations.CostCenter": pulumi.Any("42"),
    			},
    			FreeformTags: pulumi.Map{
    				"Department": pulumi.Any("Finance"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Oci = Pulumi.Oci;
    
    return await Deployment.RunAsync(() => 
    {
        var testAddressList = new Oci.Waas.AddressList("test_address_list", new()
        {
            Addresses = addressListAddresses,
            CompartmentId = compartmentId,
            DisplayName = addressListDisplayName,
            DefinedTags = 
            {
                { "Operations.CostCenter", "42" },
            },
            FreeformTags = 
            {
                { "Department", "Finance" },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.Waas.AddressList;
    import com.pulumi.oci.Waas.AddressListArgs;
    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 testAddressList = new AddressList("testAddressList", AddressListArgs.builder()
                .addresses(addressListAddresses)
                .compartmentId(compartmentId)
                .displayName(addressListDisplayName)
                .definedTags(Map.of("Operations.CostCenter", "42"))
                .freeformTags(Map.of("Department", "Finance"))
                .build());
    
        }
    }
    
    resources:
      testAddressList:
        type: oci:Waas:AddressList
        name: test_address_list
        properties:
          addresses: ${addressListAddresses}
          compartmentId: ${compartmentId}
          displayName: ${addressListDisplayName}
          definedTags:
            Operations.CostCenter: '42'
          freeformTags:
            Department: Finance
    

    Create AddressList Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new AddressList(name: string, args: AddressListArgs, opts?: CustomResourceOptions);
    @overload
    def AddressList(resource_name: str,
                    args: AddressListArgs,
                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def AddressList(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    addresses: Optional[Sequence[str]] = None,
                    compartment_id: Optional[str] = None,
                    display_name: Optional[str] = None,
                    defined_tags: Optional[Mapping[str, Any]] = None,
                    freeform_tags: Optional[Mapping[str, Any]] = None)
    func NewAddressList(ctx *Context, name string, args AddressListArgs, opts ...ResourceOption) (*AddressList, error)
    public AddressList(string name, AddressListArgs args, CustomResourceOptions? opts = null)
    public AddressList(String name, AddressListArgs args)
    public AddressList(String name, AddressListArgs args, CustomResourceOptions options)
    
    type: oci:Waas:AddressList
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args AddressListArgs
    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 AddressListArgs
    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 AddressListArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AddressListArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AddressListArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var addressListResource = new Oci.Waas.AddressList("addressListResource", new()
    {
        Addresses = new[]
        {
            "string",
        },
        CompartmentId = "string",
        DisplayName = "string",
        DefinedTags = 
        {
            { "string", "any" },
        },
        FreeformTags = 
        {
            { "string", "any" },
        },
    });
    
    example, err := Waas.NewAddressList(ctx, "addressListResource", &Waas.AddressListArgs{
    	Addresses: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	CompartmentId: pulumi.String("string"),
    	DisplayName:   pulumi.String("string"),
    	DefinedTags: pulumi.Map{
    		"string": pulumi.Any("any"),
    	},
    	FreeformTags: pulumi.Map{
    		"string": pulumi.Any("any"),
    	},
    })
    
    var addressListResource = new AddressList("addressListResource", AddressListArgs.builder()
        .addresses("string")
        .compartmentId("string")
        .displayName("string")
        .definedTags(Map.of("string", "any"))
        .freeformTags(Map.of("string", "any"))
        .build());
    
    address_list_resource = oci.waas.AddressList("addressListResource",
        addresses=["string"],
        compartment_id="string",
        display_name="string",
        defined_tags={
            "string": "any",
        },
        freeform_tags={
            "string": "any",
        })
    
    const addressListResource = new oci.waas.AddressList("addressListResource", {
        addresses: ["string"],
        compartmentId: "string",
        displayName: "string",
        definedTags: {
            string: "any",
        },
        freeformTags: {
            string: "any",
        },
    });
    
    type: oci:Waas:AddressList
    properties:
        addresses:
            - string
        compartmentId: string
        definedTags:
            string: any
        displayName: string
        freeformTags:
            string: any
    

    AddressList 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 AddressList resource accepts the following input properties:

    Addresses List<string>
    (Updatable) A list of IP addresses or CIDR notations.
    CompartmentId string
    (Updatable) The OCID of the compartment in which to create the address list.
    DisplayName string
    (Updatable) A user-friendly name for the address list.
    DefinedTags Dictionary<string, object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    FreeformTags Dictionary<string, object>

    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    Addresses []string
    (Updatable) A list of IP addresses or CIDR notations.
    CompartmentId string
    (Updatable) The OCID of the compartment in which to create the address list.
    DisplayName string
    (Updatable) A user-friendly name for the address list.
    DefinedTags map[string]interface{}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    FreeformTags map[string]interface{}

    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    addresses List<String>
    (Updatable) A list of IP addresses or CIDR notations.
    compartmentId String
    (Updatable) The OCID of the compartment in which to create the address list.
    displayName String
    (Updatable) A user-friendly name for the address list.
    definedTags Map<String,Object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    freeformTags Map<String,Object>

    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    addresses string[]
    (Updatable) A list of IP addresses or CIDR notations.
    compartmentId string
    (Updatable) The OCID of the compartment in which to create the address list.
    displayName string
    (Updatable) A user-friendly name for the address list.
    definedTags {[key: string]: any}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    freeformTags {[key: string]: any}

    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    addresses Sequence[str]
    (Updatable) A list of IP addresses or CIDR notations.
    compartment_id str
    (Updatable) The OCID of the compartment in which to create the address list.
    display_name str
    (Updatable) A user-friendly name for the address list.
    defined_tags Mapping[str, Any]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    freeform_tags Mapping[str, Any]

    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    addresses List<String>
    (Updatable) A list of IP addresses or CIDR notations.
    compartmentId String
    (Updatable) The OCID of the compartment in which to create the address list.
    displayName String
    (Updatable) A user-friendly name for the address list.
    definedTags Map<Any>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    freeformTags Map<Any>

    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    Outputs

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

    AddressCount double
    The total number of unique IP addresses in the address list.
    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    The current lifecycle state of the address list.
    TimeCreated string
    The date and time the address list was created, expressed in RFC 3339 timestamp format.
    AddressCount float64
    The total number of unique IP addresses in the address list.
    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    The current lifecycle state of the address list.
    TimeCreated string
    The date and time the address list was created, expressed in RFC 3339 timestamp format.
    addressCount Double
    The total number of unique IP addresses in the address list.
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    The current lifecycle state of the address list.
    timeCreated String
    The date and time the address list was created, expressed in RFC 3339 timestamp format.
    addressCount number
    The total number of unique IP addresses in the address list.
    id string
    The provider-assigned unique ID for this managed resource.
    state string
    The current lifecycle state of the address list.
    timeCreated string
    The date and time the address list was created, expressed in RFC 3339 timestamp format.
    address_count float
    The total number of unique IP addresses in the address list.
    id str
    The provider-assigned unique ID for this managed resource.
    state str
    The current lifecycle state of the address list.
    time_created str
    The date and time the address list was created, expressed in RFC 3339 timestamp format.
    addressCount Number
    The total number of unique IP addresses in the address list.
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    The current lifecycle state of the address list.
    timeCreated String
    The date and time the address list was created, expressed in RFC 3339 timestamp format.

    Look up Existing AddressList Resource

    Get an existing AddressList 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?: AddressListState, opts?: CustomResourceOptions): AddressList
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            address_count: Optional[float] = None,
            addresses: Optional[Sequence[str]] = None,
            compartment_id: Optional[str] = None,
            defined_tags: Optional[Mapping[str, Any]] = None,
            display_name: Optional[str] = None,
            freeform_tags: Optional[Mapping[str, Any]] = None,
            state: Optional[str] = None,
            time_created: Optional[str] = None) -> AddressList
    func GetAddressList(ctx *Context, name string, id IDInput, state *AddressListState, opts ...ResourceOption) (*AddressList, error)
    public static AddressList Get(string name, Input<string> id, AddressListState? state, CustomResourceOptions? opts = null)
    public static AddressList get(String name, Output<String> id, AddressListState 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:
    AddressCount double
    The total number of unique IP addresses in the address list.
    Addresses List<string>
    (Updatable) A list of IP addresses or CIDR notations.
    CompartmentId string
    (Updatable) The OCID of the compartment in which to create the address list.
    DefinedTags Dictionary<string, object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DisplayName string
    (Updatable) A user-friendly name for the address list.
    FreeformTags Dictionary<string, object>

    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    State string
    The current lifecycle state of the address list.
    TimeCreated string
    The date and time the address list was created, expressed in RFC 3339 timestamp format.
    AddressCount float64
    The total number of unique IP addresses in the address list.
    Addresses []string
    (Updatable) A list of IP addresses or CIDR notations.
    CompartmentId string
    (Updatable) The OCID of the compartment in which to create the address list.
    DefinedTags map[string]interface{}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DisplayName string
    (Updatable) A user-friendly name for the address list.
    FreeformTags map[string]interface{}

    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    State string
    The current lifecycle state of the address list.
    TimeCreated string
    The date and time the address list was created, expressed in RFC 3339 timestamp format.
    addressCount Double
    The total number of unique IP addresses in the address list.
    addresses List<String>
    (Updatable) A list of IP addresses or CIDR notations.
    compartmentId String
    (Updatable) The OCID of the compartment in which to create the address list.
    definedTags Map<String,Object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName String
    (Updatable) A user-friendly name for the address list.
    freeformTags Map<String,Object>

    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    state String
    The current lifecycle state of the address list.
    timeCreated String
    The date and time the address list was created, expressed in RFC 3339 timestamp format.
    addressCount number
    The total number of unique IP addresses in the address list.
    addresses string[]
    (Updatable) A list of IP addresses or CIDR notations.
    compartmentId string
    (Updatable) The OCID of the compartment in which to create the address list.
    definedTags {[key: string]: any}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName string
    (Updatable) A user-friendly name for the address list.
    freeformTags {[key: string]: any}

    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    state string
    The current lifecycle state of the address list.
    timeCreated string
    The date and time the address list was created, expressed in RFC 3339 timestamp format.
    address_count float
    The total number of unique IP addresses in the address list.
    addresses Sequence[str]
    (Updatable) A list of IP addresses or CIDR notations.
    compartment_id str
    (Updatable) The OCID of the compartment in which to create the address list.
    defined_tags Mapping[str, Any]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    display_name str
    (Updatable) A user-friendly name for the address list.
    freeform_tags Mapping[str, Any]

    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    state str
    The current lifecycle state of the address list.
    time_created str
    The date and time the address list was created, expressed in RFC 3339 timestamp format.
    addressCount Number
    The total number of unique IP addresses in the address list.
    addresses List<String>
    (Updatable) A list of IP addresses or CIDR notations.
    compartmentId String
    (Updatable) The OCID of the compartment in which to create the address list.
    definedTags Map<Any>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName String
    (Updatable) A user-friendly name for the address list.
    freeformTags Map<Any>

    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    state String
    The current lifecycle state of the address list.
    timeCreated String
    The date and time the address list was created, expressed in RFC 3339 timestamp format.

    Import

    AddressLists can be imported using the id, e.g.

    $ pulumi import oci:Waas/addressList:AddressList test_address_list "id"
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.2.0 published on Friday, Jul 12, 2024 by Pulumi