Skip to main content

AwsAccountGroup

Aws Account Group resource for Zscaler Cloud & Branch Connector.

Resource operations

This resource supports the following standard methods: create(), load(), update(), delete(). They operate on the instance state — set properties with dot notation, then call the method with no arguments. Any other action listed below is a custom action that takes explicit keyword arguments and returns a value.

Quick Start​

import zssdk
import logging

# Enable debug logging for AwsAccountGroup
logging.getLogger('zssdk.ztw').setLevel(logging.DEBUG)
logging.basicConfig(level=logging.DEBUG)

session = zssdk.Session(
vanity_domain="your-vanity-domain",
client_id="your-client-id",
client_secret="your-client-secret",
)

# Get a specific AwsAccountGroup
resource = session.ztw.AwsAccountGroup(id="your-resource-id")
resource.load()
print(resource)

# Debug output shows HTTP request/response details

Identifiers​

NameTypeDescription
idstringUnique identifier

Actions​

create()​

Creates a new AwsAccountGroup. Set properties on the resource instance, then call create() — this method takes no arguments.

Properties for creation:

NameTypeRequiredDescription
cloud_connector_groupsEntityReferenceWrapperCollectionNo-
cloud_typestringYes-
descriptionstringNo-
flagsintegerNo-
namestringYes-
public_cloud_accountsEntityReferenceWrapperCollectionYes-

Returns: AwsAccountGroup

Example:

resource = session.ztw.AwsAccountGroup()
resource.cloud_type = "value"
resource.name = "example-name"
resource.public_cloud_accounts = [{"association_time": 3600, "deleted": True, "extensions": {"key1": "value", "key2": "value"}, "external_id": "resource-id"}]
resource.create()
print(f"Created with ID: {resource.id}")

delete()​

Deletes a AwsAccountGroup by id. Only the id identifier is required; delete() takes no other arguments.

Example:

resource = session.ztw.AwsAccountGroup(id="your-resource-id")
resource.delete()

get_account_group_count()​

Example:

resource = session.ztw.AwsAccountGroup()
result = resource.get_account_group_count()
print(result)

load()​

Fetches an existing AwsAccountGroup by id. Only the id identifier is required; load() takes no other arguments.

Returns: AwsAccountGroup

Example:

resource = session.ztw.AwsAccountGroup(id="your-resource-id")
resource.load()
print(resource.name)

update()​

Updates an existing AwsAccountGroup. Call load() first, modify properties, then call update() — this method takes no arguments.

Properties for update:

NameTypeRequiredDescription
cloud_connector_groupsEntityReferenceWrapperCollectionNo-
cloud_typestringYes-
descriptionstringNo-
flagsintegerNo-
namestringYes-
public_cloud_accountsEntityReferenceWrapperCollectionYes-

Returns: AwsAccountGroup

Example:

resource = session.ztw.AwsAccountGroup(id="your-resource-id")
resource.load()
resource.name = "Updated value"
resource.update()

Attributes​

NameTypeRequiredDescription
cloud_connector_groupsEntityReferenceWrapperCollectionNo-
cloud_typestringYes-
descriptionstringNo-
flagsintegerNo-
idintegerYes-
namestringYes-
public_cloud_accountsEntityReferenceWrapperCollectionYes-