input_sources

Creates, updates, deletes, gets or lists an input_sources resource.

Overview

Name	input_sources
Type	Resource
Id	aws.resiliencehubv2.input_sources

Fields

The following fields are returned by SELECT queries:

list_input_sources

Name	Datatype	Description
cfn_stack_arn	string	ARN identifier. (pattern: <code>arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+.-]{0,1023}</code>)
created_at	string (date-time)	The timestamp when the input source was created.
design_file_s3_url	string	S3 URL — virtual hosted-style or s3:​// URI. (pattern: <code>((https:​//([^/]+).s3[^/]*.[^/]+)|(s3:​//([^/]+)))/\S{1,2000}</code>)
eks	object	The Amazon EKS configuration, if this input source uses EKS.
input_source_id	string	The unique identifier of the input source. (pattern: <code>\S{1,255}</code>)
resource_tags	array	The resource tags used for discovery, if this input source uses tags.
tf_state_file_url	string	S3 URL — virtual hosted-style or s3:​// URI. (pattern: <code>((https:​//([^/]+).s3[^/]*.[^/]+)|(s3:​//([^/]+)))/\S{1,2000}</code>)
type_	string	The type of the input source. (CFN_STACK, TAGS, EKS, TERRAFORM, DESIGN_FILE, MONITORING)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_input_sources	select	serviceArn, region	type, maxResults, nextToken	Lists input sources for a service.
create_input_source	insert	region, serviceArn, resourceConfiguration		Creates an input source for a service.
delete_input_source	delete	region		Deletes an input source.

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)
serviceArn	string
maxResults	integer
nextToken	string
type	string	Filter input sources by type.

SELECT examples

list_input_sources

Lists input sources for a service.

SELECT
cfn_stack_arn,
created_at,
design_file_s3_url,
eks,
input_source_id,
resource_tags,
tf_state_file_url,
type_
FROM aws.resiliencehubv2.input_sources
WHERE serviceArn = '{{ serviceArn }}' -- required
AND region = '{{ region }}' -- required
AND type = '{{ type }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_input_source

Creates an input source for a service.

INSERT INTO aws.resiliencehubv2.input_sources (
serviceArn,
resourceConfiguration,
clientToken,
region
)
SELECT 
'{{ serviceArn }}' /* required */,
'{{ resourceConfiguration }}' /* required */,
'{{ clientToken }}',
'{{ region }}'
RETURNING
input_source_id,
service_arn
;

Manifest

# Description fields are for documentation purposes
- name: input_sources
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the input_sources resource.
  - name: serviceArn
    value: "{{ serviceArn }}"
    description: |
      ARN identifier.
  - name: resourceConfiguration
    description: |
      Resource configuration for an input source. Provide exactly one field.
    value:
      resourceTags:
        - key: "{{ key }}"
          values: "{{ values }}"
      cfnStackArn: "{{ cfnStackArn }}"
      tfStateFileUrl: "{{ tfStateFileUrl }}"
      eks:
        clusterArn: "{{ clusterArn }}"
        namespaces:
          - "{{ namespaces }}"
      designFileS3Url: "{{ designFileS3Url }}"
  - name: clientToken
    value: "{{ clientToken }}"
    description: |
      Idempotency token.

DELETE examples

delete_input_source

Deletes an input source.

DELETE FROM aws.resiliencehubv2.input_sources
WHERE region = '{{ region }}' --required
;