View a markdown version of this page

AWS::DevOpsAgent::Service - 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::Service

The AWS::DevOpsAgent::Service resource registers an external service for integration with the AWS DevOps Agent service.

Most service types require replacement when you modify their configuration. MCPServerSigV4 supports in-place updates, and GitLab, MCPServer, MCPServerNewRelic, and MCPServerGrafana support in-place credential rotation.

Note

Services that use OAuth authorization flows (for example, Datadog, GitHub, and Slack) require interactive browser-based registration through the AWS DevOps Agent console. You cannot register these service types using this resource.

Syntax

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

JSON

{
  "Type" : "AWS::DevOpsAgent::Service",
  "Properties" : {
      "ExchangeUrlPrivateConnectionName" : String,
      "KmsKeyArn" : String,
      "PrivateConnectionName" : String,
      "ServiceDetails" : ServiceDetails,
      "ServiceType" : String,
      "Tags" : [ Tag, ... ],
      "TargetUrlPrivateConnectionName" : String
    }
}

YAML

Type: AWS::DevOpsAgent::Service
Properties:
  ExchangeUrlPrivateConnectionName: String
  KmsKeyArn: String
  PrivateConnectionName: String
  ServiceDetails: 
    ServiceDetails
  ServiceType: String
  Tags: 
    - Tag
  TargetUrlPrivateConnectionName: String

Properties

ExchangeUrlPrivateConnectionName

The name of the private connection used to reach the OAuth token exchange endpoint only. You cannot specify this property together with PrivateConnectionName.

Required: No

Type: String

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

Minimum: 3

Maximum: 30

Update requires: Updates are not supported.

KmsKeyArn

The ARN of the customer managed key used to encrypt the data of the registered service at rest.

Required: No

Type: String

Minimum: 1

Maximum: 2048

Update requires: Updates are not supported.

PrivateConnectionName

The name of the private connection used to reach the service over a private network path, which applies to both the service endpoint and the OAuth token exchange endpoint.

Required: No

Type: String

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

Minimum: 3

Maximum: 30

Update requires: Updates are not supported.

ServiceDetails

Service-specific configuration details provided during registration. The structure of this property depends on the value of ServiceType.

Required: No

Type: ServiceDetails

Update requires: No interruption

ServiceType

The type of external service to register.

Required: Yes

Type: String

Allowed values: dynatrace | mcpserver | mcpserversplunk | mcpservernewrelic | gitlab | servicenow | pagerduty | azureidentity | mcpserversigv4 | mcpservergrafana

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

TargetUrlPrivateConnectionName

The name of the private connection used to reach the service endpoint only. You cannot specify this property together with PrivateConnectionName.

Required: No

Type: String

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

Minimum: 3

Maximum: 30

Update requires: Updates are not supported.

Return values

Ref

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

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.

AccessibleResources

List of accessible resources for this service.

Arn

The Amazon Resource Name (ARN) of the service.

ServiceId

The unique identifier of the service.