Skip to content

Alias

Source code in docs_src/capo_fsx/types/alias.py
class Alias(TypedDict, closed=True):
    name: NotRequired["capo_fsx.types.alternate_dns_name.AlternateDNSName"]
    """<p>The name of the DNS alias. The alias name has to meet the following requirements:</p> <ul> <li> <p>Formatted as a fully-qualified domain name (FQDN), <code>hostname.domain</code>, for example, <code>accounting.example.com</code>.</p> </li> <li> <p>Can contain alphanumeric characters, the underscore (_), and the hyphen (-).</p> </li> <li> <p>Cannot start or end with a hyphen.</p> </li> <li> <p>Can start with a numeric.</p> </li> </ul> <p>For DNS names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes.</p>"""
    lifecycle: NotRequired["capo_fsx.types.alias_lifecycle.AliasLifecycle"]
    """<p>Describes the state of the DNS alias.</p> <ul> <li> <p>AVAILABLE - The DNS alias is associated with an Amazon FSx file system.</p> </li> <li> <p>CREATING - Amazon FSx is creating the DNS alias and associating it with the file system.</p> </li> <li> <p>CREATE_FAILED - Amazon FSx was unable to associate the DNS alias with the file system.</p> </li> <li> <p>DELETING - Amazon FSx is disassociating the DNS alias from the file system and deleting it.</p> </li> <li> <p>DELETE_FAILED - Amazon FSx was unable to disassociate the DNS alias from the file system.</p> </li> </ul>"""

lifecycle instance-attribute

lifecycle: NotRequired[AliasLifecycle]

Describes the state of the DNS alias.

  • AVAILABLE - The DNS alias is associated with an Amazon FSx file system.

  • CREATING - Amazon FSx is creating the DNS alias and associating it with the file system.

  • CREATE_FAILED - Amazon FSx was unable to associate the DNS alias with the file system.

  • DELETING - Amazon FSx is disassociating the DNS alias from the file system and deleting it.

  • DELETE_FAILED - Amazon FSx was unable to disassociate the DNS alias from the file system.

name instance-attribute

name: NotRequired[AlternateDNSName]

The name of the DNS alias. The alias name has to meet the following requirements:

  • Formatted as a fully-qualified domain name (FQDN), hostname.domain, for example, accounting.example.com.

  • Can contain alphanumeric characters, the underscore (_), and the hyphen (-).

  • Cannot start or end with a hyphen.

  • Can start with a numeric.

For DNS names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes.