CreateMailServerRequest

pydantic model openapi_client.models.create_mail_server_request.CreateMailServerRequest

CreateMailServerRequest

Fields:
field server_name: StrictStr [Required] (alias 'ServerName')

Display name. Must be a string starting with a word character. Duplicate names return IPV-1018.

Constraints:
  • strict = True

field server_description: StrictStr [Required] (alias 'ServerDescription')

Description. Must be a string; empty is allowed.

Constraints:
  • strict = True

field port: Union[StrictFloat, StrictInt] [Required] (alias 'Port')

SMTP port. Must be a number from 0 to 65535.

field enabled: StrictBool [Required] (alias 'Enabled')

Whether to enable this server. True runs an SMTP test and disables other servers when the test succeeds.

Constraints:
  • strict = True

field user_name: StrictStr [Required] (alias 'UserName')

SMTP username. Letters, digits, underscore, hyphen, period, and @ only.

Constraints:
  • strict = True

field password: StrictStr [Required] (alias 'Password')

SMTP password. Stored in SSM, not DynamoDB. No whitespace.

Constraints:
  • strict = True

field account_email: StrictStr [Required] (alias 'AccountEmail')

From-address for this server.

Constraints:
  • strict = True

to_str()

Returns the string representation of the model using alias

Return type:

str

to_json()

Returns the JSON representation of the model using alias

Return type:

str

classmethod from_json(json_str)

Create an instance of CreateMailServerRequest from a JSON string

Return type:

Optional[Self]

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

Return type:

Dict[str, Any]

classmethod from_dict(obj)

Create an instance of CreateMailServerRequest from a dict

Return type:

Optional[Self]