View a markdown version of this page

PrivateConnectionSummary - AWS DevOps Agent

PrivateConnectionSummary

Summary of a Private Connection.

Contents

name

The name of the Private Connection.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 30.

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

Required: Yes

status

The status of the Private Connection.

Type: String

Valid Values: ACTIVE | CREATE_IN_PROGRESS | CREATE_FAILED | DELETE_IN_PROGRESS | DELETE_FAILED

Required: Yes

type

The type of the Private Connection.

Type: String

Valid Values: SELF_MANAGED | SERVICE_MANAGED

Required: Yes

certificateExpiryTime

The expiry time of the certificate associated with the Private Connection. Only present when a certificate is associated.

Type: Timestamp

Required: No

hostAddress

IP address or DNS name of the target resource. Only present for service-managed Private Connections.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 255.

Pattern: [a-zA-Z0-9.:\-]+

Required: No

resourceConfigurationId

The Resource Configuration ARN. Only present for self-managed Private Connections.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: (arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:resourceconfiguration/rcfg-[0-9a-z]{17}|rcfg-[0-9a-z]{17})

Required: No

resourceGatewayId

The service-managed Resource Gateway ARN. Only present for service-managed Private Connections.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:resourcegateway/rgw-[0-9a-z]{17}

Required: No

vpcId

VPC identifier of the service-managed Resource Gateway. Only present for service-managed Private Connections.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 50.

Pattern: vpc-(([0-9a-z]{8})|([0-9a-z]{17}))

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: