Options
All
  • Public
  • Public/Protected
  • All
Menu

Builder

A builder that can build an AwsRequest

Hierarchy

  • Builder

Index

Constructors

constructor

Properties

Private action

action: string

Private args

args: object

Private region

region: string

Private service

service: string

Methods

build

withAction

  • withAction(action: string): this
  • Sets the action within the AWS service to perform.

    Parameters

    • action: string

      the action within the AWS service to perform.

    Returns this

    the builder.

withArgs

  • withArgs(args: object): this
  • Sets the arguments that will be used in the action.

    Parameters

    • args: object

      the arguments that will be used in the action.

    Returns this

    the builder.

withRegion

  • withRegion(region: string): this
  • Sets the region that service in this request should be scoped to.

    Parameters

    • region: string

      the region that service in this request should be scoped to.

    Returns this

    the builder.

withService

  • withService(service: string): this
  • Sets the AWS service that the action in the request will be performed against.

    Parameters

    • service: string

      the AWS service that the action in the request will be performed against.

    Returns this

    the builder.

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc