network_insights_access_scopes

Creates, updates, deletes or gets a network_insights_access_scope resource or lists network_insights_access_scopes in a region

Overview

Name	network_insights_access_scopes
Type	Resource
Description	Resource schema for AWS::EC2::NetworkInsightsAccessScope
Id	awscc.ec2.network_insights_access_scopes

Fields

get (all properties)

Name	Datatype	Description
network_insights_access_scope_id	string
network_insights_access_scope_arn	string
created_date	string
updated_date	string
▶tags	array
▶match_paths	array
exclude_paths	array
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
network_insights_access_scope_id	string
region	string	AWS region.

For more information, see AWS::EC2::NetworkInsightsAccessScope.

Methods

Name	Resource	Accessible by	Required Params
create_resource	network_insights_access_scopes	INSERT	region
delete_resource	network_insights_access_scopes	DELETE	Identifier, region
update_resource	network_insights_access_scopes	UPDATE	Identifier, PatchDocument, region
list_resources	network_insights_access_scopes_list_only	SELECT	region
get_resource	network_insights_access_scopes	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual network_insights_access_scope.

SELECT
  region,
  network_insights_access_scope_id,
  network_insights_access_scope_arn,
  created_date,
  updated_date,
  tags,
  match_paths,
  exclude_paths
FROM awscc.ec2.network_insights_access_scopes
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ network_insights_access_scope_id }}';

list (identifiers only)

Lists all network_insights_access_scopes in a region.

SELECT
  region,
  network_insights_access_scope_id
FROM awscc.ec2.network_insights_access_scopes_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.ec2.network_insights_access_scopes (
  Tags,
  MatchPaths,
  ExcludePaths,
  region
)
SELECT
  '{{ tags }}',
  '{{ match_paths }}',
  '{{ exclude_paths }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.ec2.network_insights_access_scopes (
  Tags,
  MatchPaths,
  ExcludePaths,
  region
)
SELECT
  '{{ tags }}',
  '{{ match_paths }}',
  '{{ exclude_paths }}',
  '{{ 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: network_insights_access_scope
  props:
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'
    - name: match_paths
      value:
        - source:
            packet_header_statement:
              source_addresses:
                - '{{ source_addresses[0] }}'
              destination_addresses:
                - '{{ destination_addresses[0] }}'
              source_ports:
                - '{{ source_ports[0] }}'
              destination_ports:
                - '{{ destination_ports[0] }}'
              source_prefix_lists:
                - '{{ source_prefix_lists[0] }}'
              destination_prefix_lists:
                - '{{ destination_prefix_lists[0] }}'
              protocols:
                - '{{ protocols[0] }}'
            resource_statement:
              resources:
                - '{{ resources[0] }}'
              resource_types:
                - '{{ resource_types[0] }}'
          destination: null
          through_resources:
            - resource_statement: null
    - name: exclude_paths
      value:
        - null

UPDATE example

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

/*+ update */
UPDATE awscc.ec2.network_insights_access_scopes
SET PatchDocument = string('{{ {
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ network_insights_access_scope_id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.ec2.network_insights_access_scopes
WHERE
  Identifier = '{{ network_insights_access_scope_id }}' 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 network_insights_access_scopes resource, the following permissions are required:

Create

ec2:CreateNetworkInsightsAccessScope,
ec2:CreateTags,
tiros:CreateQuery

Read

ec2:DescribeNetworkInsightsAccessScopes,
ec2:GetNetworkInsightsAccessScopeContent

Update

ec2:DescribeNetworkInsightsAccessScopes,
ec2:GetNetworkInsightsAccessScopeContent,
ec2:CreateTags,
ec2:DeleteTags

Delete

ec2:DeleteNetworkInsightsAccessScope,
ec2:DeleteTags

List

ec2:DescribeNetworkInsightsAccessScopes