SAMCustomDomain

smarter.models.sam.customdomain

SAM model of the CustomDomain kind, generated from the Smarter platform’s JSON Schema.

Do not edit: run scripts/generate_sam_models.py. See smarter.models.sam.

class smarter.models.sam.customdomain.SAMCustomDomainMetadata

Bases: smarter.models.sam.base.SAMModel

Smarter API CustomDomain Manifest - Metadata class.

annotations: None | list[dict[str, str | int | float | bool | datetime.date | datetime.datetime | Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern='^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$')] | uuid.UUID | bytes | list | dict[str, Any]]]

The manifest annotations.

Used for storing arbitrary metadata as

key-value pairs. Example: [{‘smarter.sh/test-manifest/project-name’: ‘Scooby dooby do’}]. The key should be a valid url-friendly string. The value accepts multi-line string values (YAML block scalars) and various scalar types including str, int, float, bool, datetime.date, datetime.datetime, decimal.Decimal, uuid.UUID, bytes, list, dict.

description: str | None

The description for this resource.

Be brief. Keep it under 255 characters.

name: str

The camelCase name of the manifest resource.

tags: list[str] | None

The tags of the manifest.

Used for generic resource categorization and search. Example: [‘tag1’, ‘tag2’]

version: str | None

The semantic version of the manifest.

Example: 0.1.0

class smarter.models.sam.customdomain.SAMCustomDomainSpecConfig

Bases: smarter.models.sam.base.SAMModel

Smarter API CustomDomain Manifest - CustomDomain.spec.config.

domainName: str

CustomDomain.spec.config.domainName[str].

Required. The domain name, e.g. ‘llmclients.example.com’. It cannot be changed once the domain has been registered.

class smarter.models.sam.customdomain.SAMDependency

Bases: smarter.models.sam.base.SAMModel

A resource that depends on the resource that a manifest describes.

kind: str

Kind[String]: The SAM kind of the resource that depends on this resource, e.g. LLMClient.

Read only.

name: str

Name[String]: The name of the resource that depends on this resource.

Read only.

class smarter.models.sam.customdomain.SAMCustomDomainSpec

Bases: smarter.models.sam.base.SAMModel

Smarter API CustomDomain Manifest - CustomDomain.spec.

config: SAMCustomDomainSpecConfig

CustomDomain.spec.config[object].

Required. The configuration of the CustomDomain.

class smarter.models.sam.customdomain.SAMCustomDomainStatus

Bases: smarter.models.sam.base.SAMModel

Smarter API CustomDomain Manifest - Status class.

Read only. Besides ownership, it reports the domain’s AWS Route53 hosted zone, whether the domain is verified, and its DNS records. The LLMClient that uses it is reported in dependencies.

accountNumber: str

CustomDomain.status.accountNumber: The account owner of this CustomDomain.

Read only.

awsHostedZoneId: str | None

CustomDomain.status.awsHostedZoneId: The AWS Route53 hosted zone of this CustomDomain, once it is registered with smarter deploy.

Read only.

created: datetime

The date in which this resource was created.

Read only.

dependencies: list[smarter.models.sam.customdomain.SAMDependency] | None

Dependencies[List]: The resources that depend on this resource, and that must be deleted, or stop referring to it, before it can be deleted.

Lists only the resources that you can read. Read only.

dnsRecords: list[str] | None

CustomDomain.status.dnsRecords: The DNS records of this CustomDomain.

Read only.

modified: datetime

The date in which this resource was most recently changed.

Read only.

recordLocator: str

RecordLocator[String]: An optional identifier used to locate the resource record associated with this manifest.

Read only.

username: str

CustomDomain.status.username: The Smarter user who created this CustomDomain.

Read only.

verificationMessage: str | None

CustomDomain.status.verificationMessage: Why the domain is not verified yet, or why its verification failed.

Read only.

verificationStatus: str | None

CustomDomain.status.verificationStatus: Not Verified, Verifying, Verified or Failed.

The domain is Verified when its NS records are delegated to its hosted zone, and its TLS certificate is issued. Read only.

verifiedAt: datetime.datetime | None

CustomDomain.status.verifiedAt: When the domain was verified.

Read only.

class smarter.models.sam.customdomain.SAMCustomDomain

Bases: smarter.models.sam.base.SAMModel

Smarter API Manifest - CustomDomain.

apiVersion: str

ApiVersion[String]: Required.

The API version of the AbstractSAMBase.

kind: str

Kind[String]: Required.

The kind of resource described by the manifest.

metadata: SAMCustomDomainMetadata

CustomDomain.metadata[obj]: Required, the CustomDomain metadata.

spec: SAMCustomDomainSpec

CustomDomain.spec[obj]: Required, the CustomDomain specification.

status: smarter.models.sam.customdomain.SAMCustomDomainStatus | None

CustomDomain.status[obj]: Optional, Read-only.

Stateful status information about the CustomDomain.