Generate Connection Template

Returns the URLs for AWS CloudFormation and terraform templates corresponding to a given configuration of asset types.

application/json

Request Body

asset_types_enabled string[]
The asset types for which the template is to be generated. Valid values are any of ["EC2/EBS", "RDS", "DynamoDB", "EC2MSSQL", "S3", "EBS"].

NOTE -
1. EC2/EBS is required for EC2MSSQL.
2. EBS as a value is deprecated in favor of EC2/EBS.
aws_account_id string
Account ID for the AWS environment to be connected Mandatory to pass a 12 digit string if show_manual_resources is set to true
aws_region string
AWS Region of the AWS environment to be connected Mandatory to pass a non-empty string if show_manual_resources is set to true
show_manual_resources boolean
Returns the resources to be created manually if set to true

Responses

200
default

Success

application/api.clumio.aws-templates=v1+json

Schema
Example (from schema)

Schema

_links object
URLs to pages related to the resource.
_self object
The HATEOAS link to this resource.
href string
The URI for the referenced operation.
templated boolean
Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.
type string
The HTTP method to be used with the "href" link for the referenced operation.
cloudformation_url string
The latest available URL for the template.
config object
The configuration of the given template
asset_types_enabled string[]
The AWS asset types supported with the available version of the template.
available_template_version string
The latest available version for the template.
dynamodb object
The latest available information for the DynamoDB feature.
available_template_version string
The latest available feature version for the asset.
ebs object
available_template_version string
The latest available feature version for the asset.
ec2 object
available_template_version string
The latest available feature version for the asset.
ec2_mssql object
The latest available information for the EC2 MSSQL feature.
available_template_version string
The latest available feature version for the asset.
rds object
available_template_version string
The latest available feature version for the asset.
s3 object
The latest available information for the S3 feature.
available_template_version string
The latest available feature version for the asset.
warm_tier_protect object
Configuration information about the Warm-Tier Protect feature of the template.
asset_types_enabled string[]
The AWS asset types supported with the available version of the template.
available_template_version string
The latest available version for the template.
dynamodb object
The latest available information for the DynamoDB feature.
available_template_version string
The latest available feature version for the asset.
deployable_cloudformation_url string
The latest available URL for the deployable template.
resources object
Categorised Resources, based on the generated template, to be created manually by the user
policies object
Consists of policies that are not attached to any other resource (Roles, Topics, Rules)
property name* object
roles object
Consists of the IAM Roles and the attached policies
property name* object
rules object
Consists of the EventBridge Rules
property name* object
ssm_documents object
Consists of SSM Documents
property name* object
topics object
Consists of the SNS Topics
property name* object
terraform_url string
The latest available URL for the terraform template.

{
  "_links": {
    "_self": {
      "href": "string",
      "templated": true,
      "type": "string"
    }
  },
  "cloudformation_url": "string",
  "config": {
    "asset_types_enabled": [
      "string"
    ],
    "available_template_version": "string",
    "dynamodb": {
      "available_template_version": "string"
    },
    "ebs": {
      "available_template_version": "string"
    },
    "ec2": {
      "available_template_version": "string"
    },
    "ec2_mssql": {
      "available_template_version": "string"
    },
    "rds": {
      "available_template_version": "string"
    },
    "s3": {
      "available_template_version": "string"
    },
    "warm_tier_protect": {
      "asset_types_enabled": [
        "string"
      ],
      "available_template_version": "string",
      "dynamodb": {
        "available_template_version": "string"
      }
    }
  },
  "deployable_cloudformation_url": "string",
  "resources": {
    "policies": {},
    "roles": {},
    "rules": {},
    "ssm_documents": {},
    "topics": {}
  },
  "terraform_url": "string"
}

Error

application/json

Schema
Example (from schema)

Schema

errors object[]
A list of errors encountered during runtime.
error_code uint32
error_message string
The reason for the error.

{
  "errors": [
    {
      "error_code": 0,
      "error_message": "string"
    }
  ]
}

POST /connections/aws/templates

Authorization

Request

Click Edit to configure Base URL

https://us-west-2.api.clumio.com

Bearer Token

Body

{
  "asset_types_enabled": [
    "string"
  ],
  "aws_account_id": "string",
  "aws_region": "string",
  "show_manual_resources": true
}

curl -L -X POST 'https://us-west-2.api.clumio.com/connections/aws/templates' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.aws-templates=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "asset_types_enabled": [
    "string"
  ],
  "aws_account_id": "string",
  "aws_region": "string",
  "show_manual_resources": true
}'

curl -L -X POST 'https://us-west-2.api.clumio.com/connections/aws/templates' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.aws-templates=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "asset_types_enabled": [
    "string"
  ],
  "aws_account_id": "string",
  "aws_region": "string",
  "show_manual_resources": true
}'

curl -L -X POST 'https://us-west-2.api.clumio.com/connections/aws/templates' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.aws-templates=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "asset_types_enabled": [
    "string"
  ],
  "aws_account_id": "string",
  "aws_region": "string",
  "show_manual_resources": true
}'

curl -L -X POST 'https://us-west-2.api.clumio.com/connections/aws/templates' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.aws-templates=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "asset_types_enabled": [
    "string"
  ],
  "aws_account_id": "string",
  "aws_region": "string",
  "show_manual_resources": true
}'

curl -L -X POST 'https://us-west-2.api.clumio.com/connections/aws/templates' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.aws-templates=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "asset_types_enabled": [
    "string"
  ],
  "aws_account_id": "string",
  "aws_region": "string",
  "show_manual_resources": true
}'

curl -L -X POST 'https://us-west-2.api.clumio.com/connections/aws/templates' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.aws-templates=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "asset_types_enabled": [
    "string"
  ],
  "aws_account_id": "string",
  "aws_region": "string",
  "show_manual_resources": true
}'

curl -L -X POST 'https://us-west-2.api.clumio.com/connections/aws/templates' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.aws-templates=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "asset_types_enabled": [
    "string"
  ],
  "aws_account_id": "string",
  "aws_region": "string",
  "show_manual_resources": true
}'

Generate Connection Template​

Authorization

Request

Generate Connection Template