Package software.amazon.awscdk.services.devopsagent

Class CfnService

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.devopsagent.CfnService

All Implemented Interfaces:

IInspectable, IServiceRef, IEnvironmentAware, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-04-14T18:31:52.709Z")
@Stability(Stable)
public class CfnService
extends CfnResource
implements IInspectable, IServiceRef, ITaggableV2

The AWS::DevOpsAgent::Service resource registers external services (like Dynatrace, MCP servers, GitLab) for integration with DevOpsAgent.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.devopsagent.*;
 Object exchangeParameters;
 CfnService cfnService = CfnService.Builder.create(this, "MyCfnService")
         .serviceType("serviceType")
         // the properties below are optional
         .kmsKeyArn("kmsKeyArn")
         .serviceDetails(ServiceDetailsProperty.builder()
                 .dynatrace(DynatraceServiceDetailsProperty.builder()
                         .accountUrn("accountUrn")
                         // the properties below are optional
                         .authorizationConfig(DynatraceAuthorizationConfigProperty.builder()
                                 .oAuthClientCredentials(OAuthClientDetailsProperty.builder()
                                         .clientId("clientId")
                                         .clientSecret("clientSecret")
                                         // the properties below are optional
                                         .clientName("clientName")
                                         .exchangeParameters(exchangeParameters)
                                         .build())
                                 .build())
                         .build())
                 .gitLab(GitLabDetailsProperty.builder()
                         .targetUrl("targetUrl")
                         .tokenType("tokenType")
                         .tokenValue("tokenValue")
                         // the properties below are optional
                         .groupId("groupId")
                         .build())
                 .mcpServer(MCPServerDetailsProperty.builder()
                         .authorizationConfig(MCPServerAuthorizationConfigProperty.builder()
                                 .apiKey(ApiKeyDetailsProperty.builder()
                                         .apiKeyHeader("apiKeyHeader")
                                         .apiKeyName("apiKeyName")
                                         .apiKeyValue("apiKeyValue")
                                         .build())
                                 .oAuthClientCredentials(MCPServerOAuthClientCredentialsConfigProperty.builder()
                                         .clientId("clientId")
                                         .clientSecret("clientSecret")
                                         .exchangeUrl("exchangeUrl")
                                         // the properties below are optional
                                         .clientName("clientName")
                                         .exchangeParameters(exchangeParameters)
                                         .scopes(List.of("scopes"))
                                         .build())
                                 .build())
                         .endpoint("endpoint")
                         .name("name")
                         // the properties below are optional
                         .description("description")
                         .build())
                 .mcpServerNewRelic(NewRelicServiceDetailsProperty.builder()
                         .authorizationConfig(NewRelicAuthorizationConfigProperty.builder()
                                 .apiKey(NewRelicApiKeyConfigProperty.builder()
                                         .accountId("accountId")
                                         .apiKey("apiKey")
                                         .region("region")
                                         // the properties below are optional
                                         .alertPolicyIds(List.of("alertPolicyIds"))
                                         .applicationIds(List.of("applicationIds"))
                                         .entityGuids(List.of("entityGuids"))
                                         .build())
                                 .build())
                         .build())
                 .mcpServerSplunk(MCPServerSplunkDetailsProperty.builder()
                         .authorizationConfig(MCPServerSplunkAuthorizationConfigProperty.builder()
                                 .bearerToken(BearerTokenDetailsProperty.builder()
                                         .tokenName("tokenName")
                                         .tokenValue("tokenValue")
                                         // the properties below are optional
                                         .authorizationHeader("authorizationHeader")
                                         .build())
                                 .build())
                         .endpoint("endpoint")
                         .name("name")
                         // the properties below are optional
                         .description("description")
                         .build())
                 .serviceNow(ServiceNowServiceDetailsProperty.builder()
                         .instanceUrl("instanceUrl")
                         // the properties below are optional
                         .authorizationConfig(ServiceNowAuthorizationConfigProperty.builder()
                                 .oAuthClientCredentials(OAuthClientDetailsProperty.builder()
                                         .clientId("clientId")
                                         .clientSecret("clientSecret")
                                         // the properties below are optional
                                         .clientName("clientName")
                                         .exchangeParameters(exchangeParameters)
                                         .build())
                                 .build())
                         .build())
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-devopsagent-service.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnService.AdditionalServiceDetailsProperty	Example:
static interface	CfnService.ApiKeyDetailsProperty	API key authentication details.
static interface	CfnService.BearerTokenDetailsProperty	Bearer token authentication details.
static final class	CfnService.Builder	A fluent builder for CfnService.
static interface	CfnService.DynatraceAuthorizationConfigProperty	Dynatrace OAuth authorization configuration.
static interface	CfnService.DynatraceServiceDetailsProperty	Dynatrace service configuration.
static interface	CfnService.GitLabDetailsProperty	GitLab service configuration.
static interface	CfnService.MCPServerAuthorizationConfigProperty	Example:
static interface	CfnService.MCPServerDetailsProperty	MCP server configuration.
static interface	CfnService.MCPServerOAuthClientCredentialsConfigProperty	MCP server OAuth client credentials configuration.
static interface	CfnService.MCPServerSplunkAuthorizationConfigProperty	MCP server splunk authorization configuration.
static interface	CfnService.MCPServerSplunkDetailsProperty	Splunk MCP server configuration.
static interface	CfnService.NewRelicApiKeyConfigProperty	New Relic API key configuration.
static interface	CfnService.NewRelicAuthorizationConfigProperty	New Relic authorization configuration.
static interface	CfnService.NewRelicServiceDetailsProperty	New Relic service configuration.
static interface	CfnService.OAuthClientDetailsProperty	OAuth client credentials.
static interface	CfnService.RegisteredDynatraceDetailsProperty	Dynatrace service details returned after registration.
static interface	CfnService.RegisteredGitLabServiceDetailsProperty	GitLab service details returned after registration.
static interface	CfnService.RegisteredMCPServerDetailsProperty	MCP server details returned after registration.
static interface	CfnService.RegisteredNewRelicDetailsProperty	New Relic service details returned after registration.
static interface	CfnService.RegisteredServiceNowDetailsProperty	ServiceNow service details returned after registration.
static interface	CfnService.ServiceDetailsProperty	Example:
static interface	CfnService.ServiceNowAuthorizationConfigProperty	ServiceNow OAuth authorization configuration.
static interface	CfnService.ServiceNowServiceDetailsProperty	ServiceNow service configuration.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.devopsagent.IServiceRef

IServiceRef.Jsii$Default, IServiceRef.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggableV2

ITaggableV2.Jsii$Default, ITaggableV2.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnService(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnService(software.amazon.jsii.JsiiObjectRef objRef)
	CfnService(software.constructs.Construct scope, String id, CfnServiceProps props)	Create a new AWS::DevOpsAgent::Service.

Method Summary

Modifier and Type	Method	Description
static String	arnForService(IServiceRef resource)
static IServiceRef	fromServiceArn(software.constructs.Construct scope, String id, String arn)	Creates a new IServiceRef from an ARN.
static IServiceRef	fromServiceId(software.constructs.Construct scope, String id, String serviceId)	Creates a new IServiceRef from a serviceId.
IResolvable	getAttrAccessibleResources()	List of accessible resources for this service.
IResolvable	getAttrAdditionalServiceDetails()	Additional details specific to the service type returned after registration.
String	getAttrArn()	The Amazon Resource Name (ARN) of the Service.
String	getAttrServiceId()	The unique identifier of the service.
TagManager	getCdkTagManager()	Tag Manager which manages the tags for this resource.
protected Map<String,Object>	getCfnProperties()
String	getKmsKeyArn()	The ARN of the KMS key to use for encryption.
Object	getServiceDetails()	Service-specific configuration details.
ServiceReference	getServiceRef()	A reference to a Service resource.
String	getServiceType()	The type of service being registered.
List<CfnTag>	getTags()	An array of key-value pairs to apply to this resource.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
static Boolean	isCfnService(Object x)	Checks whether the given object is a CfnService.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setKmsKeyArn(String value)	The ARN of the KMS key to use for encryption.
void	setServiceDetails(IResolvable value)	Service-specific configuration details.
void	setServiceDetails(CfnService.ServiceDetailsProperty value)	Service-specific configuration details.
void	setServiceType(String value)	The type of service being registered.
void	setTags(List<CfnTag> value)	An array of key-value pairs to apply to this resource.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId, with

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode, with

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnService

protected CfnService(software.amazon.jsii.JsiiObjectRef objRef)

CfnService

protected CfnService(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnService

@Stability(Stable)
public CfnService(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnServiceProps props)

Create a new AWS::DevOpsAgent::Service.

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

arnForService

@Stability(Stable)
@NotNull
public static String arnForService(@NotNull
 IServiceRef resource)

Parameters:

resource - This parameter is required.

fromServiceArn

@Stability(Stable)
@NotNull
public static IServiceRef fromServiceArn(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String arn)

Creates a new IServiceRef from an ARN.

Parameters:

scope - This parameter is required.

id - This parameter is required.

arn - This parameter is required.

fromServiceId

@Stability(Stable)
@NotNull
public static IServiceRef fromServiceId(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String serviceId)

Creates a new IServiceRef from a serviceId.

Parameters:

scope - This parameter is required.

id - This parameter is required.

serviceId - This parameter is required.

isCfnService

@Stability(Stable)
@NotNull
public static Boolean isCfnService(@NotNull
 Object x)

Checks whether the given object is a CfnService.

Parameters:

x - This parameter is required.

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrAccessibleResources

@Stability(Stable)
@NotNull
public IResolvable getAttrAccessibleResources()

List of accessible resources for this service.

getAttrAdditionalServiceDetails

@Stability(Stable)
@NotNull
public IResolvable getAttrAdditionalServiceDetails()

Additional details specific to the service type returned after registration.

getAttrArn

@Stability(Stable)
@NotNull
public String getAttrArn()

The Amazon Resource Name (ARN) of the Service.

getAttrServiceId

@Stability(Stable)
@NotNull
public String getAttrServiceId()

The unique identifier of the service.

getCdkTagManager

@Stability(Stable)
@NotNull
public TagManager getCdkTagManager()

Tag Manager which manages the tags for this resource.

Specified by:

getCdkTagManager in interface ITaggableV2

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getServiceRef

@Stability(Stable)
@NotNull
public ServiceReference getServiceRef()

A reference to a Service resource.

Specified by:

getServiceRef in interface IServiceRef

getServiceType

@Stability(Stable)
@NotNull
public String getServiceType()

The type of service being registered.

setServiceType

@Stability(Stable)
public void setServiceType(@NotNull
 String value)

The type of service being registered.

getKmsKeyArn

@Stability(Stable)
@Nullable
public String getKmsKeyArn()

The ARN of the KMS key to use for encryption.

setKmsKeyArn

@Stability(Stable)
public void setKmsKeyArn(@Nullable
 String value)

The ARN of the KMS key to use for encryption.

getServiceDetails

@Stability(Stable)
@Nullable
public Object getServiceDetails()

Service-specific configuration details.

Returns union: either IResolvable or CfnService.ServiceDetailsProperty

setServiceDetails

@Stability(Stable)
public void setServiceDetails(@Nullable
 IResolvable value)

Service-specific configuration details.

setServiceDetails

@Stability(Stable)
public void setServiceDetails(@Nullable
 CfnService.ServiceDetailsProperty value)

Service-specific configuration details.

getTags

@Stability(Stable)
@Nullable
public List<CfnTag> getTags()

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

setTags

@Stability(Stable)
public void setTags(@Nullable
 List<CfnTag> value)

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