Type alias CreateResourceOptions<TParameters, TItem>

CreateResourceOptions<TParameters, TItem>: {
    assignName: ResourceNameAssigner<TItem>;
    base64Tobase64url: Transcoder;
    clients: CreateResourceClients;
    config: CreateResourceConfig;
    exceptions: CreateResourceExceptions;
    handleError?: CreateResourceErrorHandler;
    idempotencyKey: string | undefined;
    name: string | undefined;
    namespace: string;
    parameters: TParameters;
    productName: string;
    resourceName: string;
}

Type Parameters

  • TParameters extends ResourceParameters

  • TItem

Type declaration

  • assignName: ResourceNameAssigner<TItem>

    Called to assign the customer-given name of the resource to an output property.

  • base64Tobase64url: Transcoder

    A base64 to base64url transcoder.

  • clients: CreateResourceClients

    The required AWS clients.

  • config: CreateResourceConfig

    The required SDK client config.

  • exceptions: CreateResourceExceptions

    SDK exception classes for each of the common errors.

  • Optional handleError?: CreateResourceErrorHandler

    Called when an unhandled error is thrown. Can either throw an error or return.

  • idempotencyKey: string | undefined

    Passed to AWS SDK calls where possible.

  • name: string | undefined

    The customer-provided name of the resource.

  • namespace: string

    Prefix for Service Catalog provisioned product names, for example: ff.

  • parameters: TParameters

    The Service Catalog provisioning parameters. Properties with an undefined value are omitted.

  • productName: string

    The name of the Stedi product, for example functions.

  • resourceName: string

    The name of the Stedi product resource, for example function.

Settings

Member Visibility

Theme