flow_vpc_interfaces

Creates, updates, deletes or gets a flow_vpc_interface resource or lists flow_vpc_interfaces in a region

Overview

Name	flow_vpc_interfaces
Type	Resource
Description	Resource schema for AWS::MediaConnect::FlowVpcInterface
Id	aws.mediaconnect.flow_vpc_interfaces

Fields

Name	Datatype	Description
flow_arn	string	The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow.
name	string	Immutable and has to be a unique against other VpcInterfaces in this Flow.
role_arn	string	Role Arn MediaConnect can assume to create ENIs in customer's account.
security_group_ids	array	Security Group IDs to be used on ENI.
subnet_id	string	Subnet must be in the AZ of the Flow
network_interface_ids	array	IDs of the network interfaces created in customer's account by MediaConnect.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	FlowArn, Name, RoleArn, SubnetId, SecurityGroupIds, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all flow_vpc_interfaces in a region.

SELECT
region,
flow_arn,
name,
role_arn,
security_group_ids,
subnet_id,
network_interface_ids
FROM aws.mediaconnect.flow_vpc_interfaces
WHERE region = 'us-east-1';

Gets all properties from an individual flow_vpc_interface.

SELECT
region,
flow_arn,
name,
role_arn,
security_group_ids,
subnet_id,
network_interface_ids
FROM aws.mediaconnect.flow_vpc_interfaces
WHERE region = 'us-east-1' AND data__Identifier = '<FlowArn>|<Name>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.mediaconnect.flow_vpc_interfaces (
 FlowArn,
 Name,
 RoleArn,
 SecurityGroupIds,
 SubnetId,
 region
)
SELECT 
'{{ FlowArn }}',
 '{{ Name }}',
 '{{ RoleArn }}',
 '{{ SecurityGroupIds }}',
 '{{ SubnetId }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.mediaconnect.flow_vpc_interfaces (
 FlowArn,
 Name,
 RoleArn,
 SecurityGroupIds,
 SubnetId,
 region
)
SELECT 
 '{{ FlowArn }}',
 '{{ Name }}',
 '{{ RoleArn }}',
 '{{ SecurityGroupIds }}',
 '{{ SubnetId }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: flow_vpc_interface
    props:
      - name: FlowArn
        value: '{{ FlowArn }}'
      - name: Name
        value: '{{ Name }}'
      - name: RoleArn
        value: '{{ RoleArn }}'
      - name: SecurityGroupIds
        value:
          - '{{ SecurityGroupIds[0] }}'
      - name: SubnetId
        value: '{{ SubnetId }}'

DELETE example

/*+ delete */
DELETE FROM aws.mediaconnect.flow_vpc_interfaces
WHERE data__Identifier = '<FlowArn|Name>'
AND region = 'us-east-1';

Permissions

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

Create

iam:PassRole,
mediaconnect:DescribeFlow,
mediaconnect:AddFlowVpcInterfaces

Read

mediaconnect:DescribeFlow

Update

mediaconnect:DescribeFlow,
mediaconnect:AddFlowVpcInterfaces,
mediaconnect:RemoveFlowVpcInterface

Delete

mediaconnect:DescribeFlow,
mediaconnect:RemoveFlowVpcInterface

List

mediaconnect:DescribeFlow