Skip to content
AWS for Query.Farm

aws.opsworkscm.describe_servers

Example SQL Queries

SELECT * FROM
aws.opsworkscm.describe_servers;

Description

Lists all configuration management servers that are identified with your account. Only the stored results from Amazon DynamoDB are returned. AWS OpsWorks CM does not query other services.

This operation is synchronous.

A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.

Table Definition

Column NameColumn Data Type
server_name Input Column

The name of the server. 

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.

associate_public_ip_address

Associate a public IP address with a server that you are launching. 

BOOLEAN
backup_retention_count

The number of automated backups to keep. 

BIGINT
cloud_formation_stack_arn

The ARN of the CloudFormation stack that was used to create the server. 

VARCHAR
created_at

Time stamp of server creation. Example 2016-07-29T13:38:47.520Z 

TIMESTAMP_S
custom_domain

An optional public endpoint of a server, such as https://aws.my-company.com. You cannot access the server by using the Endpoint value if the server has a CustomDomain specified.

VARCHAR
disable_automated_backup

Disables automated backups. The number of stored backups is dependent on the value of PreferredBackupCount. 

BOOLEAN
endpoint

A DNS name that can be used to access the engine. Example: myserver-asdfghjkl.us-east-1.opsworks.io. You cannot access the server by using the Endpoint value if the server has a CustomDomain specified. 

VARCHAR
engine

The engine type of the server. Valid values in this release include ChefAutomate and Puppet. 

VARCHAR
engine_attributes

The response of a createServer() request returns the master credential to access the server in EngineAttributes. These credentials are not stored by AWS OpsWorks CM; they are returned only as part of the result of createServer().

Attributes returned in a createServer response for Chef

  • CHEF_AUTOMATE_PIVOTAL_KEY: A base64-encoded RSA private key that is generated by AWS OpsWorks for Chef Automate. This private key is required to access the Chef API.

  • CHEF_STARTER_KIT: A base64-encoded ZIP file. The ZIP file contains a Chef starter kit, which includes a README, a configuration file, and the required RSA private key. Save this file, unzip it, and then change to the directory where you've unzipped the file contents. From this directory, you can run Knife commands.

Attributes returned in a createServer response for Puppet

  • PUPPET_STARTER_KIT: A base64-encoded ZIP file. The ZIP file contains a Puppet starter kit, including a README and a required private key. Save this file, unzip it, and then change to the directory where you've unzipped the file contents.

  • PUPPET_ADMIN_PASSWORD: An administrator password that you can use to sign in to the Puppet Enterprise console after the server is online.

STRUCT(
    "name" VARCHAR,
    "value" VARCHAR
)[]
Show child fields
engine_attributes[]
Show child fields
engine_attributes[].name

The name of the engine attribute.

engine_attributes[].value

The value of the engine attribute.

engine_model

The engine model of the server. Valid values in this release include Monolithic for Puppet and Single for Chef. 

VARCHAR
engine_version

The engine version of the server. For a Chef server, the valid value for EngineVersion is currently 2. For a Puppet server, specify either 2019 or 2017. 

VARCHAR
instance_profile_arn

The instance profile ARN of the server. 

VARCHAR
instance_type

The instance type for the server, as specified in the CloudFormation stack. This might not be the same instance type that is shown in the EC2 console. 

VARCHAR
key_pair

The key pair associated with the server. 

VARCHAR
maintenance_status

The status of the most recent server maintenance run. Shows SUCCESS or FAILED. 

VARCHAR
preferred_backup_window

The preferred backup period specified for the server. 

VARCHAR
preferred_maintenance_window

The preferred maintenance period specified for the server. 

VARCHAR
security_group_ids

The security group IDs for the server, as specified in the CloudFormation stack. These might not be the same security groups that are shown in the EC2 console. 

VARCHAR[]
Show child fields
security_group_ids[]
server_arn

The ARN of the server. 

VARCHAR
service_role_arn

The service role ARN used to create the server. 

VARCHAR
status

The server's status. This field displays the states of actions in progress, such as creating, running, or backing up the server, as well as the server's health state. 

VARCHAR
status_reason

Depending on the server status, this field has either a human-readable message (such as a create or backup error), or an escaped block of JSON (used for health check results). 

VARCHAR
subnet_ids

The subnet IDs specified in a CreateServer request. 

VARCHAR[]
Show child fields
subnet_ids[]