Skip to content

info.md

Latest commit

 

History

History
67 lines (50 loc) · 1.64 KB

info.md

File metadata and controls

67 lines (50 loc) · 1.64 KB
Raw

AWS - Info

Displays information about the deployed service.

osls info

Options

  • --stage or -s The stage in your service you want to display information about.
  • --region or -r The region in your stage that you want to display information about.
  • --verbose Displays any Stack Output.
  • --conceal Hide secrets from the output (e.g. API Gateway key values).

Examples

AWS

On AWS the info plugin uses the Outputs section of the CloudFormation stack and the AWS SDK to gather the necessary information. See the example below for an example output.

Example:

$ osls info

Service Information
service: my-serverless-service
stage: dev
region: us-east-1
api keys:
  myKey: some123valid456api789key1011for1213api1415gateway
endpoints:
  GET - https://dxaynpuzd4.execute-api.us-east-1.amazonaws.com/dev/users
functions:
  my-serverless-service-dev-hello

Verbose

When using the --verbose flag, the info command will also append all Stack Outputs to the output:

$ osls info --verbose

Service Information
service: my-serverless-service
stage: dev
region: us-east-1
api keys:
  myKey: some123valid456api789key1011for1213api1415gateway
endpoints:
  GET - https://dxaynpuzd4.execute-api.us-east-1.amazonaws.com/dev/users
functions:
  my-serverless-service-dev-hello

Stack Outputs
CloudFrontUrl: d2d10e2tyk1pei.cloudfront.net
ScreenshotBucket: dev-svdgraaf-screenshots
ServiceEndpoint: https://12341jc801.execute-api.us-east-1.amazonaws.com/dev
ServerlessDeploymentBucketName: lambda-screenshots-dev-serverlessdeploymentbucket-15b7pkc04f98a

← All Commands · Docs Home