Docs Home
oci.Waas.AddressList
Explore with Pulumi AI
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.StringMap{
"Operations.CostCenter": pulumi.String("42"),
},
FreeformTags: pulumi.StringMap{
"Department": pulumi.String("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, str]] = None,
freeform_tags: Optional[Mapping[str, str]] = 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", "string" },
},
FreeformTags =
{
{ "string", "string" },
},
});
example, err := waas.NewAddressList(ctx, "addressListResource", &waas.AddressListArgs{
Addresses: pulumi.StringArray{
pulumi.String("string"),
},
CompartmentId: pulumi.String("string"),
DisplayName: pulumi.String("string"),
DefinedTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
FreeformTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var addressListResource = new AddressList("addressListResource", AddressListArgs.builder()
.addresses("string")
.compartmentId("string")
.displayName("string")
.definedTags(Map.of("string", "string"))
.freeformTags(Map.of("string", "string"))
.build());
address_list_resource = oci.waas.AddressList("addressListResource",
addresses=["string"],
compartment_id="string",
display_name="string",
defined_tags={
"string": "string",
},
freeform_tags={
"string": "string",
})
const addressListResource = new oci.waas.AddressList("addressListResource", {
addresses: ["string"],
compartmentId: "string",
displayName: "string",
definedTags: {
string: "string",
},
freeformTags: {
string: "string",
},
});
type: oci:Waas:AddressList
properties:
addresses:
- string
compartmentId: string
definedTags:
string: string
displayName: string
freeformTags:
string: string
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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The AddressList resource accepts the following input properties:
- Addresses List<string>
- (Updatable) A list of IP addresses or CIDR notations.
- Compartment
Id string - (Updatable) The OCID of the compartment in which to create the address list.
- Display
Name string - (Updatable) A user-friendly name for the address list.
- Dictionary<string, string>
- (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"} - Dictionary<string, string>
(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.
- Compartment
Id string - (Updatable) The OCID of the compartment in which to create the address list.
- Display
Name string - (Updatable) A user-friendly name for the address list.
- map[string]string
- (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"} - map[string]string
(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.
- compartment
Id String - (Updatable) The OCID of the compartment in which to create the address list.
- display
Name String - (Updatable) A user-friendly name for the address list.
- Map<String,String>
- (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"} - Map<String,String>
(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.
- compartment
Id string - (Updatable) The OCID of the compartment in which to create the address list.
- display
Name string - (Updatable) A user-friendly name for the address list.
- {[key: string]: string}
- (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"} - {[key: string]: string}
(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.
- Mapping[str, str]
- (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"} - Mapping[str, str]
(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.
- compartment
Id String - (Updatable) The OCID of the compartment in which to create the address list.
- display
Name String - (Updatable) A user-friendly name for the address list.
- Map<String>
- (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"} - Map<String>
(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:
- Address
Count 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.
- Time
Created string - The date and time the address list was created, expressed in RFC 3339 timestamp format.
- Address
Count 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.
- Time
Created string - The date and time the address list was created, expressed in RFC 3339 timestamp format.
- address
Count 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.
- time
Created String - The date and time the address list was created, expressed in RFC 3339 timestamp format.
- address
Count 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.
- time
Created 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.
- address
Count 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.
- time
Created 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, str]] = None,
display_name: Optional[str] = None,
freeform_tags: Optional[Mapping[str, str]] = None,
state: Optional[str] = None,
time_created: Optional[str] = None) -> AddressListfunc 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)resources: _: type: oci:Waas:AddressList get: id: ${id}- 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.
- Address
Count double - The total number of unique IP addresses in the address list.
- Addresses List<string>
- (Updatable) A list of IP addresses or CIDR notations.
- Compartment
Id string - (Updatable) The OCID of the compartment in which to create the address list.
- Dictionary<string, string>
- (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 string - (Updatable) A user-friendly name for the address list.
- Dictionary<string, string>
(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.
- Time
Created string - The date and time the address list was created, expressed in RFC 3339 timestamp format.
- Address
Count float64 - The total number of unique IP addresses in the address list.
- Addresses []string
- (Updatable) A list of IP addresses or CIDR notations.
- Compartment
Id string - (Updatable) The OCID of the compartment in which to create the address list.
- map[string]string
- (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 string - (Updatable) A user-friendly name for the address list.
- map[string]string
(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.
- Time
Created string - The date and time the address list was created, expressed in RFC 3339 timestamp format.
- address
Count Double - The total number of unique IP addresses in the address list.
- addresses List<String>
- (Updatable) A list of IP addresses or CIDR notations.
- compartment
Id String - (Updatable) The OCID of the compartment in which to create the address list.
- Map<String,String>
- (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 String - (Updatable) A user-friendly name for the address list.
- Map<String,String>
(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.
- time
Created String - The date and time the address list was created, expressed in RFC 3339 timestamp format.
- address
Count number - The total number of unique IP addresses in the address list.
- addresses string[]
- (Updatable) A list of IP addresses or CIDR notations.
- compartment
Id string - (Updatable) The OCID of the compartment in which to create the address list.
- {[key: string]: string}
- (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 string - (Updatable) A user-friendly name for the address list.
- {[key: string]: string}
(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.
- time
Created 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.
- Mapping[str, str]
- (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.
- Mapping[str, str]
(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.
- address
Count Number - The total number of unique IP addresses in the address list.
- addresses List<String>
- (Updatable) A list of IP addresses or CIDR notations.
- compartment
Id String - (Updatable) The OCID of the compartment in which to create the address list.
- Map<String>
- (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 String - (Updatable) A user-friendly name for the address list.
- Map<String>
(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.
- time
Created 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
ociTerraform Provider.