View a markdown version of this page

AWS::DevOpsAgent::PrivateConnection - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::DevOpsAgent::PrivateConnection

The AWS::DevOpsAgent::PrivateConnection resource specifies a private connection that provides a secure network path between the AWS DevOps Agent service and a target resource in your VPC.

Private connections are account-level resources that you can reuse across multiple integrations and Agent Spaces that reach the same host.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::DevOpsAgent::PrivateConnection",
  "Properties" : {
      "Certificate" : String,
      "ConnectionConfiguration" : ConnectionConfiguration,
      "Name" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::DevOpsAgent::PrivateConnection
Properties:
  Certificate: String
  ConnectionConfiguration: 
    ConnectionConfiguration
  Name: String
  Tags: 
    - Tag

Properties

Certificate

The PEM-encoded certificate chain of the target service. Required when a private certificate authority issues the TLS certificate of the target service.

Required: No

Type: String

Minimum: 1

Maximum: 32768

Update requires: No interruption

ConnectionConfiguration

The connection configuration, which determines whether AWS DevOps Agent manages the underlying Amazon VPC Lattice resources or you provide your own.

Required: Yes

Type: ConnectionConfiguration

Update requires: Updates are not supported.

Name

The unique name of the private connection within your account.

Required: Yes

Type: String

Pattern: ^[a-z0-9]([a-z0-9-]*[a-z0-9])?$

Minimum: 3

Maximum: 30

Update requires: Updates are not supported.

Tags

An array of key-value pairs to apply to this resource.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the name of the private connection.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Arn

The Amazon Resource Name (ARN) of the private connection.

CertificateExpiryTime

The timestamp when the certificate associated with the private connection expires.

Status

The current status of the private connection.