Fork me on GitHub

Package @pulumi/cloud-aws

Node.js:

var cloudAws = require("@pulumi/cloud-aws");

ES6 modules:

import * as cloudAws from "@pulumi/cloud-aws";

Index

api.ts function.ts service.ts sns.ts table.ts timer.ts topic.ts utils.ts

Modules

class API

constructor

new API(name: string)

method all

public all(path: string, handlers: cloud.RouteHandler[]): void

method attachCustomDomain

public attachCustomDomain(domain: Domain): void

method delete

public delete(path: string, handlers: cloud.RouteHandler[]): void

method get

public get(path: string, handlers: cloud.RouteHandler[]): void

method options

public options(path: string, handlers: cloud.RouteHandler[]): void

method post

public post(path: string, handlers: cloud.RouteHandler[]): void

method proxy

public proxy(path: string, target: string | pulumi.Output<cloud.Endpoint>): void

method publish

public publish(): HttpDeployment

method put

public put(path: string, handlers: cloud.RouteHandler[]): void

method route

public route(method: string, path: string, handlers: cloud.RouteHandler[]): void

method static

public static(path: string, localPath: string, options?: cloud.ServeStaticOptions): void

property deployment

public deployment?: HttpDeployment;

class Function

constructor

new Function(name: string, handler: aws.serverless.Handler, opts?: pulumi.ResourceOptions)

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

method registerOutputs

protected registerOutputs(outputs: Inputs | undefined): void

property handler

public handler: aws.serverless.Handler;

property lambda

public lambda: aws.lambda.Function;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class HostPathVolume

constructor

new HostPathVolume(path: string)

method getHostPath

getHostPath(): string

method getVolumeName

getVolumeName(): string

property kind

public kind: cloud.VolumeKind;

property path

public path: string;

class HttpDeployment

constructor

new HttpDeployment(name: string, staticRoutes: StaticRoute[], proxyRoutes: ProxyRoute[], routes: Route[], customDomains: Domain[], opts?: pulumi.ResourceOptions)

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

method registerOutputs

protected registerOutputs(outputs: Inputs | undefined): void

property customDomainNames

public customDomainNames: pulumi.Output<string>[];

property customDomains

public customDomains: aws.apigateway.DomainName[];

property routes

public routes: Route[];

property staticRoutes

public staticRoutes: StaticRoute[];

property url

public url: pulumi.Output<string>;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class Service

constructor

new Service(name: string, args: cloud.ServiceArguments, opts?: pulumi.ResourceOptions)

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method getTaskRole

public static getTaskRole(): aws.iam.Role

method isInstance

static isInstance(obj: any): boolean

method registerOutputs

protected registerOutputs(outputs: Inputs | undefined): void

property cluster

public cluster: CloudCluster;

property containers

public containers: cloud.Containers;

property defaultEndpoint

public defaultEndpoint: pulumi.Output<Endpoint>;

property ecsService

public ecsService: aws.ecs.Service;

property endpoints

public endpoints: pulumi.Output<Endpoints>;

property getEndpoint

public getEndpoint: { ... };

property name

public name: string;

property replicas

public replicas: number;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class SharedVolume

constructor

new SharedVolume(name: string, opts?: pulumi.ResourceOptions)

method getHostPath

getHostPath(): string

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method getVolumeName

getVolumeName(): string

method isInstance

static isInstance(obj: any): boolean

method registerOutputs

protected registerOutputs(outputs: Inputs | undefined): void

property kind

public kind: cloud.VolumeKind;

property name

public name: string;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class Table

constructor

new Table(name: string, primaryKey?: pulumi.Input<string>, primaryKeyType?: pulumi.Input<cloud.PrimaryKeyType>, opts?: pulumi.ResourceOptions)

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

method registerOutputs

protected registerOutputs(outputs: Inputs | undefined): void

property delete

public delete: { ... };

property dynamodbTable

public dynamodbTable: aws.dynamodb.Table;

property get

public get: { ... };

property insert

public insert: { ... };

property primaryKey

public primaryKey: pulumi.Output<string>;

property primaryKeyType

public primaryKeyType: pulumi.Output<string>;

property scan

public scan: { ... };

property update

public update: { ... };

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class Task

A Task represents a container which can be [run] dynamically whenever (and as many times as) needed.

constructor

new Task(name: string, container: cloud.Container, opts?: pulumi.ResourceOptions)

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method getTaskRole

public static getTaskRole(): aws.iam.Role

method isInstance

static isInstance(obj: any): boolean

method registerOutputs

protected registerOutputs(outputs: Inputs | undefined): void

property cluster

public cluster: CloudCluster;

property run

public run: { ... };

property taskDefinition

public taskDefinition: aws.ecs.TaskDefinition;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class Topic

constructor

new Topic(name: string, opts?: pulumi.ResourceOptions)

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

method registerOutputs

protected registerOutputs(outputs: Inputs | undefined): void

method subscribe

public subscribe(name: string, handler: { ... }): void

property publish

public publish: { ... };

property subscriptions

public subscriptions: aws.sns.TopicSubscription[];

property topic

public topic: aws.sns.Topic;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

function apply

apply<T,U>(val: Record<string, T>, func: { ... }): Record<string, U>

function createSubscription

createSubscription(resName: string, topic: aws.sns.Topic, handler: { ... }): aws.sns.TopicSubscription

function cron

cron(name: string, cronTab: string, handler: timer.Action, opts?: pulumi.ResourceOptions): void

function daily

daily(name: string, scheduleOrHandler: timer.DailySchedule | timer.Action, handlerOrOptions?: timer.Action | pulumi.ResourceOptions, opts?: pulumi.ResourceOptions): void

function hourly

hourly(name: string, scheduleOrHandler: timer.HourlySchedule | timer.Action, handlerOrOptions?: timer.Action | pulumi.ResourceOptions, opts?: pulumi.ResourceOptions): void

function interval

interval(name: string, options: timer.IntervalRate, handler: timer.Action, opts?: pulumi.ResourceOptions): void

function liftResource

liftResource<T>(resource: T): pulumi.Output<T>

function sha1hash

sha1hash(s: string): string

interface AWSDomain

property certificateArn

certificateArn: pulumi.Input<string>;

property domainName

domainName: string;

interface Endpoint

property hostname

hostname: string;

property loadBalancer

loadBalancer: aws.elasticloadbalancingv2.LoadBalancer;

property port

port: number;

interface ProxyRoute

property path

path: string;

property target

target: string | pulumi.Output<cloud.Endpoint>;

interface Route

property handlers

handlers: cloud.RouteHandler[];

property method

method: string;

property path

path: string;

interface SNSItem

property Message

Message: string;

property MessageAttributes

MessageAttributes: { ... };

property MessageId

MessageId: string;

property Signature

Signature: string;

property SignatureVersion

SignatureVersion: string;

property SigningCertUrl

SigningCertUrl: string;

property Subject

Subject: string;

property Timestamp

Timestamp: string;

property TopicArn

TopicArn: string;

property Type

Type: string;

property UnsubscribeUrl

UnsubscribeUrl: string;

interface SNSMessageAttribute

property Type

Type: string;

property Value

Value: string;

interface StaticRoute

property localPath

localPath: string;

property options

options: cloud.ServeStaticOptions;

property path

path: string;

interface Volume

method getHostPath

getHostPath(): any

method getVolumeName

getVolumeName(): any

property kind

kind: VolumeKind;

type Domain

type Domain = cloud.Domain | AWSDomain;

type Endpoints

type Endpoints = { ... };

type HttpEndpoint

type HttpEndpoint = API;