Builder

A builder that can build an AwsRequest

Hierarchy

Builder

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Builder(): Builder

- Defined in core/services/aws/src/AwsRequest.ts:38
Constructs a new builder for an AWS request.

Returns Builder

Properties

Private action

action: string

Private args

args: object

Private region

region: string

Private service

service: string

Methods

build

build(): AwsRequest

- Defined in core/services/aws/src/AwsRequest.ts:96
Builds, validates, and returns the AwsRequest.

Returns AwsRequest

the built AWS request.

withAction

withAction(action: string): this

- Defined in core/services/aws/src/AwsRequest.ts:64
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

- Defined in core/services/aws/src/AwsRequest.ts:86
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

- Defined in core/services/aws/src/AwsRequest.ts:75
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

- Defined in core/services/aws/src/AwsRequest.ts:53
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.

Generated using TypeDoc