1. Packages
  2. Constellix Provider
  3. API Docs
  4. ContactLists
constellix 0.4.6 published on Friday, Mar 7, 2025 by constellix

constellix.ContactLists

Explore with Pulumi AI

Create ContactLists Resource

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

Constructor syntax

new ContactLists(name: string, args: ContactListsArgs, opts?: CustomResourceOptions);
@overload
def ContactLists(resource_name: str,
                 args: ContactListsArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def ContactLists(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 email_addresses: Optional[Sequence[str]] = None,
                 contact_lists_id: Optional[str] = None,
                 name: Optional[str] = None)
func NewContactLists(ctx *Context, name string, args ContactListsArgs, opts ...ResourceOption) (*ContactLists, error)
public ContactLists(string name, ContactListsArgs args, CustomResourceOptions? opts = null)
public ContactLists(String name, ContactListsArgs args)
public ContactLists(String name, ContactListsArgs args, CustomResourceOptions options)
type: constellix:ContactLists
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ContactListsArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ContactListsArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ContactListsArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ContactListsArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ContactListsArgs
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 contactListsResource = new Constellix.ContactLists("contactListsResource", new()
{
    EmailAddresses = new[]
    {
        "string",
    },
    ContactListsId = "string",
    Name = "string",
});
Copy
example, err := constellix.NewContactLists(ctx, "contactListsResource", &constellix.ContactListsArgs{
	EmailAddresses: pulumi.StringArray{
		pulumi.String("string"),
	},
	ContactListsId: pulumi.String("string"),
	Name:           pulumi.String("string"),
})
Copy
var contactListsResource = new ContactLists("contactListsResource", ContactListsArgs.builder()
    .emailAddresses("string")
    .contactListsId("string")
    .name("string")
    .build());
Copy
contact_lists_resource = constellix.ContactLists("contactListsResource",
    email_addresses=["string"],
    contact_lists_id="string",
    name="string")
Copy
const contactListsResource = new constellix.ContactLists("contactListsResource", {
    emailAddresses: ["string"],
    contactListsId: "string",
    name: "string",
});
Copy
type: constellix:ContactLists
properties:
    contactListsId: string
    emailAddresses:
        - string
    name: string
Copy

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

EmailAddresses This property is required. List<string>
ContactListsId string
Name string
EmailAddresses This property is required. []string
ContactListsId string
Name string
emailAddresses This property is required. List<String>
contactListsId String
name String
emailAddresses This property is required. string[]
contactListsId string
name string
email_addresses This property is required. Sequence[str]
contact_lists_id str
name str
emailAddresses This property is required. List<String>
contactListsId String
name String

Outputs

All input properties are implicitly available as output properties. Additionally, the ContactLists 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 ContactLists Resource

Get an existing ContactLists 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?: ContactListsState, opts?: CustomResourceOptions): ContactLists
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        contact_lists_id: Optional[str] = None,
        email_addresses: Optional[Sequence[str]] = None,
        name: Optional[str] = None) -> ContactLists
func GetContactLists(ctx *Context, name string, id IDInput, state *ContactListsState, opts ...ResourceOption) (*ContactLists, error)
public static ContactLists Get(string name, Input<string> id, ContactListsState? state, CustomResourceOptions? opts = null)
public static ContactLists get(String name, Output<String> id, ContactListsState state, CustomResourceOptions options)
resources:  _:    type: constellix:ContactLists    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
ContactListsId string
EmailAddresses List<string>
Name string
ContactListsId string
EmailAddresses []string
Name string
contactListsId String
emailAddresses List<String>
name String
contactListsId string
emailAddresses string[]
name string
contactListsId String
emailAddresses List<String>
name String

Package Details

Repository
constellix constellix/terraform-provider-constellix
License
Notes
This Pulumi package is based on the constellix Terraform Provider.