aws-cdk-lib.aws_devopsagent.CfnServiceProps

CfnServiceProps Struct

Properties for defining a CfnService.

CfnServiceProps

used as props by

• CfnService

Source

Generated code

Type last changed

v2.274.0 · 20 Oct 2026

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_devopsagent as devopsagent } from 'aws-cdk-lib';

declare const exchangeParameters: any;
const cfnServiceProps: devopsagent.CfnServiceProps = {
  serviceType: 'serviceType',

  // the properties below are optional
  exchangeUrlPrivateConnectionName: 'exchangeUrlPrivateConnectionName',
  kmsKeyArn: 'kmsKeyArn',
  name: 'name',
  privateConnectionName: 'privateConnectionName',
  serviceDetails: {
    azureIdentity: {
      clientId: 'clientId',
      tenantId: 'tenantId',
      webIdentityRoleArn: 'webIdentityRoleArn',
      webIdentityTokenAudiences: ['webIdentityTokenAudiences'],
    },
    dynatrace: {
      accountUrn: 'accountUrn',

      // the properties below are optional
      authorizationConfig: {
        oAuthClientCredentials: {
          clientId: 'clientId',
          clientSecret: 'clientSecret',

          // the properties below are optional
          clientName: 'clientName',
          exchangeParameters: exchangeParameters,
        },
      },
    },
    gitHub: {
      appVerification: {
        appVariant: 'appVariant',
        tokenValue: 'tokenValue',

        // the properties below are optional
        organizationName: 'organizationName',
        targetUrl: 'targetUrl',
      },
      directAccess: {
        tokenValue: 'tokenValue',

        // the properties below are optional
        organizationName: 'organizationName',
        targetUrl: 'targetUrl',
      },
    },
    gitLab: {
      targetUrl: 'targetUrl',
      tokenType: 'tokenType',
      tokenValue: 'tokenValue',

      // the properties below are optional
      groupId: 'groupId',
    },
    mcpServer: {
      authorizationConfig: {
        apiKey: {
          apiKeyHeader: 'apiKeyHeader',
          apiKeyName: 'apiKeyName',
          apiKeyValue: 'apiKeyValue',
        },
        bearerToken: {
          tokenName: 'tokenName',
          tokenValue: 'tokenValue',

          // the properties below are optional
          authorizationHeader: 'authorizationHeader',
        },
        oAuthClientCredentials: {
          clientId: 'clientId',
          clientSecret: 'clientSecret',
          exchangeUrl: 'exchangeUrl',

          // the properties below are optional
          clientName: 'clientName',
          exchangeParameters: exchangeParameters,
          scopes: ['scopes'],
        },
      },
      endpoint: 'endpoint',
      name: 'name',

      // the properties below are optional
      description: 'description',
    },
    mcpServerGrafana: {
      authorizationConfig: {
        bearerToken: {
          tokenName: 'tokenName',
          tokenValue: 'tokenValue',

          // the properties below are optional
          authorizationHeader: 'authorizationHeader',
        },
      },
      endpoint: 'endpoint',
      name: 'name',

      // the properties below are optional
      description: 'description',
    },
    mcpServerNewRelic: {
      authorizationConfig: {
        apiKey: {
          accountId: 'accountId',
          apiKey: 'apiKey',
          region: 'region',

          // the properties below are optional
          alertPolicyIds: ['alertPolicyIds'],
          applicationIds: ['applicationIds'],
          entityGuids: ['entityGuids'],
        },
      },
    },
    mcpServerSigV4: {
      authorizationConfig: {
        region: 'region',
        service: 'service',

        // the properties below are optional
        customHeaders: {
          customHeadersKey: 'customHeaders',
        },
        mcpRoleArn: 'mcpRoleArn',
        roleArn: 'roleArn',
      },
      endpoint: 'endpoint',
      name: 'name',

      // the properties below are optional
      description: 'description',
    },
    mcpServerSplunk: {
      authorizationConfig: {
        bearerToken: {
          tokenName: 'tokenName',
          tokenValue: 'tokenValue',

          // the properties below are optional
          authorizationHeader: 'authorizationHeader',
        },
      },
      endpoint: 'endpoint',
      name: 'name',

      // the properties below are optional
      description: 'description',
    },
    pagerDuty: {
      authorizationConfig: {
        oAuthClientCredentials: {
          clientId: 'clientId',
          clientSecret: 'clientSecret',

          // the properties below are optional
          clientName: 'clientName',
          exchangeParameters: exchangeParameters,
        },
      },
      scopes: ['scopes'],
    },
    serviceNow: {
      instanceUrl: 'instanceUrl',

      // the properties below are optional
      authorizationConfig: {
        oAuthClientCredentials: {
          clientId: 'clientId',
          clientSecret: 'clientSecret',

          // the properties below are optional
          clientName: 'clientName',
          exchangeParameters: exchangeParameters,
        },
      },
    },
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
  targetUrlPrivateConnectionName: 'targetUrlPrivateConnectionName',
};

Properties

exchangeUrlPrivateConnectionName?optionalstringexchange_url_private_connection_name?optionalstrexchangeUrlPrivateConnectionName?optionalStringExchangeUrlPrivateConnectionName?optionalstringExchangeUrlPrivateConnectionName?optional*string#

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

Cannot be specified when PrivateConnectionName is provided.

kmsKeyArn?optionalstringkms_key_arn?optionalstrkmsKeyArn?optionalStringKmsKeyArn?optionalstringKmsKeyArn?optional*string#

The ARN of the KMS key to use for encryption.

name?optionalstringname?optionalstrname?optionalStringName?optionalstringName?optional*string#

The display name for the service registration.

privateConnectionName?optionalstringprivate_connection_name?optionalstrprivateConnectionName?optionalStringPrivateConnectionName?optionalstringPrivateConnectionName?optional*string#

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

serviceDetails?optionalIResolvable | CfnService.ServiceDetailsPropertyservice_details?optionaltyping.Union[IResolvable, ServiceDetailsProperty]serviceDetails?optionalIResolvableServiceDetails?optionalIResolvableServiceDetails?optionalinterface{}#

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

notes

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, including GitHub, require replacement when modified

serviceTypestringservice_typestrserviceTypeStringServiceTypestringServiceType*stringrequired#

The type of service being registered.

tags?optionalCfnTag[]tags?optionaltyping.List[CfnTag]tags?optionalList<CfnTag>Tags?optionalCfnTag[]Tags?optional*[]CfnTag#

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

targetUrlPrivateConnectionName?optionalstringtarget_url_private_connection_name?optionalstrtargetUrlPrivateConnectionName?optionalStringTargetUrlPrivateConnectionName?optionalstringTargetUrlPrivateConnectionName?optional*string#

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

Cannot be specified when PrivateConnectionName is provided.