log_streams

Creates, updates, deletes or gets a log_stream resource or lists log_streams in a region

Overview

Name	log_streams
Type	Resource
Description	Resource Type definition for AWS::Logs::LogStream
Id	awscc.logs.log_streams

Fields

get (all properties)

Name	Datatype	Description
log_stream_name	string	The name of the log stream. The name must be unique wihtin the log group.
log_group_name	string	The name of the log group where the log stream is created.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
log_stream_name	string	The name of the log stream. The name must be unique wihtin the log group.
log_group_name	string	The name of the log group where the log stream is created.
region	string	AWS region.

For more information, see AWS::Logs::LogStream.

Methods

Name	Resource	Accessible by	Required Params
create_resource	log_streams	INSERT	LogGroupName, region
delete_resource	log_streams	DELETE	Identifier, region
list_resources	log_streams_list_only	SELECT	region
get_resource	log_streams	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual log_stream.

SELECT
  region,
  log_stream_name,
  log_group_name
FROM awscc.logs.log_streams
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ log_group_name }}|{{ log_stream_name }}';

list (identifiers only)

Lists all log_streams in a region.

SELECT
  region,
  log_group_name,
  log_stream_name
FROM awscc.logs.log_streams_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.logs.log_streams (
  LogGroupName,
  region
)
SELECT
  '{{ log_group_name }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.logs.log_streams (
  LogStreamName,
  LogGroupName,
  region
)
SELECT
  '{{ log_stream_name }}',
  '{{ log_group_name }}',
  '{{ 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: log_stream
  props:
    - name: log_stream_name
      value: '{{ log_stream_name }}'
    - name: log_group_name
      value: '{{ log_group_name }}'

DELETE example

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

Read

logs:DescribeLogStreams

Create

logs:CreateLogStream,
logs:DescribeLogStreams

List

logs:DescribeLogStreams

Delete

logs:DeleteLogStream