Skip to main content

Attini CDK Constructs

Project description

Attini CDK

The Attini CDK library contains AWS CDK constructs for creating Attini deployment plans using the CDK.

Attini allowed users to write deployment logic and package it together with the resources being deployed. The deployments are performed from within the AWS account and uses only serverless resources.

Together with the CDK the deployment logic can be we written in different programming languages.

For more information about Attini. Please visit the website. There are several guides on how to get started with different tasks.

Also check out the cdk examples repository, containing some minimalistic example implementations.

How to install

npm (Javascript/Typescript)

Run the following command:

npm i @attini/cdk
Maven (Java)

Add the following to your pom.xml file

<dependency>
    <groupId>io.attini.cdk</groupId>
    <artifactId>attini-cdk-lib</artifactId>
    <version>0.0.45</version>
</dependency>
PyPI(Python)

Run the following command:

pip install attini-cdk-lib

How to use

To use Attini you need both the Attini CLI installed on your local machine and the Attini framework installed in your AWS account. See the get started guide for installation instructions.

Start from the root of the folder/project containing the resources that should be deployed. First create a new folder that will contain the CDK project that will become the deployment plan. In the folder, create a new cdk project in the language you prefer.

mkdir deloyment-plan-proj
cd deloyment-plan-proj
cdk init --language typescript

Install the attini constructs in the new app.

npm i @attini/cdk

Update the deployment-plan-proj stack to extend "DeploymentPlanStack" instead of "Stack". This will add the transformation necessary for Attini to function. This is also the stack where you create your deployment plan (find some examples here). All Attini types are supported, for more information on the different types, please read the guides or documentation.

In order to create an Attini distribution (the package that will be deployed) you need to create an attini-config.yaml file containing some basic data, such as the distribution name and our package instructions.

For this example, it could look like this:

distributionName: typescript-cdk-demo
initDeployConfig:
  template: deployment-plan.yaml
  stackName: ${environment}-${distributionName}-deployment-plan

package:
  prePackage:
    commands:
      - cd deployment-plan-proj
      - npm install
      - cdk synth > ../deployment-plan.yaml

The package commands will synthesise the template. For more information about packing, see the package a distribution guide.

The distribution can then be packaged and the deployed. From the root of the project, execute:

attini deploy run .

For more information about deploying a distribution. See the deploy a distribution guide.

Resources

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

attini-cdk-lib-1.1.1.tar.gz (276.5 kB view details)

Uploaded Source

Built Distribution

attini_cdk_lib-1.1.1-py3-none-any.whl (275.7 kB view details)

Uploaded Python 3

File details

Details for the file attini-cdk-lib-1.1.1.tar.gz.

File metadata

  • Download URL: attini-cdk-lib-1.1.1.tar.gz
  • Upload date:
  • Size: 276.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.2

File hashes

Hashes for attini-cdk-lib-1.1.1.tar.gz
Algorithm Hash digest
SHA256 5ceaeff11ce1fb8c064a62628271bdb0fd839996251e69b8f985b5d9c56ddcb5
MD5 67ac80cd5a66d99de3f5afb6b17bebc1
BLAKE2b-256 921b4653430556f1386951bc5a23befd4a261cb70f9f651f21c0e72622161f13

See more details on using hashes here.

File details

Details for the file attini_cdk_lib-1.1.1-py3-none-any.whl.

File metadata

  • Download URL: attini_cdk_lib-1.1.1-py3-none-any.whl
  • Upload date:
  • Size: 275.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.2

File hashes

Hashes for attini_cdk_lib-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ac3953152551eed14bc3cac4562affef4891ed6ed83fb11fe37a1320849957e4
MD5 2009e9ac42c039ca945e07e45074603e
BLAKE2b-256 3de5599c28f3b9cf3b81b4cb441db5d3aaa4ef4b6676892715d15417f5c31519

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page