Skip to content

CreateInstanceRequest

Source code in docs_src/capo_supplychain/types/create_instance_request.py
class CreateInstanceRequest(TypedDict, closed=True):
    instance_name: NotRequired["capo_supplychain.types.instance_name.InstanceName"]
    """<p>The AWS Supply Chain instance name.</p>"""
    instance_description: NotRequired[
        "capo_supplychain.types.instance_description.InstanceDescription"
    ]
    """<p>The AWS Supply Chain instance description.</p>"""
    kms_key_arn: NotRequired["capo_supplychain.types.kms_key_arn.KmsKeyArn"]
    """<p>The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. This is required if you do not want to use the Amazon Web Services owned KMS key. If you don't provide anything here, AWS Supply Chain uses the Amazon Web Services owned KMS key.</p>"""
    web_app_dns_domain: NotRequired[
        "capo_supplychain.types.instance_web_app_dns_domain.InstanceWebAppDnsDomain"
    ]
    """<p>The DNS subdomain of the web app. This would be "example" in the URL "example.scn.global.on.aws". You can set this to a custom value, as long as the domain isn't already being used by someone else. The name may only include alphanumeric characters and hyphens.</p>"""
    tags: NotRequired["capo_supplychain.types.tag_map.TagMap"]
    """<p>The Amazon Web Services tags of an instance to be created.</p>"""
    client_token: NotRequired["capo_supplychain.types.client_token.ClientToken"]
    """<p>The client token for idempotency.</p>"""

client_token instance-attribute

client_token: NotRequired[ClientToken]

The client token for idempotency.

instance_description instance-attribute

instance_description: NotRequired[InstanceDescription]

The AWS Supply Chain instance description.

instance_name instance-attribute

instance_name: NotRequired[InstanceName]

The AWS Supply Chain instance name.

kms_key_arn instance-attribute

kms_key_arn: NotRequired[KmsKeyArn]

The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. This is required if you do not want to use the Amazon Web Services owned KMS key. If you don't provide anything here, AWS Supply Chain uses the Amazon Web Services owned KMS key.

tags instance-attribute

tags: NotRequired[TagMap]

The Amazon Web Services tags of an instance to be created.

web_app_dns_domain instance-attribute

web_app_dns_domain: NotRequired[InstanceWebAppDnsDomain]

The DNS subdomain of the web app. This would be "example" in the URL "example.scn.global.on.aws". You can set this to a custom value, as long as the domain isn't already being used by someone else. The name may only include alphanumeric characters and hyphens.