Interface ResourceValidationArgs

name

opts

props

Optionalprovider

stackTags

type

urn

asType

• asType<TResource extends Resource, TArgs>(
      resourceClass: new (
          name: string,
          args: TArgs,
          ...rest: any[],
      ) => TResource,
  ): Unwrap<NonNullable<TArgs>> | undefined

  Returns the resource args for resourceClass if the type of this resource is the same as resourceClass, otherwise undefined.

  For example:

  const bucketArgs = args.AsType(aws.s3.Bucket);
  if (bucketArgs) {
      // ...
  }
  Copy

  Type Parameters

  • TResource extends Resource
  • TArgs

  Parameters

  • resourceClass: new (name: string, args: TArgs, ...rest: any[]) => TResource

  Returns Unwrap<NonNullable<TArgs>> | undefined

getConfig

• getConfig<T extends object>(): T

  Returns configuration for the policy.

  Type Parameters

  • T extends object

  Returns T

isType

• isType<TResource extends Resource>(
      resourceClass: new (...rest: any[]) => TResource,
  ): boolean

  Returns true if the type of this resource is the same as resourceClass.

  For example:

  if (args.isType(aws.s3.Bucket)) {
      // ...
  }
  Copy

  Type Parameters

  • TResource extends Resource

  Parameters

  • resourceClass: new (...rest: any[]) => TResource

  Returns boolean

notApplicable

• notApplicable(reason?: string): never

  Marks the policy as not applicable.

  Parameters

  • Optionalreason: string

    An optional reason why the policy is not applicable.

  Returns never