Connection Interface Type Contracts

In this section, you will find details about Connection Interface Type Contracts.

Each Connection Interface refers to a type specifying a contract with a list of all attributes.

You can use these contracts. Check the Connection Interface Type contracts available:

AWS

aws-dynamo-conn

Connection Interface for AWS Dynamo. It allows you to run applications on a NoSQL key-value database.

See the output below:

Output	Type	Description
arn	String	Amazon ARN.
table_name	String	Table name.

aws-ecr-conn

Connection Interface for AWS ECR. It allows you to store, share, and deploy container software.

See the output below:

Output	Type	Description
repository_url	String	Repository URL.
arn	String	Amazon ARN.

aws-eks-conn

Connection Interface for AWS EKS lets you connect to the Kubernetes-managed service. It ensures your containers run without installing and operating your nodes or management environments.

See the output below:

Output	Type	Description
cluster_name	String	EKS Cluster name.
cluster_endpoint	String	Endpoint for your Kubernetes API server.
cluster_ca_certificate	String	Certificate authorizes communication with the Cluster API.
account_id	String	AWS account id.
region	String	Region. For example: us-east-1.
eks_oidc_id	String	OpenId authorized to perform actions on the Cluster, such as listing and deployment, for example.

aws-iam-role-conn

Connection Interface for AWS IAM Role. It allows you to create a new role for your AWS account.

See the output below:

Output	Type	Description
arn	String	Amazon ARN.
name	String	Indicates the role's name.

aws-s3-conn

Connection Interface for AWS S3. It allows you to store objects safely and with scalability.

See the output below:

Output	Type	Description
arn	String	Amazon ARN.
bucket_name	String	Name of the AWS Bucket.

aws-secret-manager-conn

Connection Interface for AWS Secret Manager. You can manage, change, and recover credentials. It helps to secure access to cloud applications and resources.

See the output below:

Output	Type	Description
arn	String	Amazon ARN.
name	String	Connection Interface name.

aws-sns-conn

Connection Interface for AWS SNS. It allows you to send notifications in two ways: A2A and A2P.

See the output below:

Output	Type	Description
arn	String	Amazon ARN.
topic_name	String	Topic name.

aws-sqs-conn

Connection Interface for AWS SQS. It allows you to send, store, and receive messages between software components on any volume.

See the output below:

Output	Type	Description
queue_name	String	Queue name.
url	String	Repository URL.
arn	String	Amazon ARN.

aws-rds-conn

Connection Interface for AWS RDS. It allows integration with the SQL database managed service. It helps configure, operate, and scale relational data.

See the output below:

Output	Type	Description
engine	String	The database engine that will be used.
engine_version	String	The version of the engine.
name	String	Connection Interface name.
host	String	It is the Endpoint that connects to the DB.
port	String	The port on which DB accepts connections
user	String	User who will use the DB master.
pass	Secret	Password used by the DB master.

aws-glue-registry-conn

Connection Interface of the Glue Schema Registry. It allows you to share connection information to the AWS Schema Registry. It is for data operations in K-ISMS and MSK.

See the output below:

Output	Type	Description
name	String	Registry name.
arn	String	Registry ARN.

aws-glue-job-conn

It is an AWS Glue Jobs Connection Interface that provides the name and ARN of the job created in the Glue service. It connects to workflows and triggers.

See the output below:

Output	Type	Description
name	String	Job name.
arn	String	Job ARN.

aws-glue-crawler-conn

Connection Interface of the AWS Glue Crawler used to inform the job of the crawler created and connect to the workflow and trigger.

See the output below:

Output	Type	Description
name	String	Job name.
arn	String	Job ARN.

aws-glue-workflow-conn

It is a Connection Interface of the AWS Glue Workflow type. It allows you to add the workflow's name and ARN to connect jobs, triggers, and crawlers of the AWS Glue service. They handle centralized management. To summarize, it is the workflow for the entire Glue job structure.

See the output below:

Output	Type	Description
name	String	Workflow name.
arn	String	Workflow ARN.

aws-msk-cluster-conn

It is the Connection Interface of the MSK Cluster type. It provides the MSK Cluster connection information for applications using Pub/Sub, event-oriented structures, etc.

info

Pub/Sub is an asynchronous, scalable messaging service that separates the services that produce messages from the services that process those messages.

See the output below:

Output	Type	Description
name	String	Cluster name.
arn	String	Cluster ARN.
bootstrap_brokers	List	Brokers list using Bootstrap.
bootstrap_brokers_public_sasl_iam	List	Brokers list that is exposed to the public. It is used to make the IAM connection and authentication.
bootstrap_brokers_public_sasl_scram	List	List of public brokers used for authentication in the Scram format.
bootstrap_brokers_public_tls	List	List of public brokers using for TLS certificate.
bootstrap_brokers_sasl_iam	List	It is a default broker for IAM authentication.
bootstrap_brokers_sasl_scram	List	It is a default broker for Scram authentication.
bootstrap_brokers_tls	List	It is a default broker for a TLS certificate.
zookeeper_connect_string	List	List of node brokers to connect to Zookeeper. This will be used to manage the Cluster.
zookeeper_connect_string_tls	List	It uses an extra layer to connect to Zookeeper. In this case, it is the TLS certificate.

aws-msk-connector-conn

The Connection Interface states the ARN that connects to a pre-existing connector. It is a type of Kafka connector and can be used in observability, analysis, and workflows.

See the output below:

Output	Type	Description
name	String	Connector name.
arn	String	Connector ARN.

aws-msk-plugin-conn

It refers to the MSK Plugins resource. It indicates the name and the ARN of the Plugins used to create the connector. It is the source of the code that creates and designs an MSK connector.

Check out the outputs below:

Output	Type	Description
name	String	Plugin name.
arn	String	Plugin ARN.

aws-glue-trigger-conn

It is an AWS Triggers resource. It indicates the name and ARN of a Trigger created to initiate Glue jobs and Crawlers. Besides, this Connection Interface starts a job and a crawler.

See the output below:

Output	Type	Description
name	String	Trigger name.
arn	String	Trigger ARN.

aws-glue-database-conn

It is the Connection Interface of the AWS Glue Data Catalog or Glue Data Base. It refers to the name and ARN of the Database created within the Glue catalog. It is used in Analytics or data processing to state the database's origin.

See the output below:

Output	Type	Description
name	String	Database name.
arn	String	Database ARN.

aws-ecs-cluster

It is the Connection Interface of AWS ECS, representing a Cluster.

See the output below:

Output	Type	Description
name	String	Cluster name.
arn	String	Cluster ARN.
id	String	Cluster ID.

aws-ecs-container-definition

Connection Interface for AWS ECS represents a container definition (task).

See the output below:

Output	Type	Description
container_definition	String	Container definition.

aws-ecs-service

The Connection Interface for AWS ECS represents a service.

See the output below:

Output	Type	Description
name	String	Service name.
id	String	Service ID.

aws-lambda-function

The Connection Interface for AWS Lambda represents a function.

See the output below:

Output	Type	Description
arn	String	ARN function.
name	String	Name function.
version	String	Version function.

aws-kms-key

The Connection Interface for AWS KMS represents a key.

Output	Type	Description
arn	String	Key ARN.
id	String	Key ID.
alias	String	It is a friendly name for the key. It allows reference without using the ID. Refer to the AWS page for more information.

aws-system-manager-parameter-store-conn

Connection Interface for AWS System Manager. It is responsible for managing resources on AWS.

See the output below:

Output	Type	Description
id	String	Parameter Store ID from Fn::Ref
type	String	Parameter Store type
value	String	Parameter Store value

aws-ec2-conn

Connection Interface for AWS EC2. It is responsible for provisioning EC2 instances.

See the output below:

Output	Type	Description
id	String	EC2 instance ID
availability_zone	String	AZ of the EC2 instance
private_dns_name	String
private_ip	String	Private IP of the EC2 instance
public_dns_name	String	Public DNS of the EC2 instance
public_ip	String	Public IP of the EC2 instance

aws-transfer-family-conn

Connection Interface for AWS Transfer Family. It is responsible for managing data sharing.

See the output below:

Output	Type	Description
arn	String	Amazon arn
server_id	String	ServerId from the transfer family server.

aws-route53-hosted-zone-conn

Connection Interface for AWS Route53 Hosted Zone. It is responsible for working with hosted zones.

See the output below:

Output	Type	Description
id	String	ID from the HostedZone.
name_servers	String	NS from the HostedZone.

aws-acm-conn

Connection Interface for AWS ACM. It is responsible for provisioning and managing SSL/TLS certificates.

See the output below:

Output	Type	Description
arn	String	Amazon arn from Fn::Ref.

aws-redshift-conn

Connection Interface for AWS RedShift. It is responsible for using SQL to analyze structured data.

See the output below:

Output	Type	Description
cluster_namespace_arn	String	Amazon arn
endpoint_address	String	Redshift endpoint address
endpoint_port	String	Redshift endpoint port
master_password_secret_arn	String	Redshift Master Password

aws-efs-conn

The Connection Interface for AWS EFS stores files without a server.

See the output below:

Output	Type	Description
arn	String	Amazon arn
file_system_id	String	ID from the File System

aws-elasticache-redis-conn

The Connection Interface for AWS ElastiCache monitors application performance in real-time.

See the output below:

Output	Type	Description
ID	String	Elasticache's logical ID
redis_endpoint_address	String	Elasticache Port
redis_endpoint_port	String	Elasticache Port

aws-vpc-conn

The Connection Interface for AWS VPC defines and starts AWS resources.

See the outputs below:

Output	Type	Description	Item Type
name	String	The name of the VPC specified as argument to this module
azs	Array of items	A list of availability zones specified as argument to this module	String
default_vpc	Object	Default VPC Info	VPC
private_subnets	Array of items	A list of private subnets	Subnet
public_subnets	Array of items	A list of public subnets	Subnet
vpc	Object	VPC Info	VPC

See the object's items below:

• VPC:

Property	description	type	required
id	The ID of the VPC	String	Yes
arn	AWS ARN	String	Yes
cidr_block	The CIDR block of the VPC	String	Yes

• Subnet:

Property	Description	Type	Required
id	The ID of the subnet.	String	Yes
arn	AWS arn	String.	Yes
cidr_block	The CIDR block of the subnet.	String	Yes
name	Subnet name.	String	Yes

aws-dms-endpoints-conn

Connection Interface for [Endpoints AWS DMS] (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Endpoints.html). It connects to a datastore and migrates data from a source endpoint to a destination endpoint.

See the output below:

Output	Type	Description
arn	String	Amazon ARN.
endpoint_id	String	Endpoint ID.

aws-dms-replication-instance-conn

Connection Interface for AWS DMS Replication Instance. It is responsible for the replication instance.

See the output below:

Output	Type	Description
arn	String	Amazon ARN.
instance_id	String	Instance ID.

az-cosmos-db-conn

Connection Interface for Azure Cosmos DB. It allows you to execute applications in a NoSQL database.

See the output below:

Output	Type	Description
endpoint	String	The main endpoint for accessing the Cosmos DB account.
id	String	The unique ID of the Cosmos DB account.
primary_key	String	The primary key to access the Cosmos DB account.
ead_endpoints	String	List of reading endpoints available for the Cosmos DB account.
secondary_key	String	The secondary key to access the Cosmos DB account.
write_endpoints	String	List of writing endpoints available for the Cosmos DB account.

aws-cloudfront-conn

Connection Interface for AWS Cloudfront Distribution. It's used to make static and/or dynamic content available on the web.

See the output below:

Output	Type	Description
arn	String	Amazon ARN.
name	String	Name of the generated Cloudfront.

aws-cloudfront-conn-v2

Connection Interface for AWS Cloudfront Distribution with an Origins record. It's used to make static and/or dynamic content available on the web.

See the output below:

Output	Type	Description
arn	String	Amazon ARN.
name	String	Name of the generated Cloudfront.
origins	Array of origin	A list of content origins.

See the object items:

• origins

Property	Description	Type	Required
domain_name	DNS domain name of either the S3 bucket, or web site of your custom origin.	String	Yes
origin_id	Unique identifier for the origin.	String	Yes
path	Optional element that causes CloudFront to request your content from a directory in your Amazon S3 bucket or your custom origin.	String	No

aws-cloudfront-conn-v2

Connection Interface for AWS Cloudfront Distribution, with an Origins registry. It is used to make static and/or dynamic content available on the web.

See the output below:

Output	Type	Description
arn	String	Amazon ARN.
name	String	Name of the generated Cloudfront.
origins	Array of origin	A list of content sources.

See the object's items below:

• origins | Property |Description | Type | Required | |---------------|----------------|----------|--------------| | domain_name | DNS domain name of any S3 bucket or custom Origin site. | String | Yes | | origin_id | Unique ID for Origin. | String | Yes. | | path | Optional element that makes CloudFront request your content from a directory in your Amazon S3 bucket or your custom origin. | String | No. |

aws-security-group-conn

Connection Interface for AWS Security Group. It represents a security group that acts as a virtual firewall for EC2 instances.

See the output below:

Output	Type	Description
arn	String	Amazon ARN.
name	String	Security Group name.
sgid	String	Security Group Id.

aws-eventbridge-scheduler-conn

Connection Interface for AWS Event Bridge Scheduler. It is responsible for creating and managing tasks from a centrally managed service.

See the output below:

Output	Type	Description
arn	String	Amazon ARN.

aws-eventbridge-conn

Connection Interface for AWS Event Bridge. It represents a serverless service that uses events to connect application components.

See the output below:

Output	Type	Description
arn	String	Amazon ARN.
name	String	Event name.
rule_arn	String	The ARN of the Event Bridge rule. If multiple, separate with a comma.

aws-documentdb-conn

Connection Interface for DocumentDB. It represents a native JSON document database.

See the output below:

Output	Type	Description
arn	String	Amazon ARN.
name	String	Name of the generated document database.
endpoint	String	Server's address.
port	Number	Connection port.
user	String	User to connect to the bank.
pass	String (sensitive)	Password for connecting to the bank.

aws-codedeploy-conn

Connection Interface for AWS CodeDeploy. It makes it easier to launch new features quickly.

See the output below:

Output	Type	Description
application_arn	String	O ARN da aplicação de CodeDeploy.
application_id	String	Application ID.
application_name	String	Application name.
deployment_groups	Object	Deployment group list.

Check the items in the deployment group object, which has the following schema:

{"type": "array", "items": {"type": "object", "required": ["arn", "id", "name"], "properties": {"id": {"type": "string"}, "arn": {"type": "string"}, "name": {"type": "string"}}, "description": "CodeDeploy Deployment Group"}}

Output	Description
arn	The ARN of the CodeDeploy deployment group.
id	Application name and deploy group name.
name	Name of the deployment group.

aws-api-gateway-rest-conn

Connection Interface for AWS REST API. It represents a set of methods and resources for integrating with endpoints, Lambda functions or other AWS services.

See the output below:

Output	Type	Description
gateway_id	String	API REST ID.
arn	String	Gateway ARN.

aws-state-machine-conn

Connection Interface for AWS Step Function. It represents a visual workflow service that helps developers use AWS products to develop distributed applications.

See the output below:

Output	Type	Description
arn	String	Step Function ARN.
name	String	Step Function name.
id	String	Step Function ID.

aws-vpc-endpoint-conn

Connection Interface for VPC Endpoint. It represents a private connection that allows communication between AWS services and resources in a VPC without needing an Internet gateway.

See the output below:

Output	Type	Description
vpc_endpoint_id	String	The ID of the VPC Endpoint.
vpc_endpoint_name	String	The name of the VPC Endpoint.
dns_entry	String	The DNS entry associated with the VPC Endpoint.

aws-vpc-link-conn

Connection Interface for VPC Link from the AWS API Gateway resource.

See the output below:

Output	Type	Description
id	String	The ID of the VPC Link.
name	String	The name of the link.

aws-data-firehose-conn

Connection Interface for Amazon Data Firehose.

See the output below:

Output	Type	Description
arn	String	Data Firehose ARN.
name	String	Firehose Name.

aws-target-group-conn

Connection Interface for AWS Target Group. It allows you to configure and manage Target Groups for load balancing on AWS.

See the output below:

Output	Type	Description
arn	String	ARN of the Target Group in AWS.
name	String	The name of the Target Group.

aws-elasticache-redis-conn-v2

Connection Interface for AWS ElastiCache with Redis (version 2). It allows applications to connect to a managed Redis Cluster on AWS, with support for authentication, multiple hosts, and different connection modes.

See the output below:

Output	Type	Description
additional_hosts	String	List of additional hosts available in the Redis cluster.
auth_password_secret_path	String	Path to the secret containing the authentication password in the secrets manager service.
connection_mode	String	Connection mode with the Cluster.
port	Number	Port used to connect to Redis.
primary_host	String	Main host of the Redis cluster.

aws-elb-network-conn-v2

Connection Interface for AWS Elastic Load Balancer (v2).

See the outputs below:

Output	Type	Description
name	String	Name of the Load Balancer created in AWS.
arn	String	Amazon Resource Name (ARN) of the Load Balancer.
dns	String	DNS of the Load Balancer.
vpc_link_id	String	The VPC Link identifier associated with the Load Balancer.

aws-codedeploy-appspec-conn

Connection Interface to create app specification for AWS CodeDeploy.

See the outputs below:

Output	Type	Description
json_spec	String	AppSpec template file in JSON format.
revision	String	AppSpec file version.

aws-custom-domain-conn

Connection Interface for AWS Custom Domain.

See the outputs below:

Output	Type	Description
arn	String	Resource ARN.
id	String	Resource Id.

aws-ecs-taskdefinition-conn

Connection Interface for AWS ECS Task Definition applications.

See the outputs below:

Output	Type	Description
arn	String	Resource ARN.
json_spec	String	Task Definition template file in JSON format.

aws-elb-application-conn

Connection Interface for AWS Application Load Balancer.

See the outputs below:

Output	Type	Description
arn	String	Resource ARN.
name	String	Load Balancer’s name.

aws-elb-conn

Connection Interface for AWS Elastic Load Balancer.

See the outputs below:

Output	Type	Description
arn	String	Resource ARN.
name	String	Load Balancer’s name.

aws-elb-network-conn

Connection Interface for AWS Network Load Balancer.

See the outputs below:

Output	Type	Description
arn	String	Resource ARN.
name	String	Load Balancer’s name.

aws-rds-vault-conn

Connection Interface to integrate RDS with Vault.

See the outputs below:

Output	Type	Description
arn	String	Resource ARN.
endpoint	String	The endpoint that connects to the Database.
engine	String	The port that Database uses to accept connections.
host	String	The endpoint that connects to the Database.
name	String	The Database’s name.
port	String	The port that Database uses to accept connections.
vault_connection_url	String	The URL of the Vault.
vault_role	String	The role that grants access to the Vault.

Azure

az-linux-virtual-machine-conn

The Connection Interface for Azure Blob Storage represents a Linux virtual machine.

Output	Type	Description
private_ip_address	String	Private IPs allowing communication between resources in Azure.
id	String	Account ID.
public_ip_address	String	Public IPs allowing communication between resources in Azure.
virtual_machine_id	String	Virtual machine ID.

az-function-conn

Connection Interface for Azure Functions. It is responsible for executing event-driven serverless code.

See the output below:

Output	Type	Description
default_hostname	String	The default hostname for accessing the function.
name	String	Function name.
id	String	The unique function ID.

az-service-bus-conn

The Connection Interface for Azure Service Bus manages messaging services.

See the output below:

Output	Type	Description
default_primary_connection_string	String	Primary connection string.
default_primary_key	String	Primary key of the shared access policy.

az-aks-conn

Connection Interface for Azure AKS. It allows you to connect to the Kubernetes managed service, ensuring that your containers run without the need to install and/or operate your nodes or management environments.

See the output below:

Output	Type	Description
client_certificate	String	The client certificate used to authenticate with the Kubernetes cluster.
client_key	String	The client key used for authentication with the Kubernetes cluster.
cluster_ca_certificate"	String	Cluster CA certificate, used to verify the authenticity of the Kubernetes cluster.
host	String	The host address of the Kubernetes cluster, used to connect to the cluster.
id	String	The unique ID of the Kubernetes cluster.
kube_config	String	The raw kube configuration for accessing the Kubernetes cluster.

az-key-vault-conn

Connection Interface for Azure Key Vault. It enables secure storage and access to secrets, keys, and certificates.

See the outputs below:

Output	Type	Description
id	String	The unique ID of the Key Vault.
tenant_id	String	The tenant ID associated with the Key Vault.
vault_uri	String	The URI of the Key Vault.

az-monitor-conn

Connection Interface for Azure Monitor. It provides monitoring and observability for Azure resources.

See the outputs below:

Output	Type	Description
id	String	The unique ID of the Azure Monitor resource.
name	String	The name of the Azure Monitor resource.
workspace_id	String	The ID for the Log Analytics Workspace.
workspace_key	String	The key required to access the Log Analytics Workspace.

az-mysql-db-conn

Connection Interface for Azure Database for MySQL. It allows integration with the managed MySQL Database service.

See the outputs below:

Output	Type	Description
database_name	String	The name of the MySQL Database.
host	String	The endpoint used to connect to the MySQL database.
id	String	The unique ID of the MySQL Database.
password	String	The password used to access the MySQL Database.
username	String	The username used to access the MySQL database.
port	String	The port through which the MySQL Database accepts connections.

az-vnet-conn

Connection Interface for Azure Virtual Network (VNET). It allows secure communication between Azure resources.

See the outputs below:

Output	Type	Description
address_space	String	The address space of the Virtual Network.
resource_group	String	The resource group that contains the Virtual Network.
subnet_ids	String	The list of subnet IDs within the Virtual Network.
vnet_id	String	The unique ID of the Virtual Network.
vnet_name	String	The name of the Virtual Network.

az-waf-conn

Connection Interface for Azure Web Application Firewall (WAF). It provides centralized protection for web applications.

See the outputs below:

Output	Type	Description
frontend_endpoint	String	The frontend endpoint is secured by the Web Application Firewall (WAF).
policy_id	String	The unique ID of the WAF policy.
policy_name	String	The name of the WAF policy.
resource_group	String	The resource group that contains the WAF policy.

azure-container-app-conn

Connection Interface for running containerized in Azure Container App.

See the outputs below:

Output	Type	Description
id	String	The resource identifier.
location	String	The Azure region in which the Container App is deployed.
name	String	The name you assign to the Container App.
resource_group_name	String	The name of the Azure Resource Group that contains the Container App.

azure-resource-group-conn

Connection Interface for Azure Resource Group.

See the outputs below:

Output	Type	Description
id	String	The resource identifier.
location	String	The Azure region where the resource group Metadata is stored.
name	String	The name you assign to the resource group.

azure-storage-account-conn

Connection Interface for Azure Storage Account.

See the outputs below:

Output	Type	Description
id	String	The resource identifier.
location	String	The Azure region in which the storage account is located.
name	String	The name you assign to the storage account.
resource_group_name	String	The name of the Azure Resource Group that includes the storage account.

az-front-door-conn

Connection Interface for Azure Front Door. It provides a scalable and secure entry point for delivering web applications.

See the outputs below:

Output	Type	Description
frontend_endpoint	String	The Front-end endpoint for accessing the Front Door.
id	String	The unique ID of the Front Door resource.
name	String	The name of the Front Door resource.
resource_group	String	The resource group that contains the Front Door.

az-app-service-conn

Connection Interface for Azure App Service. It allows hosting web applications, RESTful APIs, and mobile Back-ends.

See the outputs below:

Output	Type	Description
default_hostname	String	The default hostname used to access the App Service.
id	String	The unique ID of the App Service.
name	String	The name of the App Service.
resource_group	String	The resource group that contains the App Service.

---