Skip to content

CreateVirtualGatewayInput

Source code in docs_src/capo_app_mesh/types/create_virtual_gateway_input.py
class CreateVirtualGatewayInput(TypedDict, closed=True):
    virtual_gateway_name: "capo_app_mesh.types.resource_name.ResourceName"
    """<p>The name to use for the virtual gateway.</p>"""
    mesh_name: "capo_app_mesh.types.resource_name.ResourceName"
    """<p>The name of the service mesh to create the virtual gateway in.</p>"""
    spec: "capo_app_mesh.types.virtual_gateway_spec.VirtualGatewaySpec"
    """<p>The virtual gateway specification to apply.</p>"""
    tags: NotRequired["capo_app_mesh.types.tag_list.TagList"]
    """<p>Optional metadata that you can apply to the virtual gateway to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.</p>"""
    client_token: NotRequired["str"]
    """<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.</p>"""
    mesh_owner: NotRequired["capo_app_mesh.types.account_id.AccountId"]
    """<p>The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then the account that you specify must share the mesh with your account before you can create the resource in the service mesh. For more information about mesh sharing, see <a href="https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html">Working with shared meshes</a>.</p>"""

client_token instance-attribute

client_token: NotRequired[str]

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.

mesh_name instance-attribute

mesh_name: ResourceName

The name of the service mesh to create the virtual gateway in.

mesh_owner instance-attribute

mesh_owner: NotRequired[AccountId]

The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then the account that you specify must share the mesh with your account before you can create the resource in the service mesh. For more information about mesh sharing, see Working with shared meshes.

spec instance-attribute

The virtual gateway specification to apply.

tags instance-attribute

tags: NotRequired[TagList]

Optional metadata that you can apply to the virtual gateway to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

virtual_gateway_name instance-attribute

virtual_gateway_name: ResourceName

The name to use for the virtual gateway.