awscc.kinesis_stream

Filters

  • event

  • reduce

  • value

Actions

delete

Parent base class for filters and actions.

properties:
  type:
    enum:
    - delete
required:
- type

Permissions - kinesis:DescribeStreamSummary, kinesis:DeleteStream, kinesis:RemoveTagsFromStream

update

Parent base class for filters and actions.

definitions:
  StreamEncryption:
    additionalProperties: false
    description: When specified, enables or updates server-side encryption using an
      AWS KMS key for a specified stream. Removing this property from your stack template
      and updating your stack disables encryption.
    properties:
      EncryptionType:
        description: 'The encryption type to use. The only valid value is KMS. '
        enum:
        - KMS
        type: string
      KeyId:
        description: The GUID for the customer-managed AWS KMS key to use for encryption.
          This value can be a globally unique identifier, a fully specified Amazon
          Resource Name (ARN) to either an alias or a key, or an alias name prefixed
          by "alias/".You can also use a master key owned by Kinesis Data Streams
          by specifying the alias aws/kinesis.
        maxLength: 2048
        minLength: 1
        type: string
    required:
    - EncryptionType
    - KeyId
    type: object
  StreamModeDetails:
    additionalProperties: false
    description: When specified, enables or updates the mode of stream. Default is
      PROVISIONED.
    properties:
      StreamMode:
        description: The mode of the stream
        enum:
        - ON_DEMAND
        - PROVISIONED
        type: string
    required:
    - StreamMode
    type: object
  Tag:
    additionalProperties: false
    description: An arbitrary set of tags (key-value pairs) to associate with the
      Kinesis stream.
    properties:
      Key:
        description: 'The key name of the tag. You can specify a value that is 1 to
          128 Unicode characters in length and cannot be prefixed with aws:. You can
          use any of the following characters: the set of Unicode letters, digits,
          whitespace, _, ., /, =, +, and -.'
        maxLength: 128
        minLength: 1
        type: string
      Value:
        description: 'The value for the tag. You can specify a value that is 0 to
          255 Unicode characters in length and cannot be prefixed with aws:. You can
          use any of the following characters: the set of Unicode letters, digits,
          whitespace, _, ., /, =, +, and -.'
        maxLength: 255
        minLength: 0
        type: string
    required:
    - Key
    - Value
    type: object
properties:
  RetentionPeriodHours:
    description: The number of hours for the data records that are stored in shards
      to remain accessible.
    minimum: 24
    type: integer
  ShardCount:
    description: The number of shards that the stream uses. Required when StreamMode
      = PROVISIONED is passed.
    minimum: 1
    type: integer
  StreamEncryption:
    additionalProperties: false
    description: When specified, enables or updates server-side encryption using an
      AWS KMS key for a specified stream. Removing this property from your stack template
      and updating your stack disables encryption.
    properties:
      EncryptionType:
        description: 'The encryption type to use. The only valid value is KMS. '
        enum:
        - KMS
        type: string
      KeyId:
        description: The GUID for the customer-managed AWS KMS key to use for encryption.
          This value can be a globally unique identifier, a fully specified Amazon
          Resource Name (ARN) to either an alias or a key, or an alias name prefixed
          by "alias/".You can also use a master key owned by Kinesis Data Streams
          by specifying the alias aws/kinesis.
        maxLength: 2048
        minLength: 1
        type: string
    required:
    - EncryptionType
    - KeyId
    type: object
  StreamModeDetails:
    additionalProperties: false
    description: When specified, enables or updates the mode of stream. Default is
      PROVISIONED.
    properties:
      StreamMode:
        description: The mode of the stream
        enum:
        - ON_DEMAND
        - PROVISIONED
        type: string
    required:
    - StreamMode
    type: object
  Tags:
    description: "An arbitrary set of tags (key\u2013value pairs) to associate with\
      \ the Kinesis stream."
    insertionOrder: false
    items:
      additionalProperties: false
      description: An arbitrary set of tags (key-value pairs) to associate with the
        Kinesis stream.
      properties:
        Key:
          description: 'The key name of the tag. You can specify a value that is 1
            to 128 Unicode characters in length and cannot be prefixed with aws:.
            You can use any of the following characters: the set of Unicode letters,
            digits, whitespace, _, ., /, =, +, and -.'
          maxLength: 128
          minLength: 1
          type: string
        Value:
          description: 'The value for the tag. You can specify a value that is 0 to
            255 Unicode characters in length and cannot be prefixed with aws:. You
            can use any of the following characters: the set of Unicode letters, digits,
            whitespace, _, ., /, =, +, and -.'
          maxLength: 255
          minLength: 0
          type: string
      required:
      - Key
      - Value
      type: object
    type: array
    uniqueItems: false
  type:
    enum:
    - update

Permissions - kinesis:DescribeStreamSummary, kinesis:UpdateShardCount, kinesis:UpdateStreamMode, kinesis:IncreaseStreamRetentionPeriod, kinesis:DecreaseStreamRetentionPeriod, kinesis:StartStreamEncryption, kinesis:StopStreamEncryption, kinesis:AddTagsToStream, kinesis:RemoveTagsFromStream, kinesis:ListTagsForStream