interface CfnServiceProps

Language	Type name
.NET	Amazon.CDK.AWS.DevOpsAgent.CfnServiceProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsdevopsagent#CfnServiceProps
Java	software.amazon.awscdk.services.devopsagent.CfnServiceProps
Python	aws_cdk.aws_devopsagent.CfnServiceProps
TypeScript	aws-cdk-lib » aws_devopsagent » CfnServiceProps

Properties for defining a CfnService.

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

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
  serviceDetails: {
    dynatrace: {
      accountUrn: 'accountUrn',

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

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

      // the properties below are optional
      groupId: 'groupId',
    },
    mcpServer: {
      authorizationConfig: {
        apiKey: {
          apiKeyHeader: 'apiKeyHeader',
          apiKeyName: 'apiKeyName',
          apiKeyValue: 'apiKeyValue',
        },
        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',
    },
    mcpServerNewRelic: {
      authorizationConfig: {
        apiKey: {
          accountId: 'accountId',
          apiKey: 'apiKey',
          region: 'region',

          // the properties below are optional
          alertPolicyIds: ['alertPolicyIds'],
          applicationIds: ['applicationIds'],
          entityGuids: ['entityGuids'],
        },
      },
    },
    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',
    },
    serviceNow: {
      instanceUrl: 'instanceUrl',

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

          // the properties below are optional
          clientName: 'clientName',
          exchangeParameters: exchangeParameters,
        },
      },
    },
  },
};

Properties

Name	Type	Description
serviceType	string	The type of service being registered.
serviceDetails?	IResolvable | ServiceDetailsProperty	Service-specific configuration details.

---

serviceType

Type: string

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

---

serviceDetails?

Type: IResolvable | ServiceDetailsProperty (optional)

Service-specific configuration details.

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