Skip to content

/AWS1/CL_SPC=>CREATEINSTANCE()

About CreateInstance

Enables you to programmatically create an Amazon Web Services Supply Chain instance by applying KMS keys and relevant information associated with the API without using the Amazon Web Services console.

This is an asynchronous operation. Upon receiving a CreateInstance request, Amazon Web Services Supply Chain immediately returns the instance resource, instance ID, and the initializing state while simultaneously creating all required Amazon Web Services resources for an instance creation. You can use GetInstance to check the status of the instance. If the instance results in an unhealthy state, you need to check the error message, delete the current instance, and recreate a new one based on the mitigation from the error message.

Method Signature

IMPORTING

Optional arguments:

IV_INSTANCENAME TYPE /AWS1/SPCINSTANCENAME /AWS1/SPCINSTANCENAME

The AWS Supply Chain instance name.

IV_INSTANCEDESCRIPTION TYPE /AWS1/SPCINSTANCEDESCRIPTION /AWS1/SPCINSTANCEDESCRIPTION

The AWS Supply Chain instance description.

IV_KMSKEYARN TYPE /AWS1/SPCKMSKEYARN /AWS1/SPCKMSKEYARN

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.

IV_WEBAPPDNSDOMAIN TYPE /AWS1/SPCINSTWEBAPPDNSDOMAIN /AWS1/SPCINSTWEBAPPDNSDOMAIN

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.

IT_TAGS TYPE /AWS1/CL_SPCTAGMAP_W=>TT_TAGMAP TT_TAGMAP

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

IV_CLIENTTOKEN TYPE /AWS1/SPCCLIENTTOKEN /AWS1/SPCCLIENTTOKEN

The client token for idempotency.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_SPCCREATEINSTRESPONSE /AWS1/CL_SPCCREATEINSTRESPONSE

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC