components

Creates, updates, deletes, gets or lists a components resource.

Overview

Name	components
Type	Resource
Id	aws.application_insights.components

Fields

The following fields are returned by SELECT queries:

describe_component

Name	Datatype	Description
application_component	object	Describes a standalone resource or similarly grouped resources that the application is made up of.
resource_list	array	The list of resource ARNs that belong to the component.

list_components

Name	Datatype	Description
application_component_list	array	The list of application components.
next_token	string	The token to request the next page of results. (pattern: <code>.+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_component	select	region		Describes a component and lists the resources that are grouped together in a component.
list_components	select	region		Lists the auto-grouped, standalone, and custom components of the application.
create_component	insert	region, ResourceGroupName, ComponentName, ResourceList		Creates a custom component by grouping similar standalone instances to monitor.
update_component	update	region, ResourceGroupName, ComponentName		Updates the custom component name and/or the list of resources that make up the component.
delete_component	delete	region		Ungroups a custom component. When you ungroup custom components, all applicable monitors that are set up for the component are removed and the instances revert to their standalone status.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_component

Describes a component and lists the resources that are grouped together in a component.

SELECT
application_component,
resource_list
FROM aws.application_insights.components
WHERE region = '{{ region }}' -- required
;

list_components

Lists the auto-grouped, standalone, and custom components of the application.

SELECT
application_component_list,
next_token
FROM aws.application_insights.components
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_component

Creates a custom component by grouping similar standalone instances to monitor.

INSERT INTO aws.application_insights.components (
ResourceGroupName,
ComponentName,
ResourceList,
region
)
SELECT 
'{{ ResourceGroupName }}' /* required */,
'{{ ComponentName }}' /* required */,
'{{ ResourceList }}' /* required */,
'{{ region }}'
;

Manifest

# Description fields are for documentation purposes
- name: components
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the components resource.
  - name: ResourceGroupName
    value: "{{ ResourceGroupName }}"
    description: |
      The name of the resource group.
  - name: ComponentName
    value: "{{ ComponentName }}"
    description: |
      The name of the component.
  - name: ResourceList
    value:
      - "{{ ResourceList }}"
    description: |
      The list of resource ARNs that belong to the component.

UPDATE examples

update_component

Updates the custom component name and/or the list of resources that make up the component.

UPDATE aws.application_insights.components
SET 
ResourceGroupName = '{{ ResourceGroupName }}',
ComponentName = '{{ ComponentName }}',
NewComponentName = '{{ NewComponentName }}',
ResourceList = '{{ ResourceList }}'
WHERE 
region = '{{ region }}' --required
AND ResourceGroupName = '{{ ResourceGroupName }}' --required
AND ComponentName = '{{ ComponentName }}' --required;

DELETE examples

delete_component

Ungroups a custom component. When you ungroup custom components, all applicable monitors that are set up for the component are removed and the instances revert to their standalone status.

DELETE FROM aws.application_insights.components
WHERE region = '{{ region }}' --required
;