input_security_groups

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

Overview

Name	input_security_groups
Type	Resource
Id	aws.medialive.input_security_groups

Fields

The following fields are returned by SELECT queries:

describe_input_security_group

Name	Datatype	Description
arn	string	Placeholder documentation for __string
channels	array	Placeholder documentation for __listOf__string
id	string	Placeholder documentation for __string
inputs	array	Placeholder documentation for __listOf__string
state	string	The current state of the Input Security Group. (IDLE, IN_USE, UPDATING, DELETED)
tags	object	A collection of key-value pairs.
whitelist_rules	array	Whitelist rules and their sync status

list_input_security_groups

Name	Datatype	Description
arn	string	Placeholder documentation for __string
channels	array	Placeholder documentation for __listOf__string
id	string	Placeholder documentation for __string
inputs	array	Placeholder documentation for __listOf__string
state	string	The current state of the Input Security Group. (IDLE, IN_USE, UPDATING, DELETED)
tags	object	A collection of key-value pairs.
whitelist_rules	array	Whitelist rules and their sync status

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_input_security_group	select	input_security_group_id, region		Produces a summary of an Input Security Group
list_input_security_groups	select	region	maxResults, nextToken	Produces a list of Input Security Groups for an account
create_input_security_group	insert	region		Creates a Input Security Group
update_input_security_group	update	input_security_group_id, region		Update an Input Security Group's Whilelists.
delete_input_security_group	delete	input_security_group_id, region		Deletes an Input Security Group

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
input_security_group_id	string	The Input Security Group to delete
region	string	AWS region (default: us-east-1)
maxResults	integer
nextToken	string

SELECT examples

describe_input_security_group

Produces a summary of an Input Security Group

SELECT
arn,
channels,
id,
inputs,
state,
tags,
whitelist_rules
FROM aws.medialive.input_security_groups
WHERE input_security_group_id = '{{ input_security_group_id }}' -- required
AND region = '{{ region }}' -- required
;

list_input_security_groups

Produces a list of Input Security Groups for an account

SELECT
arn,
channels,
id,
inputs,
state,
tags,
whitelist_rules
FROM aws.medialive.input_security_groups
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_input_security_group

Creates a Input Security Group

INSERT INTO aws.medialive.input_security_groups (
Tags,
WhitelistRules,
region
)
SELECT 
'{{ Tags }}',
'{{ WhitelistRules }}',
'{{ region }}'
RETURNING
security_group
;

Manifest

# Description fields are for documentation purposes
- name: input_security_groups
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the input_security_groups resource.
  - name: Tags
    value: "{{ Tags }}"
    description: |
      Placeholder documentation for Tags
  - name: WhitelistRules
    description: |
      Placeholder documentation for __listOfInputWhitelistRuleCidr
    value:
      - Cidr: "{{ Cidr }}"

UPDATE examples

update_input_security_group

Update an Input Security Group's Whilelists.

UPDATE aws.medialive.input_security_groups
SET 
Tags = '{{ Tags }}',
WhitelistRules = '{{ WhitelistRules }}'
WHERE 
input_security_group_id = '{{ input_security_group_id }}' --required
AND region = '{{ region }}' --required
RETURNING
security_group;

DELETE examples

delete_input_security_group

Deletes an Input Security Group

DELETE FROM aws.medialive.input_security_groups
WHERE input_security_group_id = '{{ input_security_group_id }}' --required
AND region = '{{ region }}' --required
;