Package @pulumi/aws

The Amazon Web Services (AWS) provider package offers support for all AWS services and their properties. Services are exposed as types from modules such as ec2, ecs, lambda, and s3, among many others. Using this package allows you to programmatically declare instances of any AWS services using infrastructure as code, which Pulumi then uses to drive the AWS API.

If this is your first time using this package, these two resources may be helpful:

Use the navigation below to see detailed documentation, including sample code, for each of the supported AWS services.

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-aws repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-aws repo.

JavaScript TypeScript 
var aws = require("@pulumi/aws");

import * as aws from "@pulumi/aws";

Index â–¾

arn.ts getAmi.ts getAmiIds.ts getArn.ts getAutoscalingGroups.ts getAvailabilityZone.ts getAvailabilityZones.ts getBillingServiceAccount.ts getCallerIdentity.ts getCanonicalUserId.ts getElasticIp.ts getIpRanges.ts getPartition.ts getPrefixList.ts getRegion.ts provider.ts region.ts tags.ts utilities.ts utils.ts

Modules â–¾

class Provider 

extends ProviderResource

The provider type for the aws package. By default, resources use package-wide configuration settings, however an explicit Provider instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.

This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/index.html.markdown.

constructor 

new Provider(name: string, args?: ProviderArgs, opts?: pulumi.ResourceOptions)

Create a Provider resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method getProvider 

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance 

public static isInstance(obj: any): boolean

Returns true if the given object is an instance of Provider. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id 

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property urn 

urn: Output<URN>;

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

function getAmi 

getAmi(args: GetAmiArgs, opts?: pulumi.InvokeOptions): Promise<GetAmiResult>

Use this data source to get the ID of a registered AMI for use in other resources.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = pulumi.output(aws.getAmi({
    executableUsers: ["self"],
    filters: [
        {
            name: "name",
            values: ["myami-*"],
        },
        {
            name: "root-device-type",
            values: ["ebs"],
        },
        {
            name: "virtualization-type",
            values: ["hvm"],
        },
    ],
    mostRecent: true,
    nameRegex: "^myami-\\d{3}",
    owners: ["self"],
}));

This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/d/ami.html.markdown.

function getAmiIds 

getAmiIds(args: GetAmiIdsArgs, opts?: pulumi.InvokeOptions): Promise<GetAmiIdsResult>

Use this data source to get a list of AMI IDs matching the specified criteria.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const ubuntu = pulumi.output(aws.getAmiIds({
    filters: [{
        name: "name",
        values: ["ubuntu/images/ubuntu-*-*-amd64-server-*"],
    }],
    owners: ["099720109477"],
}));

This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/d/ami_ids.html.markdown.

function getArn 

getArn(args: GetArnArgs, opts?: pulumi.InvokeOptions): Promise<GetArnResult>

Parses an Amazon Resource Name (ARN) into its constituent parts.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const dbInstance = pulumi.output(aws.getArn({
    arn: "arn:aws:rds:eu-west-1:123456789012:db:mysql-db",
}));

This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/d/arn.html.markdown.

function getAutoscalingGroups 

getAutoscalingGroups(args?: GetAutoscalingGroupsArgs, opts?: pulumi.InvokeOptions): Promise<GetAutoscalingGroupsResult>

The Autoscaling Groups data source allows access to the list of AWS ASGs within a specific region. This will allow you to pass a list of AutoScaling Groups to other resources.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const groups = pulumi.output(aws.getAutoscalingGroups({
    filters: [
        {
            name: "key",
            values: ["Team"],
        },
        {
            name: "value",
            values: ["Pets"],
        },
    ],
}));
const slackNotifications = new aws.autoscaling.Notification("slack_notifications", {
    groupNames: groups.names,
    notifications: [
        "autoscaling:EC2_INSTANCE_LAUNCH",
        "autoscaling:EC2_INSTANCE_TERMINATE",
        "autoscaling:EC2_INSTANCE_LAUNCH_ERROR",
        "autoscaling:EC2_INSTANCE_TERMINATE_ERROR",
    ],
    topicArn: "TOPIC ARN",
});

This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/d/autoscaling_groups.html.markdown.

function getAvailabilityZone 

getAvailabilityZone(args?: GetAvailabilityZoneArgs, opts?: pulumi.InvokeOptions): Promise<GetAvailabilityZoneResult>

aws_availability_zone provides details about a specific availability zone (AZ) in the current region.

This can be used both to validate an availability zone given in a variable and to split the AZ name into its component parts of an AWS region and an AZ identifier letter. The latter may be useful e.g. for implementing a consistent subnet numbering scheme across several regions by mapping both the region and the subnet letter to network numbers.

This is different from the aws_availability_zones (plural) data source, which provides a list of the available zones.

Example Usage

The following example shows how this data source might be used to derive VPC and subnet CIDR prefixes systematically for an availability zone.

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const config = new pulumi.Config();
const azNumber = config.get("azNumber") || {
    a: 1,
    b: 2,
    c: 3,
    d: 4,
    e: 5,
    f: 6,
};
const regionNumber = config.get("regionNumber") || {
    "ap-northeast-1": 5,
    "eu-central-1": 4,
    "us-east-1": 1,
    "us-west-1": 2,
    "us-west-2": 3,
};

// Retrieve the AZ where we want to create network resources
// This must be in the region selected on the AWS provider.
const exampleAvailabilityZone = pulumi.output(aws.getAvailabilityZone({
    name: "eu-central-1a",
}));
// Create a VPC for the region associated with the AZ
const exampleVpc = new aws.ec2.Vpc("example", {
    cidrBlock: exampleAvailabilityZone.apply(exampleAvailabilityZone => (() => {
        throw "tf2pulumi error: NYI: call to cidrsubnet";
        return (() => { throw "NYI: call to cidrsubnet"; })();
    })()),
});
// Create a subnet for the AZ within the regional VPC
const exampleSubnet = new aws.ec2.Subnet("example", {
    cidrBlock: pulumi.all([exampleVpc.cidrBlock, exampleAvailabilityZone]).apply(([cidrBlock, exampleAvailabilityZone]) => (() => {
        throw "tf2pulumi error: NYI: call to cidrsubnet";
        return (() => { throw "NYI: call to cidrsubnet"; })();
    })()),
    vpcId: exampleVpc.id,
});

This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/d/availability_zone.html.markdown.

function getAvailabilityZones 

getAvailabilityZones(args?: GetAvailabilityZonesArgs, opts?: pulumi.InvokeOptions): Promise<GetAvailabilityZonesResult>

The Availability Zones data source allows access to the list of AWS Availability Zones which can be accessed by an AWS account within the region configured in the provider.

This is different from the aws_availability_zone (singular) data source, which provides some details about a specific availability zone.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

// Declare the data source
const available = pulumi.output(aws.getAvailabilityZones({
    state: "available",
}));
const primary = new aws.ec2.Subnet("primary", {
    availabilityZone: available.apply(available => available.names[0]),
});
const secondary = new aws.ec2.Subnet("secondary", {
    availabilityZone: available.apply(available => available.names[1]),
});

This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/d/availability_zones.html.markdown.

function getBillingServiceAccount 

getBillingServiceAccount(opts?: pulumi.InvokeOptions): Promise<GetBillingServiceAccountResult>

Use this data source to get the Account ID of the AWS Billing and Cost Management Service Account for the purpose of whitelisting in S3 bucket policy.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const main = pulumi.output(aws.getBillingServiceAccount({}));
const billingLogs = new aws.s3.Bucket("billing_logs", {
    acl: "private",
    policy: pulumi.interpolate`{
  "Id": "Policy",
  "Version": "2012-10-17",
  "Statement": [
    {
      "Action": [
        "s3:GetBucketAcl", "s3:GetBucketPolicy"
      ],
      "Effect": "Allow",
      "Resource": "arn:aws:s3:::my-billing-tf-test-bucket",
      "Principal": {
        "AWS": [
          "${main.arn}"
        ]
      }
    },
    {
      "Action": [
        "s3:PutObject"
      ],
      "Effect": "Allow",
      "Resource": "arn:aws:s3:::my-billing-tf-test-bucket/*",
      "Principal": {
        "AWS": [
          "${main.arn}"
        ]
      }
    }
  ]
}
`,
});

This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/d/billing_service_account.html.markdown.

function getCallerIdentity 

getCallerIdentity(opts?: pulumi.InvokeOptions): Promise<GetCallerIdentityResult>

This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/d/caller_identity.html.markdown.

function getCanonicalUserId 

getCanonicalUserId(opts?: pulumi.InvokeOptions): Promise<GetCanonicalUserIdResult>

This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/d/canonical_user_id.html.markdown.

function getElasticIp 

getElasticIp(args?: GetElasticIpArgs, opts?: pulumi.InvokeOptions): Promise<GetElasticIpResult>

aws_eip provides details about a specific Elastic IP.

Example Usage

Search By Allocation ID (VPC only)

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const byAllocationId = pulumi.output(aws.getElasticIp({
    id: "eipalloc-12345678",
}));

Search By Filters (EC2-Classic or VPC)

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const byFilter = pulumi.output(aws.getElasticIp({
    filters: [{
        name: "tag:Name",
        values: ["exampleNameTagValue"],
    }],
}));

Search By Public IP (EC2-Classic or VPC)

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const byPublicIp = pulumi.output(aws.getElasticIp({
    publicIp: "1.2.3.4",
}));

Search By Tags (EC2-Classic or VPC)

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const byTags = pulumi.output(aws.getElasticIp({
    tags: {
        Name: "exampleNameTagValue",
    },
}));

This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/d/eip.html.markdown.

function getEnv 

getEnv(vars: string[]): string | undefined

function getEnvBoolean 

getEnvBoolean(vars: string[]): boolean | undefined

function getEnvNumber 

getEnvNumber(vars: string[]): number | undefined

function getIpRanges 

getIpRanges(args: GetIpRangesArgs, opts?: pulumi.InvokeOptions): Promise<GetIpRangesResult>

Use this data source to get the IP ranges of various AWS products and services. For more information about the contents of this data source and required JSON syntax if referencing a custom URL, see the [AWS IP Address Ranges documention][1].

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const europeanEc2 = pulumi.output(aws.getIpRanges({
    regions: [
        "eu-west-1",
        "eu-central-1",
    ],
    services: ["ec2"],
}));
const fromEurope = new aws.ec2.SecurityGroup("from_europe", {
    ingress: [{
        cidrBlocks: europeanEc2.cidrBlocks,
        fromPort: 443,
        ipv6CidrBlocks: europeanEc2.ipv6CidrBlocks,
        protocol: "tcp",
        toPort: 443,
    }],
    tags: {
        CreateDate: europeanEc2.createDate,
        SyncToken: europeanEc2.syncToken,
    },
});

This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/d/ip_ranges.html.markdown.

function getPartition 

getPartition(opts?: pulumi.InvokeOptions): Promise<GetPartitionResult>

This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/d/partition.html.markdown.

function getPrefixList 

getPrefixList(args?: GetPrefixListArgs, opts?: pulumi.InvokeOptions): Promise<GetPrefixListResult>

aws_prefix_list provides details about a specific prefix list (PL) in the current region.

This can be used both to validate a prefix list given in a variable and to obtain the CIDR blocks (IP address ranges) for the associated AWS service. The latter may be useful e.g. for adding network ACL rules.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const bar = new aws.ec2.NetworkAcl("bar", {
    vpcId: aws_vpc_foo.id,
});
const privateS3VpcEndpoint = new aws.ec2.VpcEndpoint("private_s3", {
    serviceName: "com.amazonaws.us-west-2.s3",
    vpcId: aws_vpc_foo.id,
});
const privateS3PrefixList = privateS3VpcEndpoint.prefixListId.apply(prefixListId => aws.getPrefixList({
    prefixListId: prefixListId,
}));
const privateS3NetworkAclRule = new aws.ec2.NetworkAclRule("private_s3", {
    cidrBlock: privateS3PrefixList.apply(privateS3PrefixList => privateS3PrefixList.cidrBlocks[0]),
    egress: false,
    fromPort: 443,
    networkAclId: bar.id,
    protocol: "tcp",
    ruleAction: "allow",
    ruleNumber: 200,
    toPort: 443,
});

This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/d/prefix_list.html.markdown.

function getRegion 

getRegion(args?: GetRegionArgs, opts?: pulumi.InvokeOptions): Promise<GetRegionResult>

aws_region provides details about a specific AWS region.

As well as validating a given region name this resource can be used to discover the name of the region configured within the provider. The latter can be useful in a child module which is inheriting an AWS provider configuration from its parent module.

Example Usage

The following example shows how the resource might be used to obtain the name of the AWS region configured on the provider.

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const current = pulumi.output(aws.getRegion({}));

This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/d/region.html.markdown.

function getVersion 

getVersion(): string

function ifUndefined

function sha1hash

function withAlias

function withAliases

interface GetAmiArgs

A collection of arguments for invoking getAmi.

property executableUsers 

executableUsers?: string[];

Limit search to users with explicit launch permission on the image. Valid items are the numeric account ID or self.

property filters 

filters?: {
    name: string;
    values: string[];
}[];

One or more name/value pairs to filter off of. There are several valid keys, for a full reference, check out [describe-images in the AWS CLI reference][1].

property mostRecent 

mostRecent?: undefined | false | true;

If more than one result is returned, use the most recent AMI.

property nameRegex 

nameRegex?: undefined | string;

A regex string to apply to the AMI list returned by AWS. This allows more advanced filtering not supported from the AWS API. This filtering is done locally on what AWS returns, and could have a performance impact if the result is large. It is recommended to combine this with other options to narrow down the list AWS returns.

property owners 

owners: string[];

List of AMI owners to limit search. At least 1 value must be specified. Valid values: an AWS account ID, self (the current account), or an AWS owner alias (e.g. amazon, aws-marketplace, microsoft).

property tags 

tags?: undefined | {[key: string]: any};

interface GetAmiIdsArgs

A collection of arguments for invoking getAmiIds.

property executableUsers 

executableUsers?: string[];

Limit search to users with explicit launch permission on the image. Valid items are the numeric account ID or self.

property filters 

filters?: {
    name: string;
    values: string[];
}[];

One or more name/value pairs to filter off of. There are several valid keys, for a full reference, check out [describe-images in the AWS CLI reference][1].

property nameRegex 

nameRegex?: undefined | string;

A regex string to apply to the AMI list returned by AWS. This allows more advanced filtering not supported from the AWS API. This filtering is done locally on what AWS returns, and could have a performance impact if the result is large. It is recommended to combine this with other options to narrow down the list AWS returns.

property owners 

owners: string[];

List of AMI owners to limit search. At least 1 value must be specified. Valid values: an AWS account ID, self (the current account), or an AWS owner alias (e.g. amazon, aws-marketplace, microsoft).

property sortAscending 

sortAscending?: undefined | false | true;

Used to sort AMIs by creation time.

interface GetAmiIdsResult

A collection of values returned by getAmiIds.

property executableUsers 

executableUsers?: string[];

property filters 

filters?: {
    name: string;
    values: string[];
}[];

property id 

id: string;

id is the provider-assigned unique ID for this managed resource.

property ids 

ids: string[];

property nameRegex 

nameRegex?: undefined | string;

property owners 

owners: string[];

property sortAscending 

sortAscending?: undefined | false | true;

interface GetAmiResult

A collection of values returned by getAmi.

property architecture 

architecture: string;

The OS architecture of the AMI (ie: i386 or x86_64).

property blockDeviceMappings 

blockDeviceMappings: {
    deviceName: string;
    ebs: {[key: string]: any};
    noDevice: string;
    virtualName: string;
}[];

The block device mappings of the AMI. * block_device_mappings.#.device_name - The physical name of the device. * block_device_mappings.#.ebs.delete_on_termination - true if the EBS volume will be deleted on termination. * block_device_mappings.#.ebs.encrypted - true if the EBS volume is encrypted. * block_device_mappings.#.ebs.iops - 0 if the EBS volume is not a provisioned IOPS image, otherwise the supported IOPS count. * block_device_mappings.#.ebs.snapshot_id - The ID of the snapshot. * block_device_mappings.#.ebs.volume_size - The size of the volume, in GiB. * block_device_mappings.#.ebs.volume_type - The volume type. * block_device_mappings.#.no_device - Suppresses the specified device included in the block device mapping of the AMI. * block_device_mappings.#.virtual_name - The virtual device name (for instance stores).

property creationDate 

creationDate: string;

The date and time the image was created.

property description 

description: string;

The description of the AMI that was provided during image creation.

property executableUsers 

executableUsers?: string[];

property filters 

filters?: {
    name: string;
    values: string[];
}[];

property hypervisor 

hypervisor: string;

The hypervisor type of the image.

property id 

id: string;

id is the provider-assigned unique ID for this managed resource.

property imageId 

imageId: string;

The ID of the AMI. Should be the same as the resource id.

property imageLocation 

imageLocation: string;

The location of the AMI.

property imageOwnerAlias 

imageOwnerAlias: string;

The AWS account alias (for example, amazon, self) or the AWS account ID of the AMI owner.

property imageType 

imageType: string;

The type of image.

property kernelId 

kernelId: string;

The kernel associated with the image, if any. Only applicable for machine images.

property mostRecent 

mostRecent?: undefined | false | true;

property name 

name: string;

The name of the AMI that was provided during image creation.

property nameRegex 

nameRegex?: undefined | string;

property ownerId 

ownerId: string;

The AWS account ID of the image owner.

property owners 

owners: string[];

property platform 

platform: string;

The value is Windows for Windows AMIs; otherwise blank.

property productCodes 

productCodes: {
    productCodeId: string;
    productCodeType: string;
}[];

Any product codes associated with the AMI. * product_codes.#.product_code_id - The product code. * product_codes.#.product_code_type - The type of product code.

property public 

public: boolean;

true if the image has public launch permissions.

property ramdiskId 

ramdiskId: string;

The RAM disk associated with the image, if any. Only applicable for machine images.

property rootDeviceName 

rootDeviceName: string;

The device name of the root device.

property rootDeviceType 

rootDeviceType: string;

The type of root device (ie: ebs or instance-store).

property rootSnapshotId 

rootSnapshotId: string;

The snapshot id associated with the root device, if any (only applies to ebs root devices).

property sriovNetSupport 

sriovNetSupport: string;

Specifies whether enhanced networking is enabled.

property state 

state: string;

The current state of the AMI. If the state is available, the image is successfully registered and can be used to launch an instance.

property stateReason 

stateReason: {[key: string]: any};

Describes a state change. Fields are UNSET if not available. * state_reason.code - The reason code for the state change. * state_reason.message - The message for the state change.

property tags 

tags: {[key: string]: any};

Any tags assigned to the image. * tags.#.key - The key name of the tag. * tags.#.value - The value of the tag.

property virtualizationType 

virtualizationType: string;

The type of virtualization of the AMI (ie: hvm or paravirtual).

interface GetArnArgs

A collection of arguments for invoking getArn.

property arn 

arn: string;

The ARN to parse.

interface GetArnResult

A collection of values returned by getArn.

property account 

account: string;

The ID of the AWS account that owns the resource, without the hyphens.

property arn 

arn: string;

property id 

id: string;

id is the provider-assigned unique ID for this managed resource.

property partition 

partition: string;

The partition that the resource is in.

property region 

region: string;

The region the resource resides in. Note that the ARNs for some resources do not require a region, so this component might be omitted.

property resource 

resource: string;

The content of this part of the ARN varies by service. It often includes an indicator of the type of resource—for example, an IAM user or Amazon RDS database —followed by a slash (/) or a colon (:), followed by the resource name itself.

property service 

service: string;

The service namespace that identifies the AWS product.

interface GetAutoscalingGroupsArgs

A collection of arguments for invoking getAutoscalingGroups.

property filters 

filters?: {
    name: string;
    values: string[];
}[];

A filter used to scope the list e.g. by tags. See related docs.

interface GetAutoscalingGroupsResult

A collection of values returned by getAutoscalingGroups.

property arns 

arns: string[];

A list of the Autoscaling Groups Arns in the current region.

property filters 

filters?: {
    name: string;
    values: string[];
}[];

property id 

id: string;

id is the provider-assigned unique ID for this managed resource.

property names 

names: string[];

A list of the Autoscaling Groups in the current region.

interface GetAvailabilityZoneArgs

A collection of arguments for invoking getAvailabilityZone.

property name 

name?: undefined | string;

The full name of the availability zone to select.

property state 

state?: undefined | string;

A specific availability zone state to require. May be any of "available", "information" or "impaired".

property zoneId 

zoneId?: undefined | string;

The zone ID of the availability zone to select.

interface GetAvailabilityZoneResult

A collection of values returned by getAvailabilityZone.

property id 

id: string;

id is the provider-assigned unique ID for this managed resource.

property name 

name: string;

The name of the selected availability zone.

property nameSuffix 

nameSuffix: string;

The part of the AZ name that appears after the region name, uniquely identifying the AZ within its region.

property region 

region: string;

The region where the selected availability zone resides. This is always the region selected on the provider, since this data source searches only within that region.

property state 

state: string;

The current state of the AZ.

property zoneId 

zoneId: string;

(Optional) The zone ID of the selected availability zone.

interface GetAvailabilityZonesArgs

A collection of arguments for invoking getAvailabilityZones.

property blacklistedNames 

blacklistedNames?: string[];

List of blacklisted Availability Zone names.

property blacklistedZoneIds 

blacklistedZoneIds?: string[];

List of blacklisted Availability Zone IDs.

property state 

state?: undefined | string;

Allows to filter list of Availability Zones based on their current state. Can be either "available", "information", "impaired" or "unavailable". By default the list includes a complete set of Availability Zones to which the underlying AWS account has access, regardless of their state.

interface GetAvailabilityZonesResult

A collection of values returned by getAvailabilityZones.

property blacklistedNames 

blacklistedNames?: string[];

property blacklistedZoneIds 

blacklistedZoneIds?: string[];

property id 

id: string;

id is the provider-assigned unique ID for this managed resource.

property names 

names: string[];

A list of the Availability Zone names available to the account.

property state 

state?: undefined | string;

property zoneIds 

zoneIds: string[];

A list of the Availability Zone IDs available to the account.

interface GetBillingServiceAccountResult

A collection of values returned by getBillingServiceAccount.

property arn 

arn: string;

The ARN of the AWS billing service account.

property id 

id: string;

id is the provider-assigned unique ID for this managed resource.

interface GetCallerIdentityResult

A collection of values returned by getCallerIdentity.

property accountId 

accountId: string;

The AWS Account ID number of the account that owns or contains the calling entity.

property arn 

arn: string;

The AWS ARN associated with the calling entity.

property id 

id: string;

id is the provider-assigned unique ID for this managed resource.

property userId 

userId: string;

The unique identifier of the calling entity.

interface GetCanonicalUserIdResult

A collection of values returned by getCanonicalUserId.

property displayName 

displayName: string;

The human-friendly name linked to the canonical user ID. The bucket owner’s display name. NOTE: This value is only included in the response in the US East (N. Virginia), US West (N. California), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), EU (Ireland), and South America (São Paulo) regions.

property id 

id: string;

id is the provider-assigned unique ID for this managed resource.

interface GetElasticIpArgs

A collection of arguments for invoking getElasticIp.

property filters 

filters?: {
    name: string;
    values: string[];
}[];

One or more name/value pairs to use as filters. There are several valid keys, for a full reference, check out the EC2 API Reference.

property id 

id?: undefined | string;

The allocation id of the specific VPC EIP to retrieve. If a classic EIP is required, do NOT set id, only set public_ip

property publicIp 

publicIp?: undefined | string;

The public IP of the specific EIP to retrieve.

property tags 

tags?: undefined | {[key: string]: any};

A mapping of tags, each pair of which must exactly match a pair on the desired Elastic IP

interface GetElasticIpResult

A collection of values returned by getElasticIp.

property associationId 

associationId: string;

The ID representing the association of the address with an instance in a VPC.

property domain 

domain: string;

Indicates whether the address is for use in EC2-Classic (standard) or in a VPC (vpc).

property filters 

filters?: {
    name: string;
    values: string[];
}[];

property id 

id: string;

If VPC Elastic IP, the allocation identifier. If EC2-Classic Elastic IP, the public IP address.

property instanceId 

instanceId: string;

The ID of the instance that the address is associated with (if any).

property networkInterfaceId 

networkInterfaceId: string;

The ID of the network interface.

property networkInterfaceOwnerId 

networkInterfaceOwnerId: string;

The ID of the AWS account that owns the network interface.

property privateDns 

privateDns: string;

The Private DNS associated with the Elastic IP address.

property privateIp 

privateIp: string;

The private IP address associated with the Elastic IP address.

property publicDns 

publicDns: string;

Public DNS associated with the Elastic IP address.

property publicIp 

publicIp: string;

Public IP address of Elastic IP.

property publicIpv4Pool 

publicIpv4Pool: string;

The ID of an address pool.

property tags 

tags: {[key: string]: any};

Key-value map of tags associated with Elastic IP.

interface GetIpRangesArgs

A collection of arguments for invoking getIpRanges.

property regions 

regions?: string[];

Filter IP ranges by regions (or include all regions, if omitted). Valid items are global (for cloudfront) as well as all AWS regions (e.g. eu-central-1)

property services 

services: string[];

Filter IP ranges by services. Valid items are amazon (for amazon.com), cloudfront, codebuild, ec2, route53, route53_healthchecks and S3.

property url 

url?: undefined | string;

Custom URL for source JSON file. Syntax must match [AWS IP Address Ranges documention][1]. Defaults to https://ip-ranges.amazonaws.com/ip-ranges.json.

interface GetIpRangesResult

A collection of values returned by getIpRanges.

property cidrBlocks 

cidrBlocks: string[];

The lexically ordered list of CIDR blocks.

property createDate 

createDate: string;

The publication time of the IP ranges (e.g. 2016-08-03-23-46-05).

property id 

id: string;

id is the provider-assigned unique ID for this managed resource.

property ipv6CidrBlocks 

ipv6CidrBlocks: string[];

The lexically ordered list of IPv6 CIDR blocks.

property regions 

regions?: string[];

property services 

services: string[];

property syncToken 

syncToken: number;

The publication time of the IP ranges, in Unix epoch time format (e.g. 1470267965).

property url 

url?: undefined | string;

interface GetPartitionResult

A collection of values returned by getPartition.

property id 

id: string;

id is the provider-assigned unique ID for this managed resource.

property partition 

partition: string;

interface GetPrefixListArgs

A collection of arguments for invoking getPrefixList.

property name 

name?: undefined | string;

The name of the prefix list to select.

property prefixListId 

prefixListId?: undefined | string;

The ID of the prefix list to select.

interface GetPrefixListResult

A collection of values returned by getPrefixList.

property cidrBlocks 

cidrBlocks: string[];

The list of CIDR blocks for the AWS service associated with the prefix list.

property id 

id: string;

id is the provider-assigned unique ID for this managed resource.

property name 

name: string;

The name of the selected prefix list.

property prefixListId 

prefixListId?: undefined | string;

interface GetRegionArgs

A collection of arguments for invoking getRegion.

property endpoint 

endpoint?: undefined | string;

The EC2 endpoint of the region to select.

property name 

name?: undefined | string;

The full name of the region to select.

interface GetRegionResult

A collection of values returned by getRegion.

property description 

description: string;

The region’s description in this format: “Location (Region name)”.

property endpoint 

endpoint: string;

The EC2 endpoint for the selected region.

property id 

id: string;

id is the provider-assigned unique ID for this managed resource.

property name 

name: string;

The name of the selected region.

interface ProviderArgs

The set of arguments for constructing a Provider resource.

property accessKey 

accessKey?: pulumi.Input<string>;

The access key for API operations. You can retrieve this from the ‘Security & Credentials’ section of the AWS console.

property allowedAccountIds 

allowedAccountIds?: pulumi.Input<pulumi.Input<string>[]>;

property assumeRole 

assumeRole?: pulumi.Input<{
    externalId: pulumi.Input<string>;
    policy: pulumi.Input<string>;
    roleArn: pulumi.Input<string>;
    sessionName: pulumi.Input<string>;
}>;

property endpoints 

endpoints?: pulumi.Input<pulumi.Input<{
    acm: pulumi.Input<string>;
    acmpca: pulumi.Input<string>;
    apigateway: pulumi.Input<string>;
    applicationautoscaling: pulumi.Input<string>;
    applicationinsights: pulumi.Input<string>;
    appmesh: pulumi.Input<string>;
    appsync: pulumi.Input<string>;
    athena: pulumi.Input<string>;
    autoscaling: pulumi.Input<string>;
    autoscalingplans: pulumi.Input<string>;
    backup: pulumi.Input<string>;
    batch: pulumi.Input<string>;
    budgets: pulumi.Input<string>;
    cloud9: pulumi.Input<string>;
    cloudformation: pulumi.Input<string>;
    cloudfront: pulumi.Input<string>;
    cloudhsm: pulumi.Input<string>;
    cloudsearch: pulumi.Input<string>;
    cloudtrail: pulumi.Input<string>;
    cloudwatch: pulumi.Input<string>;
    cloudwatchevents: pulumi.Input<string>;
    cloudwatchlogs: pulumi.Input<string>;
    codebuild: pulumi.Input<string>;
    codecommit: pulumi.Input<string>;
    codedeploy: pulumi.Input<string>;
    codepipeline: pulumi.Input<string>;
    cognitoidentity: pulumi.Input<string>;
    cognitoidp: pulumi.Input<string>;
    configservice: pulumi.Input<string>;
    cur: pulumi.Input<string>;
    datapipeline: pulumi.Input<string>;
    datasync: pulumi.Input<string>;
    dax: pulumi.Input<string>;
    devicefarm: pulumi.Input<string>;
    directconnect: pulumi.Input<string>;
    dlm: pulumi.Input<string>;
    dms: pulumi.Input<string>;
    docdb: pulumi.Input<string>;
    ds: pulumi.Input<string>;
    dynamodb: pulumi.Input<string>;
    ec2: pulumi.Input<string>;
    ecr: pulumi.Input<string>;
    ecs: pulumi.Input<string>;
    efs: pulumi.Input<string>;
    eks: pulumi.Input<string>;
    elasticache: pulumi.Input<string>;
    elasticbeanstalk: pulumi.Input<string>;
    elastictranscoder: pulumi.Input<string>;
    elb: pulumi.Input<string>;
    emr: pulumi.Input<string>;
    es: pulumi.Input<string>;
    firehose: pulumi.Input<string>;
    fms: pulumi.Input<string>;
    fsx: pulumi.Input<string>;
    gamelift: pulumi.Input<string>;
    glacier: pulumi.Input<string>;
    globalaccelerator: pulumi.Input<string>;
    glue: pulumi.Input<string>;
    guardduty: pulumi.Input<string>;
    iam: pulumi.Input<string>;
    inspector: pulumi.Input<string>;
    iot: pulumi.Input<string>;
    kafka: pulumi.Input<string>;
    kinesis: pulumi.Input<string>;
    kinesisAnalytics: pulumi.Input<string>;
    kinesisanalytics: pulumi.Input<string>;
    kinesisvideo: pulumi.Input<string>;
    kms: pulumi.Input<string>;
    lambda: pulumi.Input<string>;
    lexmodels: pulumi.Input<string>;
    licensemanager: pulumi.Input<string>;
    lightsail: pulumi.Input<string>;
    macie: pulumi.Input<string>;
    managedblockchain: pulumi.Input<string>;
    mediaconnect: pulumi.Input<string>;
    mediaconvert: pulumi.Input<string>;
    medialive: pulumi.Input<string>;
    mediapackage: pulumi.Input<string>;
    mediastore: pulumi.Input<string>;
    mediastoredata: pulumi.Input<string>;
    mq: pulumi.Input<string>;
    neptune: pulumi.Input<string>;
    opsworks: pulumi.Input<string>;
    organizations: pulumi.Input<string>;
    pinpoint: pulumi.Input<string>;
    pricing: pulumi.Input<string>;
    quicksight: pulumi.Input<string>;
    r53: pulumi.Input<string>;
    ram: pulumi.Input<string>;
    rds: pulumi.Input<string>;
    redshift: pulumi.Input<string>;
    resourcegroups: pulumi.Input<string>;
    route53: pulumi.Input<string>;
    route53resolver: pulumi.Input<string>;
    s3: pulumi.Input<string>;
    s3control: pulumi.Input<string>;
    sagemaker: pulumi.Input<string>;
    sdb: pulumi.Input<string>;
    secretsmanager: pulumi.Input<string>;
    securityhub: pulumi.Input<string>;
    serverlessrepo: pulumi.Input<string>;
    servicecatalog: pulumi.Input<string>;
    servicediscovery: pulumi.Input<string>;
    servicequotas: pulumi.Input<string>;
    ses: pulumi.Input<string>;
    shield: pulumi.Input<string>;
    sns: pulumi.Input<string>;
    sqs: pulumi.Input<string>;
    ssm: pulumi.Input<string>;
    stepfunctions: pulumi.Input<string>;
    storagegateway: pulumi.Input<string>;
    sts: pulumi.Input<string>;
    swf: pulumi.Input<string>;
    transfer: pulumi.Input<string>;
    waf: pulumi.Input<string>;
    wafregional: pulumi.Input<string>;
    worklink: pulumi.Input<string>;
    workspaces: pulumi.Input<string>;
    xray: pulumi.Input<string>;
}>[]>;

property forbiddenAccountIds 

forbiddenAccountIds?: pulumi.Input<pulumi.Input<string>[]>;

property insecure 

insecure?: pulumi.Input<boolean>;

Explicitly allow the provider to perform “insecure” SSL requests. If omitted,default value is false

property maxRetries 

maxRetries?: pulumi.Input<number>;

The maximum number of times an AWS API request is being executed. If the API request still fails, an error is thrown.

property profile 

profile?: pulumi.Input<string>;

The profile for API operations. If not set, the default profile created with aws configure will be used.

property region 

region?: pulumi.Input<Region>;

The region where AWS operations will take place. Examples are us-east-1, us-west-2, etc.

property s3ForcePathStyle 

s3ForcePathStyle?: pulumi.Input<boolean>;

Set this to true to force the request to use path-style addressing, i.e., http://s3.amazonaws.com/BUCKET/KEY. By default, the S3 client will use virtual hosted bucket addressing when possible (http://BUCKET.s3.amazonaws.com/KEY). Specific to the Amazon S3 service.

property secretKey 

secretKey?: pulumi.Input<string>;

The secret key for API operations. You can retrieve this from the ‘Security & Credentials’ section of the AWS console.

property sharedCredentialsFile 

sharedCredentialsFile?: pulumi.Input<string>;

The path to the shared credentials file. If not set this defaults to ~/.aws/credentials.

property skipCredentialsValidation 

skipCredentialsValidation?: pulumi.Input<boolean>;

Skip the credentials validation via STS API. Used for AWS API implementations that do not have STS available/implemented.

property skipGetEc2Platforms 

skipGetEc2Platforms?: pulumi.Input<boolean>;

Skip getting the supported EC2 platforms. Used by users that don’t have ec2:DescribeAccountAttributes permissions.

property skipMetadataApiCheck 

skipMetadataApiCheck?: pulumi.Input<boolean>;

property skipRegionValidation 

skipRegionValidation?: pulumi.Input<boolean>;

Skip static validation of region name. Used by users of alternative AWS-like APIs or users w/ access to regions that are not public (yet).

property skipRequestingAccountId 

skipRequestingAccountId?: pulumi.Input<boolean>;

Skip requesting the account ID. Used for AWS API implementations that do not have IAM/STS API and/or metadata API.

property token 

token?: pulumi.Input<string>;

session token. A session token is only required if you are using temporary security credentials.

interface Tags

Tags represents a set of key-value string pairs to which can be applied to an AWS resource.

let APNortheast1Region 

let APNortheast1Region: Region = "ap-northeast-1";

let APNortheast2Region 

let APNortheast2Region: Region = "ap-northeast-2";

let APSouth1Region 

let APSouth1Region: Region = "ap-south-1";

let APSouthEast2Region 

let APSouthEast2Region: Region = "ap-southeast-2";

let APSoutheast1Region 

let APSoutheast1Region: Region = "ap-southeast-1";

let CACentralRegion 

let CACentralRegion: Region = "ca-central-1";

let EUCentral1Region 

let EUCentral1Region: Region = "eu-central-1";

let EUWest1Region 

let EUWest1Region: Region = "eu-west-1";

let EUWest2Region 

let EUWest2Region: Region = "eu-west-2";

let EUWest3Region 

let EUWest3Region: Region = "eu-west-3";

let SAEast1Region 

let SAEast1Region: Region = "sa-east-1";

let USEast1Region 

let USEast1Region: Region = "us-east-1";

let USEast2Region 

let USEast2Region: Region = "us-east-2";

let USWest1Region 

let USWest1Region: Region = "us-west-1";

let USWest2Region 

let USWest2Region: Region = "us-west-2";

type ARN 

type ARN = string;

An ARN is an Amazon Resource Name, and uniquely identifies a region globally across all accounts and regions.

type Overwrite 

type Overwrite = Pick<T, Diff<keyof T, keyof U>> & U;

type Region 

type Region = “ap-northeast-1” | “ap-northeast-2” | “ap-south-1” | “ap-southeast-2” | “ap-southeast-1” | “ca-central-1” | “eu-central-1” | “eu-west-1” | “eu-west-2” | “eu-west-3” | “sa-east-1” | “us-east-1” | “us-east-2” | “us-west-1” | “us-west-2”;

A Region represents any valid Amazon region that may be targeted with deployments.