@cdk-x/core
    Preparing search index...

    Interface IProviderResourceOptions

    interface IProviderResourceOptions {
        condition?: ProviderResourceCondition;
        creationPolicy?: ProviderCreatePolicy;
        deletionPolicy?: ProviderDeletionPolicy;
        description?: string;
        metadata?: { [key: string]: unknown };
        updatePolicy?: ProviderUpdatePolicy;
        updateReplacePolicy?: ProviderDeletionPolicy;
        version?: string;
    }
    Index

    Properties

    condition? creationPolicy? deletionPolicy? description? metadata? updatePolicy? updateReplacePolicy? version?

    Properties

    condition?: ProviderResourceCondition

    A condition to associate with this resource. When set, the resource is only included in the synthesized output if the condition evaluates to true.

    creationPolicy?: ProviderCreatePolicy

    Configures the creation policy for this resource. Prevents the resource from reaching creation-complete until the Engine receives the specified number of success signals or the timeout is exceeded.

    deletionPolicy?: ProviderDeletionPolicy

    Controls what happens to this resource when it is removed from the stack. Maps to the underlying provider's deletion behaviour.

    description?: string

    A human-readable description for this resource. Informational only — not passed to the underlying provider resource.

    metadata?: { [key: string]: unknown }

    Arbitrary metadata associated with this resource. Not the same as construct metadata.

    updatePolicy?: ProviderUpdatePolicy

    Provider-specific update policy configuration. The shape of this object is defined by the individual provider.

    updateReplacePolicy?: ProviderDeletionPolicy

    Controls what happens to the existing physical resource when it is replaced during a stack update operation.

    version?: string

    The version of this resource. Usage is provider-specific.

    Settings

    Member Visibility

    On This Page

    Properties