discoveries

Creates, updates, deletes or gets a discovery resource or lists discoveries in a region

Overview

Name	discoveries
Type	Resource
Description	Resource Type definition for AWS::ApplicationSignals::Discovery
Id	awscc.applicationsignals.discoveries

Fields

get (all properties)

Name	Datatype	Description
account_id	string	The identifier for the specified AWS account.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
account_id	string	The identifier for the specified AWS account.
region	string	AWS region.

For more information, see AWS::ApplicationSignals::Discovery.

Methods

Name	Resource	Accessible by	Required Params
create_resource	discoveries	INSERT	, region
delete_resource	discoveries	DELETE	Identifier, region
update_resource	discoveries	UPDATE	Identifier, PatchDocument, region
list_resources	discoveries_list_only	SELECT	region
get_resource	discoveries	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual discovery.

SELECT
  region,
  account_id
FROM awscc.applicationsignals.discoveries
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ account_id }}';

list (identifiers only)

Lists all discoveries in a region.

SELECT
  region,
  account_id
FROM awscc.applicationsignals.discoveries_list_only
WHERE
  region = '{{ region }}';

INSERT example

Use the following StackQL query and manifest file to create a new discovery resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.applicationsignals.discoveries (
  ,
  region
)
SELECT
  '{{  }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.applicationsignals.discoveries (
  ,
  region
)
SELECT
  '{{  }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: discovery
  props: []

DELETE example

/*+ delete */
DELETE FROM awscc.applicationsignals.discoveries
WHERE
  Identifier = '{{ account_id }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

To operate on the discoveries resource, the following permissions are required:

Create

application-signals:StartDiscovery,
application-signals:ListServices,
iam:CreateServiceLinkedRole

Read

application-signals:ListServices

Update

application-signals:ListServices

Delete

application-signals:ListServices

List

application-signals:ListServices