Package software.amazon.awscdk.services.devopsagent

Interface CfnServiceProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnServiceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)",
           date="2026-09-10T17:51:42.941Z")
@Stability(Stable)
public interface CfnServiceProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnService.

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;
 CfnServiceProps cfnServiceProps = CfnServiceProps.builder()
         .serviceType("serviceType")
         // the properties below are optional
         .exchangeUrlPrivateConnectionName("exchangeUrlPrivateConnectionName")
         .kmsKeyArn("kmsKeyArn")
         .privateConnectionName("privateConnectionName")
         .serviceDetails(ServiceDetailsProperty.builder()
                 .azureIdentity(AzureIdentityServiceDetailsProperty.builder()
                         .clientId("clientId")
                         .tenantId("tenantId")
                         .webIdentityRoleArn("webIdentityRoleArn")
                         .webIdentityTokenAudiences(List.of("webIdentityTokenAudiences"))
                         .build())
                 .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())
                                 .bearerToken(BearerTokenDetailsProperty.builder()
                                         .tokenName("tokenName")
                                         .tokenValue("tokenValue")
                                         // the properties below are optional
                                         .authorizationHeader("authorizationHeader")
                                         .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())
                 .mcpServerGrafana(MCPServerGrafanaDetailsProperty.builder()
                         .authorizationConfig(MCPServerGrafanaAuthorizationConfigProperty.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())
                 .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())
                 .mcpServerSigV4(MCPServerSigV4DetailsProperty.builder()
                         .authorizationConfig(MCPServerSigV4AuthorizationConfigProperty.builder()
                                 .region("region")
                                 .service("service")
                                 // the properties below are optional
                                 .customHeaders(Map.of(
                                         "customHeadersKey", "customHeaders"))
                                 .mcpRoleArn("mcpRoleArn")
                                 .roleArn("roleArn")
                                 .build())
                         .endpoint("endpoint")
                         .name("name")
                         // the properties below are optional
                         .description("description")
                         .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())
                 .pagerDuty(PagerDutyDetailsProperty.builder()
                         .authorizationConfig(PagerDutyAuthorizationConfigProperty.builder()
                                 .oAuthClientCredentials(OAuthClientDetailsProperty.builder()
                                         .clientId("clientId")
                                         .clientSecret("clientSecret")
                                         // the properties below are optional
                                         .clientName("clientName")
                                         .exchangeParameters(exchangeParameters)
                                         .build())
                                 .build())
                         .scopes(List.of("scopes"))
                         .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()))
         .targetUrlPrivateConnectionName("targetUrlPrivateConnectionName")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnServiceProps.Builder	A builder for CfnServiceProps
static final class	CfnServiceProps.Jsii$Proxy	An implementation for CfnServiceProps

Method Summary

Modifier and Type	Method	Description
static CfnServiceProps.Builder	builder()
default String	getExchangeUrlPrivateConnectionName()	The name of the private connection to use for OAuth token exchange requests only.
default String	getKmsKeyArn()	The ARN of the KMS key to use for encryption.
default String	getPrivateConnectionName()	The name of the private connection to use for VPC connectivity.
default Object	getServiceDetails()	Service-specific configuration details - MCPServerSigV4 supports in-place updates;
String	getServiceType()	The type of service being registered.
default List<CfnTag>	getTags()	An array of key-value pairs to apply to this resource.
default String	getTargetUrlPrivateConnectionName()	The name of the private connection to use for API calls (target URL) only.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getServiceType

@Stability(Stable)
@NotNull
String getServiceType()

The type of service being registered.

See Also:

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

getExchangeUrlPrivateConnectionName

@Stability(Stable)
@Nullable
default String getExchangeUrlPrivateConnectionName()

The name of the private connection to use for OAuth token exchange requests only.

Cannot be specified when PrivateConnectionName is provided.

See Also:

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

getKmsKeyArn

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

The ARN of the KMS key to use for encryption.

See Also:

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

getPrivateConnectionName

@Stability(Stable)
@Nullable
default String getPrivateConnectionName()

The name of the private connection to use for VPC connectivity.

See Also:

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

getServiceDetails

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

Service-specific configuration details - MCPServerSigV4 supports in-place updates;

GitLab (TokenValue), MCPServer (ApiKey or BearerToken credential rotation), MCPServerNewRelic (ApiKey rotation), and MCPServerGrafana (BearerToken rotation) support in-place credential rotation; all other service types and fields require replacement when modified

Returns union: either IResolvable or CfnService.ServiceDetailsProperty

See Also:

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

getTags

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

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

See Also:

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

getTargetUrlPrivateConnectionName

@Stability(Stable)
@Nullable
default String getTargetUrlPrivateConnectionName()

The name of the private connection to use for API calls (target URL) only.

Cannot be specified when PrivateConnectionName is provided.

See Also:

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

builder

@Stability(Stable)
static CfnServiceProps.Builder builder()

Returns:

a CfnServiceProps.Builder of CfnServiceProps