aws-kinesis-stream

Amazon Kinesis is a fully-managed real-time data streaming and processing service offered by Amazon Web Services.

---

Design

For detailed information, check out our Operator Guide for this bundle.

Usage

Our bundles aren't intended to be used locally, outside of testing. Instead, our bundles are designed to be configured, connected, deployed and monitored in the Massdriver platform.

What are Bundles?

Bundles are the basic building blocks of infrastructure, applications, and architectures in Massdriver. Read more here.

Bundle

Params

Form input parameters for configuring a bundle for deployment.

View

Properties

• capacity (object): Capacity settings for managed or manualy sharding.
  • stream_mode (string): Must be one of: ['ON_DEMAND', 'PROVISIONED'].
• observability (object)
  • enable_shard_level_metrics (boolean): Shard level metrics give insight in to per partition metrics. Only use these in advanced usecases of kinesis. Default: False.
• stream (object)
  • region (string)
  • retention_hours (integer): The number of hours in which to keep data in a Kinesis stream. Minimum: 24. Maximum: 8760. Default: 24.

Examples

{
    "__name": "Development",
    "capacity": {
        "shard_count": 4,
        "stream_mode": "PROVISIONED"
    }
}

{
    "__name": "Production",
    "capacity": {
        "shard_count": 16,
        "stream_mode": "PROVISIONED"
    }
}

{
    "__name": "Managed Capacity",
    "capacity": {
        "stream_mode": "ON_DEMAND"
    }
}

Connections

Connections from other bundles that this bundle depends on.

View

Properties

• aws_authentication (object): . Cannot contain additional properties.
  • data (object)

    • arn (string): Amazon Resource Name.

      Examples:

      "arn:aws:rds::ACCOUNT_NUMBER:db/prod"

      "arn:aws:ec2::ACCOUNT_NUMBER:vpc/vpc-foo"

    • external_id (string): An external ID is a piece of data that can be passed to the AssumeRole API of the Security Token Service (STS). You can then use the external ID in the condition element in a role's trust policy, allowing the role to be assumed only when a certain value is present in the external ID.

  • specs (object)
    • aws (object): .

      • region (string): AWS Region to provision in.

        Examples:

        "us-west-2"

Artifacts

Resources created by this bundle that can be connected to other bundles.

View

Properties

• stream (object): . Cannot contain additional properties.
  • data (object)

    • infrastructure (object)

      • arn (string): Amazon Resource Name.

        Examples:

        "arn:aws:rds::ACCOUNT_NUMBER:db/prod"

        "arn:aws:ec2::ACCOUNT_NUMBER:vpc/vpc-foo"

    • security (object): Informs downstream services of network and/or IAM policies. Cannot contain additional properties.

      • iam (object): IAM Policies. Cannot contain additional properties.

        • ^[a-z]+[a-z_]*[a-z]+$ (object)

          • policy_arn (string): AWS IAM policy ARN.

            Examples:

            "arn:aws:rds::ACCOUNT_NUMBER:db/prod"

            "arn:aws:ec2::ACCOUNT_NUMBER:vpc/vpc-foo"

      • identity (object): For instances where IAM policies must be attached to a role attached to an AWS resource, for instance AWS Eventbridge to Firehose, this attribute should be used to allow the downstream to attach it's policies (Firehose) directly to the IAM role created by the upstream (Eventbridge). It is important to remember that connections in massdriver are one way, this scheme perserves the dependency relationship while allowing bundles to control the lifecycles of resources under it's management. Cannot contain additional properties.

        • role_arn (string): ARN for this resources IAM Role.

          Examples:

          "arn:aws:rds::ACCOUNT_NUMBER:db/prod"

          "arn:aws:ec2::ACCOUNT_NUMBER:vpc/vpc-foo"

      • network (object): AWS security group rules to inform downstream services of ports to open for communication. Cannot contain additional properties.

        • ^[a-z-]+$ (object)

          • arn (string): Amazon Resource Name.

            Examples:

            "arn:aws:rds::ACCOUNT_NUMBER:db/prod"

            "arn:aws:ec2::ACCOUNT_NUMBER:vpc/vpc-foo"

          • port (integer): Port number. Minimum: 0. Maximum: 65535.

          • protocol (string): Must be one of: ['tcp', 'udp'].

  • specs (object)
    • aws (object): .

      • region (string): AWS Region to provision in.

        Examples:

        "us-west-2"

Contributing

Bug Reports & Feature Requests

Did we miss something? Please submit an issue to report any bugs or request additional features.

Developing

Note: Massdriver bundles are intended to be tightly use-case scoped, intention-based, reusable pieces of IaC for use in the Massdriver platform. For this reason, major feature additions that broaden the scope of an existing bundle are likely to be rejected by the community.

Still want to get involved? First check out our contribution guidelines.

Fix or Fork

If your use-case isn't covered by this bundle, you can still get involved! Massdriver is designed to be an extensible platform. Fork this bundle, or create your own bundle from scratch!

Connect

Questions? Concerns? Adulations? We'd love to hear from you!

Please connect with us!