Pulumi logo
  • Pulumi Home
  • Get Started
  • Cloud Engineering
  • Product
  • Pricing
  • Docs
  • Blog
  • Learn Pulumi
  • Events & Workshops
    • GitHub
    • Slack
    • Registry
    • Sign In
Get Started
  • Star
  • Slack
  • Docs
  • Registry
  • Sign In
Pulumi Docs
Pulumi logo
Get Started
Get Started with Pulumi / Intro / User Guides / Converters / Reference / Support
Get Started with Pulumi
    • AWS
    • AWS
        • Before You Begin
        • Before You Begin
        • Create a New Project
        • Create a New Project
        • Review the New Project
        • Review the New Project
        • Deploy the Stack
        • Deploy the Stack
        • Modify the Program
        • Modify the Program
        • Deploy the Changes
        • Deploy the Changes
        • Destroy the Stack
        • Destroy the Stack
        • Next Steps
        • Next Steps
    • Azure
    • Azure
        • Before You Begin
        • Before You Begin
        • Create a New Project
        • Create a New Project
        • Review the New Project
        • Review the New Project
        • Deploy the Stack
        • Deploy the Stack
        • Modify the Program
        • Modify the Program
        • Deploy the Changes
        • Deploy the Changes
        • Destroy the Stack
        • Destroy the Stack
        • Next Steps
        • Next Steps
    • Google Cloud
    • Google Cloud
        • Before You Begin
        • Before You Begin
        • Create a New Project
        • Create a New Project
        • Review the New Project
        • Review the New Project
        • Deploy the Stack
        • Deploy the Stack
        • Modify the Program
        • Modify the Program
        • Deploy the Changes
        • Deploy the Changes
        • Destroy the Stack
        • Destroy the Stack
        • Next Steps
        • Next Steps
    • Kubernetes
    • Kubernetes
        • Before You Begin
        • Before You Begin
        • Create a New Project
        • Create a New Project
        • Review the New Project
        • Review the New Project
        • Deploy the Stack
        • Deploy the Stack
        • Modify the Program
        • Modify the Program
        • Deploy the Changes
        • Deploy the Changes
        • Destroy the Stack
        • Destroy the Stack
        • Next Steps
        • Next Steps
    • Download Pulumi
    • Download Pulumi
Intro
    • Architecture & Concepts
    • Architecture & Concepts
        • How Does Pulumi Work?
        • How Does Pulumi Work?
        • Projects
        • Projects
        • Stacks
        • Stacks
        • Resources
        • Resources
            • Resource Names
            • Resource Names
            • Resource Options
            • Resource Options
                • AdditionalSecretOutputs
                • AdditionalSecretOutputs
                • Aliases
                • Aliases
                • CustomTimeouts
                • CustomTimeouts
                • DeleteBeforeReplace
                • DeleteBeforeReplace
                • DependsOn
                • DependsOn
                • IgnoreChanges
                • IgnoreChanges
                • Import
                • Import
                • Parent
                • Parent
                • Protect
                • Protect
                • Provider
                • Provider
                • Providers
                • Providers
                • ReplaceOnChanges
                • ReplaceOnChanges
                • RetainOnDelete
                • RetainOnDelete
                • Transformations
                • Transformations
                • Version
                • Version
            • Component Resources
            • Component Resources
            • Resource Providers
            • Resource Providers
            • Dynamic Resource Providers
            • Dynamic Resource Providers
            • Get Functions
            • Get Functions
            • Provider Functions
            • Provider Functions
        • State and Backends
        • State and Backends
        • Inputs and Outputs
        • Inputs and Outputs
        • Configuration
        • Configuration
        • Secrets
        • Secrets
        • Assets and Archives
        • Assets and Archives
        • Function Serialization
        • Function Serialization
        • Logging
        • Logging
        • Plans
        • Plans
    • Pulumi Service
    • Pulumi Service
        • Accounts
        • Accounts
        • Organizations
        • Organizations
        • Organization Access Tokens
        • Organization Access Tokens
        • Billing Managers
        • Billing Managers
        • Teams and RBAC
        • Teams and RBAC
        • Team Access Tokens
        • Team Access Tokens
        • Project and Stack Management
        • Project and Stack Management
        • Pulumi Deployments
        • Pulumi Deployments
        • CI/CD Integration Assistant
        • CI/CD Integration Assistant
        • Audit Logs
        • Audit Logs
        • Webhooks
        • Webhooks
        • How to Use the Deploy with Pulumi Button
        • How to Use the Deploy with Pulumi Button
    • Cloud Providers
    • Cloud Providers
    • Supported Languages
    • Supported Languages
        • Node.js (TypeScript)
        • Node.js (TypeScript)
        • Python
        • Python
        • .NET (C#, VB, F#)
        • .NET (C#, VB, F#)
        • Go
        • Go
        • Java
        • Java
        • YAML
        • YAML
    • Compare Pulumi to...
    • Compare Pulumi to...
        • Terraform
        • Terraform
        • AWS CloudFormation
        • AWS CloudFormation
        • AWS CDK
        • AWS CDK
        • Cloud SDKs
        • Cloud SDKs
        • Serverless Framework
        • Serverless Framework
        • Kubernetes YAML
        • Kubernetes YAML
        • Chef, Puppet, etc.
        • Chef, Puppet, etc.
        • Custom Solutions
        • Custom Solutions
User Guides
    • Migrating to Pulumi
    • Migrating to Pulumi
        • Importing Existing Cloud Infrastructure
        • Importing Existing Cloud Infrastructure
        • Migrating from Terraform
        • Migrating from Terraform
        • Migrating From AWS Cloud Formation
        • Migrating From AWS Cloud Formation
        • Migrating from Azure Resource Manager
        • Migrating from Azure Resource Manager
        • Migrating From Kubernetes YAML or Helm Charts
        • Migrating From Kubernetes YAML or Helm Charts
    • Automation API
    • Automation API
        • Automation API Concepts
        • Automation API Concepts
        • Getting Started with Automation API
        • Getting Started with Automation API
    • Continuous Delivery
    • Continuous Delivery
        • AWS Code Services
        • AWS Code Services
        • Azure DevOps
        • Azure DevOps
        • CircleCI
        • CircleCI
        • Codefresh
        • Codefresh
        • GitLab CI
        • GitLab CI
        • Google Cloud Build
        • Google Cloud Build
        • Jenkins
        • Jenkins
        • JetBrains TeamCity
        • JetBrains TeamCity
        • Octopus Deploy
        • Octopus Deploy
        • Pulumi GitHub Actions
        • Pulumi GitHub Actions
        • Pulumi GitHub App
        • Pulumi GitHub App
        • Pulumi GitLab Integration
        • Pulumi GitLab Integration
        • Pulumi Kubernetes Operator
        • Pulumi Kubernetes Operator
        • Spinnaker
        • Spinnaker
        • Travis CI
        • Travis CI
        • Adding Support for CI/CD Systems
        • Adding Support for CI/CD Systems
        • Troubleshooting Pulumi in CI
        • Troubleshooting Pulumi in CI
    • Crosswalk for AWS
    • Crosswalk for AWS
        • API Gateway
        • API Gateway
        • Auto Scaling
        • Auto Scaling
        • CloudWatch
        • CloudWatch
        • Elastic Container Registry (ECR)
        • Elastic Container Registry (ECR)
        • Elastic Container Service (ECS)
        • Elastic Container Service (ECS)
        • Elastic Kubernetes Service (EKS)
        • Elastic Kubernetes Service (EKS)
        • Elastic Load Balancing (ELB)
        • Elastic Load Balancing (ELB)
        • Identity and Access Management (IAM)
        • Identity and Access Management (IAM)
        • Lambda
        • Lambda
        • Virtual Private Cloud (VPC)
        • Virtual Private Cloud (VPC)
        • AWS Index of Services
        • AWS Index of Services
    • Crosswalk for Kubernetes
    • Crosswalk for Kubernetes
        • Playbooks for Kubernetes
        • Playbooks for Kubernetes
        • Creating a Kubernetes Control Plane
        • Creating a Kubernetes Control Plane
        • Creating Kubernetes Worker Nodes
        • Creating Kubernetes Worker Nodes
        • Accessing Created Kubernetes Cluster
        • Accessing Created Kubernetes Cluster
        • Configuring Kubernetes Cluster Defaults
        • Configuring Kubernetes Cluster Defaults
        • Configuring Kubernetes Access Control
        • Configuring Kubernetes Access Control
        • Deploying Kubernetes Cluster Services
        • Deploying Kubernetes Cluster Services
        • Deploying Kubernetes App Services
        • Deploying Kubernetes App Services
        • Deploying Kubernetes Apps
        • Deploying Kubernetes Apps
        • Updating Kubernetes Worker Nodes
        • Updating Kubernetes Worker Nodes
    • CrossGuard (Policy as Code)
    • CrossGuard (Policy as Code)
        • Get Started
        • Get Started
        • Core Concepts
        • Core Concepts
        • AWSGuard
        • AWSGuard
        • Configuration
        • Configuration
        • Best Practices
        • Best Practices
        • Frequently Asked Questions
        • Frequently Asked Questions
    • Pulumi Packages
    • Pulumi Packages
        • Contributing to Pulumi Registry
        • Contributing to Pulumi Registry
        • Authoring & Publishing
        • Authoring & Publishing
        • Schema Overview
        • Schema Overview
    • Automated Testing of Pulumi Programs
    • Automated Testing of Pulumi Programs
        • Unit Testing
        • Unit Testing
        • Property Testing
        • Property Testing
        • Integration Testing
        • Integration Testing
    • Organizing Projects and Stacks
    • Organizing Projects and Stacks
    • SAML Single Sign-On (SSO)
    • SAML Single Sign-On (SSO)
        • Configuring SAML
        • Configuring SAML
        • Configuring Azure Active Directory
        • Configuring Azure Active Directory
        • Configuring Google Workspace
        • Configuring Google Workspace
        • Configuring Okta
        • Configuring Okta
        • Configuring OneLogin
        • Configuring OneLogin
    • OpenID Connect Integration for Pulumi Deployments
    • OpenID Connect Integration for Pulumi Deployments
        • Configuring OpenID Connect for AWS
        • Configuring OpenID Connect for AWS
        • Configuring OpenID Connect for Azure
        • Configuring OpenID Connect for Azure
        • Configuring OpenID Connect for GCP
        • Configuring OpenID Connect for GCP
    • SCIM 2.0 Integration
    • SCIM 2.0 Integration
        • Configuring SCIM in OneLogin
        • Configuring SCIM in OneLogin
        • Frequently Asked Questions (FAQ)
        • Frequently Asked Questions (FAQ)
    • Self-Hosting the Pulumi Service
    • Self-Hosting the Pulumi Service
        • Quickstart Docker Compose Install
        • Quickstart Docker Compose Install
        • ECS-Hosted Install
        • ECS-Hosted Install
        • EKS-Hosted Install
        • EKS-Hosted Install
        • AKS-Hosted Install
        • AKS-Hosted Install
        • BYO-Infra Install
        • BYO-Infra Install
        • GKE-Hosted Install
        • GKE-Hosted Install
        • Local-Docker Install
        • Local-Docker Install
        • Enabling SAML SSO
        • Enabling SAML SSO
        • Components
        • Components
            • Pulumi API
            • Pulumi API
            • Pulumi Service
            • Pulumi Service
Converters
    • ARM to Pulumi
    • ARM to Pulumi
    • CloudFormation to Pulumi
    • CloudFormation to Pulumi
    • Kubernetes CustomResources to Pulumi
    • Kubernetes CustomResources to Pulumi
    • Kubernetes YAML to Pulumi
    • Kubernetes YAML to Pulumi
    • Terraform to Pulumi
    • Terraform to Pulumi
Reference
    • API Reference
    • API Reference
    • Pulumi CLI
    • Pulumi CLI
        • cancel
        • cancel
        • config
        • config
        • console
        • console
        • destroy
        • destroy
        • import
        • import
        • login
        • login
        • logout
        • logout
        • logs
        • logs
        • new
        • new
        • plugin
        • plugin
        • policy
        • policy
        • preview
        • preview
        • refresh
        • refresh
        • stack
        • stack
        • state
        • state
        • up
        • up
        • version
        • version
        • whoami
        • whoami
    • Pulumi SDK
    • Pulumi SDK
        • Node.js
        • Node.js
        • Python
        • Python
        • Go
        • Go
        • .NET Core
        • .NET Core
        • Java
        • Java
        • Pulumi YAML
        • Pulumi YAML
    • Pulumi Service REST API
    • Pulumi Service REST API
    • Pulumi Deployments REST API
    • Pulumi Deployments REST API
    • Project File
    • Project File
    • Pulumi Glossary
    • Pulumi Glossary
Support
    • Troubleshooting Guide
    • Troubleshooting Guide
    • Frequently Asked Questions (FAQ)
    • Frequently Asked Questions (FAQ)
  1. Docs
  2. Reference Documentation
  3. API
  4. @pulumi/awsx

On This Page

    • Request a Change

    Was this page helpful?

    Yes No

    Thank you for your feedback!

    If you have a question about how to use Pulumi, reach out in Community Slack.

    Open an issue on GitHub to report a problem or suggest an improvement.

    Feedback

    Thank you for your feedback! If you would like to provide additional feedback, please let us know your thoughts below.

    Submit Close
    Pulumi Deployments: the fastest way to go from code to cloud. Join the Preview
    • Get Started
    • Install
    • Documentation
    • Registry
    • Public Roadmap
    • Security
    • Enterprise
    • AWS
    • Azure
    • Google Cloud
    • Containers
    • Serverless
    • Kubernetes
    • About Us
    • Request a Demo
    • Contact Us
    • Support
    • Careers
    • Resources
    • Slack Archive
    • Case Studies
    • Awards & Recognitions
    • Brand Resources

    © 2023 Pulumi

    • Pulumi Twitter
    • Pulumi Slack
    • Pulumi LinkedIn
    • Pulumi YouTube
    • Pulumi Github
    • Trademark Usage
    • Acceptable Use Policy
    • Terms & Conditions
    • Privacy Policy
    • Professional Services Agreement