Skip to content

Connecthealth  >  Operations  >  create_domain

create_domain

Operation

create_domain async

create_domain(input: CreateDomainInput, plugins: list[Plugin] | None = None) -> CreateDomainOutput

Creates a new Domain for managing HealthAgent resources.

Parameters:

Name Type Description Default
input CreateDomainInput

An instance of CreateDomainInput.

required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
CreateDomainOutput

An instance of CreateDomainOutput.

Input

CreateDomainInput dataclass

Dataclass for CreateDomainInput structure.

Attributes

kms_key_arn class-attribute instance-attribute
kms_key_arn: str | None = None

The ARN of the KMS key to use for encrypting data in this Domain.

name class-attribute instance-attribute
name: str | None = None

The name for the new Domain.

tags class-attribute instance-attribute
tags: dict[str, str] | None = None

Tags to associate with the Domain.

web_app_setup_configuration class-attribute instance-attribute
web_app_setup_configuration: CreateWebAppConfiguration | None = None

Configuration for the Domain web application. Optional, but if provided all fields are required.

Output

CreateDomainOutput dataclass

Dataclass for CreateDomainOutput structure.

Attributes

arn instance-attribute
arn: str
created_at instance-attribute
created_at: datetime
domain_id instance-attribute
domain_id: str
encryption_context class-attribute instance-attribute
encryption_context: EncryptionContext | None = None
kms_key_arn class-attribute instance-attribute
kms_key_arn: str | None = None
name instance-attribute
name: str
status instance-attribute
status: DomainStatus
web_app_configuration class-attribute instance-attribute
web_app_configuration: WebAppConfiguration | None = None
web_app_url class-attribute instance-attribute
web_app_url: str | None = None