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	awscc.mediaconnect.flow_vpc_interfaces

Fields

get (all properties)

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.

list (identifiers only)

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.
region	string	AWS region.

For more information, see AWS::MediaConnect::FlowVpcInterface.

Methods

Name	Resource	Accessible by	Required Params
create_resource	flow_vpc_interfaces	INSERT	FlowArn, Name, RoleArn, SubnetId, SecurityGroupIds, region
delete_resource	flow_vpc_interfaces	DELETE	Identifier, region
update_resource	flow_vpc_interfaces	UPDATE	Identifier, PatchDocument, region
list_resources	flow_vpc_interfaces_list_only	SELECT	region
get_resource	flow_vpc_interfaces	SELECT	Identifier, region

SELECT examples

get (all properties)

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 awscc.mediaconnect.flow_vpc_interfaces
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ flow_arn }}|{{ name }}';

list (identifiers only)

Lists all flow_vpc_interfaces in a region.

SELECT
  region,
  flow_arn,
  name
FROM awscc.mediaconnect.flow_vpc_interfaces_list_only
WHERE
  region = '{{ region }}';

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 awscc.mediaconnect.flow_vpc_interfaces (
  FlowArn,
  Name,
  RoleArn,
  SecurityGroupIds,
  SubnetId,
  region
)
SELECT
  '{{ flow_arn }}',
  '{{ name }}',
  '{{ role_arn }}',
  '{{ security_group_ids }}',
  '{{ subnet_id }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.mediaconnect.flow_vpc_interfaces (
  FlowArn,
  Name,
  RoleArn,
  SecurityGroupIds,
  SubnetId,
  region
)
SELECT
  '{{ flow_arn }}',
  '{{ name }}',
  '{{ role_arn }}',
  '{{ security_group_ids }}',
  '{{ subnet_id }}',
  '{{ 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: flow_vpc_interface
  props:
    - name: flow_arn
      value: '{{ flow_arn }}'
    - name: name
      value: '{{ name }}'
    - name: role_arn
      value: '{{ role_arn }}'
    - name: security_group_ids
      value:
        - '{{ security_group_ids[0] }}'
    - name: subnet_id
      value: '{{ subnet_id }}'

UPDATE example

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

/*+ update */
UPDATE awscc.mediaconnect.flow_vpc_interfaces
SET PatchDocument = string('{{ {
    "RoleArn": role_arn,
    "SecurityGroupIds": security_group_ids,
    "SubnetId": subnet_id
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ flow_arn }}|{{ name }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.mediaconnect.flow_vpc_interfaces
WHERE
  Identifier = '{{ flow_arn }}|{{ name }}' 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 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