| Column Name | Column Data Type |
app_ids Input Column
An array of app IDs for the apps to be described. If you use this parameter, DescribeApps returns a description of the specified apps. Otherwise, it returns a description of every app. | VARCHAR[] |
Show child fields- app_ids[]
|
stack_id Input Column
The app stack ID. If you use this parameter, DescribeApps returns a description of the apps in the specified stack. | VARCHAR |
_aws_profile Input Column
The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role. | STRUCT( "type" VARCHAR, "name" VARCHAR, "account_id" VARCHAR, "via_profile_name" VARCHAR, "assumed_role_arn" VARCHAR, "organization" STRUCT( "account_name" VARCHAR, "id" VARCHAR, "tags" STRUCT( "key" VARCHAR, "value" VARCHAR )[], "master_account" STRUCT( "id" VARCHAR, "email" VARCHAR ), "parents" STRUCT( "type" VARCHAR, "id" VARCHAR, "name" VARCHAR, "tags" STRUCT( "key" VARCHAR, "value" VARCHAR )[] )[] ) ) |
Show child fields- _aws_profile.account_id
The AWS account id
- _aws_profile.assumed_role_arn
The ARN of the assumed role
- _aws_profile.name
The unique name of the profile.
- _aws_profile.organization
Information about this profile's membership in the AWS organization. Show child fields- _aws_profile.organization.account_name
The name of account speciifed by the organization
- _aws_profile.organization.id
The organization id
- _aws_profile.organization.master_account
Show child fields- _aws_profile.organization.master_account.email
The organization master account email address
- _aws_profile.organization.master_account.id
The organization master account id
- _aws_profile.organization.parents[]
Show child fields- _aws_profile.organization.parents[].id
The id of the parent
- _aws_profile.organization.parents[].name
The name of the parent
- _aws_profile.organization.parents[].tags[]
Show child fields- _aws_profile.organization.parents[].tags[].key
- _aws_profile.organization.parents[].tags[].value
- _aws_profile.organization.parents[].type
The type of parent can be an organization unit or a root
- _aws_profile.organization.tags[]
Show child fields- _aws_profile.organization.tags[].key
- _aws_profile.organization.tags[].value
- _aws_profile.type
The type of profile, either 'credentials' or 'assumed_role'
- _aws_profile.via_profile_name
This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.
|
_aws_region Input Column
The AWS region to use. | VARCHAR |
apps
An array of App objects that describe the specified apps. | STRUCT( "app_id" VARCHAR, "stack_id" VARCHAR, "shortname" VARCHAR, "name" VARCHAR, "description" VARCHAR, "data_sources" STRUCT( "type" VARCHAR, "arn" VARCHAR, "database_name" VARCHAR )[], "type" VARCHAR, "app_source" STRUCT( "type" VARCHAR, "url" VARCHAR, "username" VARCHAR, "password" VARCHAR, "ssh_key" VARCHAR, "revision" VARCHAR ), "domains" VARCHAR[], "enable_ssl" BOOLEAN, "ssl_configuration" STRUCT( "certificate" VARCHAR, "private_key" VARCHAR, "chain" VARCHAR ), "attributes" MAP(VARCHAR, VARCHAR), "created_at" VARCHAR, "environment" STRUCT( "key" VARCHAR, "value" VARCHAR, "secure" BOOLEAN )[] )[] |
Show child fields- apps[]
Show child fields- apps[].app_id
The app ID.
- apps[].app_source
A Source object that describes the app repository. Show child fields- apps[].app_source.password
When included in a request, the parameter depends on the repository type. -
For Amazon S3 bundles, set Password to the appropriate IAM secret access key. -
For HTTP bundles and Subversion repositories, set Password to the password. For more information on how to safely handle IAM credentials, see https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html. In responses, OpsWorks Stacks returns *****FILTERED***** instead of the actual value.
- apps[].app_source.revision
The application's version. OpsWorks Stacks enables you to easily deploy new versions of an application. One of the simplest approaches is to have branches or revisions in your repository that represent different versions that can potentially be deployed.
- apps[].app_source.ssh_key
In requests, the repository's SSH key. In responses, OpsWorks Stacks returns *****FILTERED***** instead of the actual value.
- apps[].app_source.type
The repository type.
- apps[].app_source.url
The source URL. The following is an example of an Amazon S3 source URL: https://s3.amazonaws.com/opsworks-demo-bucket/opsworks_cookbook_demo.tar.gz.
- apps[].app_source.username
This parameter depends on the repository type. -
For Amazon S3 bundles, set Username to the appropriate IAM access key ID. -
For HTTP bundles, Git repositories, and Subversion repositories, set Username to the user name.
- apps[].attributes
The stack attributes.
- apps[].created_at
When the app was created.
- apps[].data_sources[]
Show child fields- apps[].data_sources[].arn
The data source's ARN.
- apps[].data_sources[].database_name
The database name.
- apps[].data_sources[].type
The data source's type, AutoSelectOpsworksMysqlInstance, OpsworksMysqlInstance, RdsDbInstance, or None.
- apps[].description
A description of the app.
- apps[].domains[]
- apps[].enable_ssl
Whether to enable SSL for the app.
- apps[].environment[]
Show child fields- apps[].environment[].key
(Required) The environment variable's name, which can consist of up to 64 characters and must be specified. The name can contain upper- and lowercase letters, numbers, and underscores (_), but it must start with a letter or underscore.
- apps[].environment[].secure
(Optional) Whether the variable's value is returned by the DescribeApps action. To hide an environment variable's value, set Secure to true. DescribeApps returns *****FILTERED***** instead of the actual value. The default value for Secure is false.
- apps[].environment[].value
(Optional) The environment variable's value, which can be left empty. If you specify a value, it can contain up to 256 characters, which must all be printable.
- apps[].name
The app name.
- apps[].shortname
The app's short name.
- apps[].ssl_configuration
An SslConfiguration object with the SSL configuration. Show child fields- apps[].ssl_configuration.certificate
The contents of the certificate's domain.crt file.
- apps[].ssl_configuration.chain
Optional. Can be used to specify an intermediate certificate authority key or client authentication.
- apps[].ssl_configuration.private_key
The private key; the contents of the certificate's domain.kex file.
- apps[].stack_id
The app stack ID.
- apps[].type
The app type.
|