CfnService

class aws_cdk.aws_devopsagent.CfnService(scope, id, *, service_type, service_details=None)

Bases: CfnResource

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

See:

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

CloudformationResource:

AWS::DevOpsAgent::Service

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_devopsagent as devopsagent

# exchange_parameters: Any

cfn_service = devopsagent.CfnService(self, "MyCfnService",
    service_type="serviceType",

    # the properties below are optional
    service_details=devopsagent.CfnService.ServiceDetailsProperty(
        dynatrace=devopsagent.CfnService.DynatraceServiceDetailsProperty(
            account_urn="accountUrn",

            # the properties below are optional
            authorization_config=devopsagent.CfnService.DynatraceAuthorizationConfigProperty(
                o_auth_client_credentials=devopsagent.CfnService.OAuthClientDetailsProperty(
                    client_id="clientId",
                    client_secret="clientSecret",

                    # the properties below are optional
                    client_name="clientName",
                    exchange_parameters=exchange_parameters
                )
            )
        ),
        git_lab=devopsagent.CfnService.GitLabDetailsProperty(
            target_url="targetUrl",
            token_type="tokenType",
            token_value="tokenValue",

            # the properties below are optional
            group_id="groupId"
        ),
        mcp_server=devopsagent.CfnService.MCPServerDetailsProperty(
            authorization_config=devopsagent.CfnService.MCPServerAuthorizationConfigProperty(
                api_key=devopsagent.CfnService.ApiKeyDetailsProperty(
                    api_key_header="apiKeyHeader",
                    api_key_name="apiKeyName",
                    api_key_value="apiKeyValue"
                ),
                o_auth_client_credentials=devopsagent.CfnService.MCPServerOAuthClientCredentialsConfigProperty(
                    client_id="clientId",
                    client_secret="clientSecret",
                    exchange_url="exchangeUrl",

                    # the properties below are optional
                    client_name="clientName",
                    exchange_parameters=exchange_parameters,
                    scopes=["scopes"]
                )
            ),
            endpoint="endpoint",
            name="name",

            # the properties below are optional
            description="description"
        ),
        mcp_server_new_relic=devopsagent.CfnService.NewRelicServiceDetailsProperty(
            authorization_config=devopsagent.CfnService.NewRelicAuthorizationConfigProperty(
                api_key=devopsagent.CfnService.NewRelicApiKeyConfigProperty(
                    account_id="accountId",
                    api_key="apiKey",
                    region="region",

                    # the properties below are optional
                    alert_policy_ids=["alertPolicyIds"],
                    application_ids=["applicationIds"],
                    entity_guids=["entityGuids"]
                )
            )
        ),
        mcp_server_splunk=devopsagent.CfnService.MCPServerSplunkDetailsProperty(
            authorization_config=devopsagent.CfnService.MCPServerSplunkAuthorizationConfigProperty(
                bearer_token=devopsagent.CfnService.BearerTokenDetailsProperty(
                    token_name="tokenName",
                    token_value="tokenValue",

                    # the properties below are optional
                    authorization_header="authorizationHeader"
                )
            ),
            endpoint="endpoint",
            name="name",

            # the properties below are optional
            description="description"
        ),
        service_now=devopsagent.CfnService.ServiceNowServiceDetailsProperty(
            instance_url="instanceUrl",

            # the properties below are optional
            authorization_config=devopsagent.CfnService.ServiceNowAuthorizationConfigProperty(
                o_auth_client_credentials=devopsagent.CfnService.OAuthClientDetailsProperty(
                    client_id="clientId",
                    client_secret="clientSecret",

                    # the properties below are optional
                    client_name="clientName",
                    exchange_parameters=exchange_parameters
                )
            )
        )
    )
)

Create a new AWS::DevOpsAgent::Service.

Parameters:

  • scope (Construct) – Scope in which this resource is defined.

  • id (str) – Construct identifier for this resource (unique in its scope).

  • service_type (str) – The type of service being registered.

  • service_details (Union[IResolvable, ServiceDetailsProperty, Dict[str, Any], None]) – Service-specific configuration details.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:

path (str) – The path of the value to delete.

Return type:

None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource)

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource)

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (str)

  • value (Any)

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:

property_path (str) – The path to the property.

Return type:

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

  • policy (Optional[RemovalPolicy])

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

  • attribute_name (str) – The name of the attribute.

  • type_hint (Optional[ResolutionTypeHint])

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str)

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) – tree inspector to collect and process attributes.

Return type:

None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:

List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:

List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:

new_logical_id (str) – The new logical ID to use for this stack element.

Return type:

None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource)

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:
Return type:

None

to_string()

Returns a string representation of this construct.

Return type:

str

Returns:

a string representation of this resource

with_(*mixins)

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

mixins (IMixin)

Return type:

IConstruct

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::DevOpsAgent::Service'
attr_accessible_resources

List of accessible resources for this service.

CloudformationAttribute:

AccessibleResources

attr_additional_service_details

Additional details specific to the service type returned after registration.

CloudformationAttribute:

AdditionalServiceDetails

attr_service_id

The unique identifier of the service.

CloudformationAttribute:

ServiceId

cfn_options

Options for this resource, such as condition, update policy etc.

cfn_resource_type

AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

env
logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

node

The tree node.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

service_details

Service-specific configuration details.

service_ref

A reference to a Service resource.

service_type

The type of service being registered.

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Static Methods

classmethod arn_for_service(resource)
Parameters:

resource (IServiceRef)

Return type:

str

classmethod from_service_id(scope, id, service_id)

Creates a new IServiceRef from a serviceId.

Parameters:

  • scope (Construct)

  • id (str)

  • service_id (str)

Return type:

IServiceRef

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any)

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any)

Return type:

bool

classmethod is_cfn_service(x)

Checks whether the given object is a CfnService.

Parameters:

x (Any)

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Construct.

AdditionalServiceDetailsProperty

class CfnService.AdditionalServiceDetailsProperty(*, dynatrace=None, git_lab=None, mcp_server=None, mcp_server_new_relic=None, mcp_server_splunk=None, service_now=None)

Bases: object

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-additionalservicedetails.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_devopsagent as devopsagent

additional_service_details_property = devopsagent.CfnService.AdditionalServiceDetailsProperty(
    dynatrace=devopsagent.CfnService.RegisteredDynatraceDetailsProperty(
        account_urn="accountUrn"
    ),
    git_lab=devopsagent.CfnService.RegisteredGitLabServiceDetailsProperty(
        target_url="targetUrl",
        token_type="tokenType",

        # the properties below are optional
        group_id="groupId"
    ),
    mcp_server=devopsagent.CfnService.RegisteredMCPServerDetailsProperty(
        authorization_method="authorizationMethod",
        endpoint="endpoint",
        name="name",

        # the properties below are optional
        api_key_header="apiKeyHeader",
        description="description"
    ),
    mcp_server_new_relic=devopsagent.CfnService.RegisteredNewRelicDetailsProperty(
        account_id="accountId",
        region="region",

        # the properties below are optional
        description="description"
    ),
    mcp_server_splunk=devopsagent.CfnService.RegisteredMCPServerDetailsProperty(
        authorization_method="authorizationMethod",
        endpoint="endpoint",
        name="name",

        # the properties below are optional
        api_key_header="apiKeyHeader",
        description="description"
    ),
    service_now=devopsagent.CfnService.RegisteredServiceNowDetailsProperty(
        instance_url="instanceUrl"
    )
)

Attributes

dynatrace

Dynatrace service details returned after registration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-additionalservicedetails.html#cfn-devopsagent-service-additionalservicedetails-dynatrace

git_lab

GitLab service details returned after registration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-additionalservicedetails.html#cfn-devopsagent-service-additionalservicedetails-gitlab

mcp_server

MCP server details returned after registration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-additionalservicedetails.html#cfn-devopsagent-service-additionalservicedetails-mcpserver

mcp_server_new_relic

New Relic service details returned after registration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-additionalservicedetails.html#cfn-devopsagent-service-additionalservicedetails-mcpservernewrelic

mcp_server_splunk

MCP server details returned after registration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-additionalservicedetails.html#cfn-devopsagent-service-additionalservicedetails-mcpserversplunk

service_now

ServiceNow service details returned after registration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-additionalservicedetails.html#cfn-devopsagent-service-additionalservicedetails-servicenow

ApiKeyDetailsProperty

class CfnService.ApiKeyDetailsProperty(*, api_key_header, api_key_name, api_key_value)

Bases: object

API key authentication details.

Parameters:

  • api_key_header (str) – HTTP header name to send the API key.

  • api_key_name (str) – User friendly API key name.

  • api_key_value (str) – API key value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-apikeydetails.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_devopsagent as devopsagent

api_key_details_property = devopsagent.CfnService.ApiKeyDetailsProperty(
    api_key_header="apiKeyHeader",
    api_key_name="apiKeyName",
    api_key_value="apiKeyValue"
)

Attributes

api_key_header

HTTP header name to send the API key.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-apikeydetails.html#cfn-devopsagent-service-apikeydetails-apikeyheader

api_key_name

User friendly API key name.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-apikeydetails.html#cfn-devopsagent-service-apikeydetails-apikeyname

api_key_value

API key value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-apikeydetails.html#cfn-devopsagent-service-apikeydetails-apikeyvalue

BearerTokenDetailsProperty

class CfnService.BearerTokenDetailsProperty(*, token_name, token_value, authorization_header=None)

Bases: object

Bearer token authentication details.

Parameters:

  • token_name (str) – User friendly bearer token name.

  • token_value (str) – Bearer token value.

  • authorization_header (Optional[str]) – HTTP header name to send the bearer token. Default: - “Authorization”

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-bearertokendetails.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_devopsagent as devopsagent

bearer_token_details_property = devopsagent.CfnService.BearerTokenDetailsProperty(
    token_name="tokenName",
    token_value="tokenValue",

    # the properties below are optional
    authorization_header="authorizationHeader"
)

Attributes

authorization_header

HTTP header name to send the bearer token.

Default:

  • “Authorization”

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-bearertokendetails.html#cfn-devopsagent-service-bearertokendetails-authorizationheader

token_name

User friendly bearer token name.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-bearertokendetails.html#cfn-devopsagent-service-bearertokendetails-tokenname

token_value

Bearer token value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-bearertokendetails.html#cfn-devopsagent-service-bearertokendetails-tokenvalue

DynatraceAuthorizationConfigProperty

class CfnService.DynatraceAuthorizationConfigProperty(*, o_auth_client_credentials=None)

Bases: object

Dynatrace OAuth authorization configuration.

Parameters:

o_auth_client_credentials (Union[IResolvable, OAuthClientDetailsProperty, Dict[str, Any], None]) – OAuth client credentials.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-dynatraceauthorizationconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_devopsagent as devopsagent

# exchange_parameters: Any

dynatrace_authorization_config_property = devopsagent.CfnService.DynatraceAuthorizationConfigProperty(
    o_auth_client_credentials=devopsagent.CfnService.OAuthClientDetailsProperty(
        client_id="clientId",
        client_secret="clientSecret",

        # the properties below are optional
        client_name="clientName",
        exchange_parameters=exchange_parameters
    )
)

Attributes

o_auth_client_credentials

OAuth client credentials.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-dynatraceauthorizationconfig.html#cfn-devopsagent-service-dynatraceauthorizationconfig-oauthclientcredentials

DynatraceServiceDetailsProperty

class CfnService.DynatraceServiceDetailsProperty(*, account_urn, authorization_config=None)

Bases: object

Dynatrace service configuration.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-dynatraceservicedetails.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_devopsagent as devopsagent

# exchange_parameters: Any

dynatrace_service_details_property = devopsagent.CfnService.DynatraceServiceDetailsProperty(
    account_urn="accountUrn",

    # the properties below are optional
    authorization_config=devopsagent.CfnService.DynatraceAuthorizationConfigProperty(
        o_auth_client_credentials=devopsagent.CfnService.OAuthClientDetailsProperty(
            client_id="clientId",
            client_secret="clientSecret",

            # the properties below are optional
            client_name="clientName",
            exchange_parameters=exchange_parameters
        )
    )
)

Attributes

account_urn

Dynatrace resource account URN.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-dynatraceservicedetails.html#cfn-devopsagent-service-dynatraceservicedetails-accounturn

authorization_config

Dynatrace OAuth authorization configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-dynatraceservicedetails.html#cfn-devopsagent-service-dynatraceservicedetails-authorizationconfig

GitLabDetailsProperty

class CfnService.GitLabDetailsProperty(*, target_url, token_type, token_value, group_id=None)

Bases: object

GitLab service configuration.

Parameters:

  • target_url (str) – GitLab instance URL.

  • token_type (str) – Type of GitLab access token.

  • token_value (str) – GitLab access token value.

  • group_id (Optional[str]) – Optional GitLab group ID for group-level access tokens.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-gitlabdetails.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_devopsagent as devopsagent

git_lab_details_property = devopsagent.CfnService.GitLabDetailsProperty(
    target_url="targetUrl",
    token_type="tokenType",
    token_value="tokenValue",

    # the properties below are optional
    group_id="groupId"
)

Attributes

group_id

Optional GitLab group ID for group-level access tokens.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-gitlabdetails.html#cfn-devopsagent-service-gitlabdetails-groupid

target_url

GitLab instance URL.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-gitlabdetails.html#cfn-devopsagent-service-gitlabdetails-targeturl

token_type

Type of GitLab access token.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-gitlabdetails.html#cfn-devopsagent-service-gitlabdetails-tokentype

token_value

GitLab access token value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-gitlabdetails.html#cfn-devopsagent-service-gitlabdetails-tokenvalue

MCPServerAuthorizationConfigProperty

class CfnService.MCPServerAuthorizationConfigProperty(*, api_key=None, o_auth_client_credentials=None)

Bases: object

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-mcpserverauthorizationconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_devopsagent as devopsagent

# exchange_parameters: Any

m_cPServer_authorization_config_property = devopsagent.CfnService.MCPServerAuthorizationConfigProperty(
    api_key=devopsagent.CfnService.ApiKeyDetailsProperty(
        api_key_header="apiKeyHeader",
        api_key_name="apiKeyName",
        api_key_value="apiKeyValue"
    ),
    o_auth_client_credentials=devopsagent.CfnService.MCPServerOAuthClientCredentialsConfigProperty(
        client_id="clientId",
        client_secret="clientSecret",
        exchange_url="exchangeUrl",

        # the properties below are optional
        client_name="clientName",
        exchange_parameters=exchange_parameters,
        scopes=["scopes"]
    )
)

Attributes

api_key

API key authentication details.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-mcpserverauthorizationconfig.html#cfn-devopsagent-service-mcpserverauthorizationconfig-apikey

o_auth_client_credentials

MCP server OAuth client credentials configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-mcpserverauthorizationconfig.html#cfn-devopsagent-service-mcpserverauthorizationconfig-oauthclientcredentials

MCPServerDetailsProperty

class CfnService.MCPServerDetailsProperty(*, authorization_config, endpoint, name, description=None)

Bases: object

MCP server configuration.

Parameters:

  • authorization_config (Union[IResolvable, MCPServerAuthorizationConfigProperty, Dict[str, Any]]) – MCP server authorization configuration.

  • endpoint (str) – MCP server endpoint URL.

  • name (str) – MCP server name.

  • description (Optional[str]) – Optional description for the MCP server.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-mcpserverdetails.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_devopsagent as devopsagent

# exchange_parameters: Any

m_cPServer_details_property = devopsagent.CfnService.MCPServerDetailsProperty(
    authorization_config=devopsagent.CfnService.MCPServerAuthorizationConfigProperty(
        api_key=devopsagent.CfnService.ApiKeyDetailsProperty(
            api_key_header="apiKeyHeader",
            api_key_name="apiKeyName",
            api_key_value="apiKeyValue"
        ),
        o_auth_client_credentials=devopsagent.CfnService.MCPServerOAuthClientCredentialsConfigProperty(
            client_id="clientId",
            client_secret="clientSecret",
            exchange_url="exchangeUrl",

            # the properties below are optional
            client_name="clientName",
            exchange_parameters=exchange_parameters,
            scopes=["scopes"]
        )
    ),
    endpoint="endpoint",
    name="name",

    # the properties below are optional
    description="description"
)

Attributes

authorization_config

MCP server authorization configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-mcpserverdetails.html#cfn-devopsagent-service-mcpserverdetails-authorizationconfig

description

Optional description for the MCP server.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-mcpserverdetails.html#cfn-devopsagent-service-mcpserverdetails-description

endpoint

MCP server endpoint URL.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-mcpserverdetails.html#cfn-devopsagent-service-mcpserverdetails-endpoint

name

MCP server name.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-mcpserverdetails.html#cfn-devopsagent-service-mcpserverdetails-name

MCPServerOAuthClientCredentialsConfigProperty

class CfnService.MCPServerOAuthClientCredentialsConfigProperty(*, client_id, client_secret, exchange_url, client_name=None, exchange_parameters=None, scopes=None)

Bases: object

MCP server OAuth client credentials configuration.

Parameters:

  • client_id (str) – OAuth client ID.

  • client_secret (str) – OAuth client secret.

  • exchange_url (str) – OAuth token exchange URL.

  • client_name (Optional[str]) – User friendly OAuth client name.

  • exchange_parameters (Any) – OAuth token exchange parameters.

  • scopes (Optional[Sequence[str]]) – OAuth scopes.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-mcpserveroauthclientcredentialsconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_devopsagent as devopsagent

# exchange_parameters: Any

m_cPServer_oAuth_client_credentials_config_property = devopsagent.CfnService.MCPServerOAuthClientCredentialsConfigProperty(
    client_id="clientId",
    client_secret="clientSecret",
    exchange_url="exchangeUrl",

    # the properties below are optional
    client_name="clientName",
    exchange_parameters=exchange_parameters,
    scopes=["scopes"]
)

Attributes

client_id

OAuth client ID.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-mcpserveroauthclientcredentialsconfig.html#cfn-devopsagent-service-mcpserveroauthclientcredentialsconfig-clientid

client_name

User friendly OAuth client name.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-mcpserveroauthclientcredentialsconfig.html#cfn-devopsagent-service-mcpserveroauthclientcredentialsconfig-clientname

client_secret

OAuth client secret.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-mcpserveroauthclientcredentialsconfig.html#cfn-devopsagent-service-mcpserveroauthclientcredentialsconfig-clientsecret

exchange_parameters

OAuth token exchange parameters.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-mcpserveroauthclientcredentialsconfig.html#cfn-devopsagent-service-mcpserveroauthclientcredentialsconfig-exchangeparameters

exchange_url

OAuth token exchange URL.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-mcpserveroauthclientcredentialsconfig.html#cfn-devopsagent-service-mcpserveroauthclientcredentialsconfig-exchangeurl

scopes

OAuth scopes.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-mcpserveroauthclientcredentialsconfig.html#cfn-devopsagent-service-mcpserveroauthclientcredentialsconfig-scopes

MCPServerSplunkAuthorizationConfigProperty

class CfnService.MCPServerSplunkAuthorizationConfigProperty(*, bearer_token)

Bases: object

MCP server splunk authorization configuration.

Parameters:

bearer_token (Union[IResolvable, BearerTokenDetailsProperty, Dict[str, Any]]) – Bearer token authentication details.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-mcpserversplunkauthorizationconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_devopsagent as devopsagent

m_cPServer_splunk_authorization_config_property = devopsagent.CfnService.MCPServerSplunkAuthorizationConfigProperty(
    bearer_token=devopsagent.CfnService.BearerTokenDetailsProperty(
        token_name="tokenName",
        token_value="tokenValue",

        # the properties below are optional
        authorization_header="authorizationHeader"
    )
)

Attributes

bearer_token

Bearer token authentication details.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-mcpserversplunkauthorizationconfig.html#cfn-devopsagent-service-mcpserversplunkauthorizationconfig-bearertoken

MCPServerSplunkDetailsProperty

class CfnService.MCPServerSplunkDetailsProperty(*, authorization_config, endpoint, name, description=None)

Bases: object

Splunk MCP server configuration.

Parameters:

  • authorization_config (Union[IResolvable, MCPServerSplunkAuthorizationConfigProperty, Dict[str, Any]]) – MCP server splunk authorization configuration.

  • endpoint (str) – MCP server endpoint URL.

  • name (str) – MCP server name.

  • description (Optional[str]) – Optional description for the MCP server.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-mcpserversplunkdetails.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_devopsagent as devopsagent

m_cPServer_splunk_details_property = devopsagent.CfnService.MCPServerSplunkDetailsProperty(
    authorization_config=devopsagent.CfnService.MCPServerSplunkAuthorizationConfigProperty(
        bearer_token=devopsagent.CfnService.BearerTokenDetailsProperty(
            token_name="tokenName",
            token_value="tokenValue",

            # the properties below are optional
            authorization_header="authorizationHeader"
        )
    ),
    endpoint="endpoint",
    name="name",

    # the properties below are optional
    description="description"
)

Attributes

authorization_config

MCP server splunk authorization configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-mcpserversplunkdetails.html#cfn-devopsagent-service-mcpserversplunkdetails-authorizationconfig

description

Optional description for the MCP server.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-mcpserversplunkdetails.html#cfn-devopsagent-service-mcpserversplunkdetails-description

endpoint

MCP server endpoint URL.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-mcpserversplunkdetails.html#cfn-devopsagent-service-mcpserversplunkdetails-endpoint

name

MCP server name.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-mcpserversplunkdetails.html#cfn-devopsagent-service-mcpserversplunkdetails-name

NewRelicApiKeyConfigProperty

class CfnService.NewRelicApiKeyConfigProperty(*, account_id, api_key, region, alert_policy_ids=None, application_ids=None, entity_guids=None)

Bases: object

New Relic API key configuration.

Parameters:

  • account_id (str) – New Relic Account ID.

  • api_key (str) – New Relic User API Key.

  • region (str) – New Relic region.

  • alert_policy_ids (Optional[Sequence[str]]) – List of alert policy IDs.

  • application_ids (Optional[Sequence[str]]) – List of monitored APM application IDs.

  • entity_guids (Optional[Sequence[str]]) – List of globally unique IDs for New Relic resources.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-newrelicapikeyconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_devopsagent as devopsagent

new_relic_api_key_config_property = devopsagent.CfnService.NewRelicApiKeyConfigProperty(
    account_id="accountId",
    api_key="apiKey",
    region="region",

    # the properties below are optional
    alert_policy_ids=["alertPolicyIds"],
    application_ids=["applicationIds"],
    entity_guids=["entityGuids"]
)

Attributes

account_id

New Relic Account ID.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-newrelicapikeyconfig.html#cfn-devopsagent-service-newrelicapikeyconfig-accountid

alert_policy_ids

List of alert policy IDs.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-newrelicapikeyconfig.html#cfn-devopsagent-service-newrelicapikeyconfig-alertpolicyids

api_key

New Relic User API Key.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-newrelicapikeyconfig.html#cfn-devopsagent-service-newrelicapikeyconfig-apikey

application_ids

List of monitored APM application IDs.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-newrelicapikeyconfig.html#cfn-devopsagent-service-newrelicapikeyconfig-applicationids

entity_guids

List of globally unique IDs for New Relic resources.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-newrelicapikeyconfig.html#cfn-devopsagent-service-newrelicapikeyconfig-entityguids

region

New Relic region.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-newrelicapikeyconfig.html#cfn-devopsagent-service-newrelicapikeyconfig-region

NewRelicAuthorizationConfigProperty

class CfnService.NewRelicAuthorizationConfigProperty(*, api_key)

Bases: object

New Relic authorization configuration.

Parameters:

api_key (Union[IResolvable, NewRelicApiKeyConfigProperty, Dict[str, Any]]) – New Relic API key configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-newrelicauthorizationconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_devopsagent as devopsagent

new_relic_authorization_config_property = devopsagent.CfnService.NewRelicAuthorizationConfigProperty(
    api_key=devopsagent.CfnService.NewRelicApiKeyConfigProperty(
        account_id="accountId",
        api_key="apiKey",
        region="region",

        # the properties below are optional
        alert_policy_ids=["alertPolicyIds"],
        application_ids=["applicationIds"],
        entity_guids=["entityGuids"]
    )
)

Attributes

api_key

New Relic API key configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-newrelicauthorizationconfig.html#cfn-devopsagent-service-newrelicauthorizationconfig-apikey

NewRelicServiceDetailsProperty

class CfnService.NewRelicServiceDetailsProperty(*, authorization_config)

Bases: object

New Relic service configuration.

Parameters:

authorization_config (Union[IResolvable, NewRelicAuthorizationConfigProperty, Dict[str, Any]]) – New Relic authorization configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-newrelicservicedetails.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_devopsagent as devopsagent

new_relic_service_details_property = devopsagent.CfnService.NewRelicServiceDetailsProperty(
    authorization_config=devopsagent.CfnService.NewRelicAuthorizationConfigProperty(
        api_key=devopsagent.CfnService.NewRelicApiKeyConfigProperty(
            account_id="accountId",
            api_key="apiKey",
            region="region",

            # the properties below are optional
            alert_policy_ids=["alertPolicyIds"],
            application_ids=["applicationIds"],
            entity_guids=["entityGuids"]
        )
    )
)

Attributes

authorization_config

New Relic authorization configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-newrelicservicedetails.html#cfn-devopsagent-service-newrelicservicedetails-authorizationconfig

OAuthClientDetailsProperty

class CfnService.OAuthClientDetailsProperty(*, client_id, client_secret, client_name=None, exchange_parameters=None)

Bases: object

OAuth client credentials.

Parameters:

  • client_id (str) – OAuth client ID.

  • client_secret (str) – OAuth client secret.

  • client_name (Optional[str]) – User friendly OAuth client name.

  • exchange_parameters (Any) – OAuth token exchange parameters.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-oauthclientdetails.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_devopsagent as devopsagent

# exchange_parameters: Any

o_auth_client_details_property = devopsagent.CfnService.OAuthClientDetailsProperty(
    client_id="clientId",
    client_secret="clientSecret",

    # the properties below are optional
    client_name="clientName",
    exchange_parameters=exchange_parameters
)

Attributes

client_id

OAuth client ID.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-oauthclientdetails.html#cfn-devopsagent-service-oauthclientdetails-clientid

client_name

User friendly OAuth client name.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-oauthclientdetails.html#cfn-devopsagent-service-oauthclientdetails-clientname

client_secret

OAuth client secret.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-oauthclientdetails.html#cfn-devopsagent-service-oauthclientdetails-clientsecret

exchange_parameters

OAuth token exchange parameters.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-oauthclientdetails.html#cfn-devopsagent-service-oauthclientdetails-exchangeparameters

RegisteredDynatraceDetailsProperty

class CfnService.RegisteredDynatraceDetailsProperty(*, account_urn)

Bases: object

Dynatrace service details returned after registration.

Parameters:

account_urn (str) – Dynatrace resource account URN.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-registereddynatracedetails.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_devopsagent as devopsagent

registered_dynatrace_details_property = devopsagent.CfnService.RegisteredDynatraceDetailsProperty(
    account_urn="accountUrn"
)

Attributes

account_urn

Dynatrace resource account URN.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-registereddynatracedetails.html#cfn-devopsagent-service-registereddynatracedetails-accounturn

RegisteredGitLabServiceDetailsProperty

class CfnService.RegisteredGitLabServiceDetailsProperty(*, target_url, token_type, group_id=None)

Bases: object

GitLab service details returned after registration.

Parameters:

  • target_url (str) – GitLab instance URL.

  • token_type (str) – Type of GitLab access token.

  • group_id (Optional[str]) – Optional GitLab group ID for group-level access tokens.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-registeredgitlabservicedetails.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_devopsagent as devopsagent

registered_git_lab_service_details_property = devopsagent.CfnService.RegisteredGitLabServiceDetailsProperty(
    target_url="targetUrl",
    token_type="tokenType",

    # the properties below are optional
    group_id="groupId"
)

Attributes

group_id

Optional GitLab group ID for group-level access tokens.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-registeredgitlabservicedetails.html#cfn-devopsagent-service-registeredgitlabservicedetails-groupid

target_url

GitLab instance URL.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-registeredgitlabservicedetails.html#cfn-devopsagent-service-registeredgitlabservicedetails-targeturl

token_type

Type of GitLab access token.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-registeredgitlabservicedetails.html#cfn-devopsagent-service-registeredgitlabservicedetails-tokentype

RegisteredMCPServerDetailsProperty

class CfnService.RegisteredMCPServerDetailsProperty(*, authorization_method, endpoint, name, api_key_header=None, description=None)

Bases: object

MCP server details returned after registration.

Parameters:

  • authorization_method (str) – MCP server authorization method.

  • endpoint (str) – MCP server endpoint URL.

  • name (str) – MCP server name.

  • api_key_header (Optional[str]) – API key header name if using API key authentication.

  • description (Optional[str]) – Optional description for the MCP server.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-registeredmcpserverdetails.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_devopsagent as devopsagent

registered_mCPServer_details_property = devopsagent.CfnService.RegisteredMCPServerDetailsProperty(
    authorization_method="authorizationMethod",
    endpoint="endpoint",
    name="name",

    # the properties below are optional
    api_key_header="apiKeyHeader",
    description="description"
)

Attributes

api_key_header

API key header name if using API key authentication.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-registeredmcpserverdetails.html#cfn-devopsagent-service-registeredmcpserverdetails-apikeyheader

authorization_method

MCP server authorization method.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-registeredmcpserverdetails.html#cfn-devopsagent-service-registeredmcpserverdetails-authorizationmethod

description

Optional description for the MCP server.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-registeredmcpserverdetails.html#cfn-devopsagent-service-registeredmcpserverdetails-description

endpoint

MCP server endpoint URL.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-registeredmcpserverdetails.html#cfn-devopsagent-service-registeredmcpserverdetails-endpoint

name

MCP server name.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-registeredmcpserverdetails.html#cfn-devopsagent-service-registeredmcpserverdetails-name

RegisteredNewRelicDetailsProperty

class CfnService.RegisteredNewRelicDetailsProperty(*, account_id, region, description=None)

Bases: object

New Relic service details returned after registration.

Parameters:

  • account_id (str) – New Relic account ID.

  • region (str) – New Relic region.

  • description (Optional[str]) – Optional user description.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-registerednewrelicdetails.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_devopsagent as devopsagent

registered_new_relic_details_property = devopsagent.CfnService.RegisteredNewRelicDetailsProperty(
    account_id="accountId",
    region="region",

    # the properties below are optional
    description="description"
)

Attributes

account_id

New Relic account ID.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-registerednewrelicdetails.html#cfn-devopsagent-service-registerednewrelicdetails-accountid

description

Optional user description.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-registerednewrelicdetails.html#cfn-devopsagent-service-registerednewrelicdetails-description

region

New Relic region.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-registerednewrelicdetails.html#cfn-devopsagent-service-registerednewrelicdetails-region

RegisteredServiceNowDetailsProperty

class CfnService.RegisteredServiceNowDetailsProperty(*, instance_url)

Bases: object

ServiceNow service details returned after registration.

Parameters:

instance_url (str) – ServiceNow instance URL.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-registeredservicenowdetails.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_devopsagent as devopsagent

registered_service_now_details_property = devopsagent.CfnService.RegisteredServiceNowDetailsProperty(
    instance_url="instanceUrl"
)

Attributes

instance_url

ServiceNow instance URL.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-registeredservicenowdetails.html#cfn-devopsagent-service-registeredservicenowdetails-instanceurl

ServiceDetailsProperty

class CfnService.ServiceDetailsProperty(*, dynatrace=None, git_lab=None, mcp_server=None, mcp_server_new_relic=None, mcp_server_splunk=None, service_now=None)

Bases: object

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-servicedetails.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_devopsagent as devopsagent

# exchange_parameters: Any

service_details_property = devopsagent.CfnService.ServiceDetailsProperty(
    dynatrace=devopsagent.CfnService.DynatraceServiceDetailsProperty(
        account_urn="accountUrn",

        # the properties below are optional
        authorization_config=devopsagent.CfnService.DynatraceAuthorizationConfigProperty(
            o_auth_client_credentials=devopsagent.CfnService.OAuthClientDetailsProperty(
                client_id="clientId",
                client_secret="clientSecret",

                # the properties below are optional
                client_name="clientName",
                exchange_parameters=exchange_parameters
            )
        )
    ),
    git_lab=devopsagent.CfnService.GitLabDetailsProperty(
        target_url="targetUrl",
        token_type="tokenType",
        token_value="tokenValue",

        # the properties below are optional
        group_id="groupId"
    ),
    mcp_server=devopsagent.CfnService.MCPServerDetailsProperty(
        authorization_config=devopsagent.CfnService.MCPServerAuthorizationConfigProperty(
            api_key=devopsagent.CfnService.ApiKeyDetailsProperty(
                api_key_header="apiKeyHeader",
                api_key_name="apiKeyName",
                api_key_value="apiKeyValue"
            ),
            o_auth_client_credentials=devopsagent.CfnService.MCPServerOAuthClientCredentialsConfigProperty(
                client_id="clientId",
                client_secret="clientSecret",
                exchange_url="exchangeUrl",

                # the properties below are optional
                client_name="clientName",
                exchange_parameters=exchange_parameters,
                scopes=["scopes"]
            )
        ),
        endpoint="endpoint",
        name="name",

        # the properties below are optional
        description="description"
    ),
    mcp_server_new_relic=devopsagent.CfnService.NewRelicServiceDetailsProperty(
        authorization_config=devopsagent.CfnService.NewRelicAuthorizationConfigProperty(
            api_key=devopsagent.CfnService.NewRelicApiKeyConfigProperty(
                account_id="accountId",
                api_key="apiKey",
                region="region",

                # the properties below are optional
                alert_policy_ids=["alertPolicyIds"],
                application_ids=["applicationIds"],
                entity_guids=["entityGuids"]
            )
        )
    ),
    mcp_server_splunk=devopsagent.CfnService.MCPServerSplunkDetailsProperty(
        authorization_config=devopsagent.CfnService.MCPServerSplunkAuthorizationConfigProperty(
            bearer_token=devopsagent.CfnService.BearerTokenDetailsProperty(
                token_name="tokenName",
                token_value="tokenValue",

                # the properties below are optional
                authorization_header="authorizationHeader"
            )
        ),
        endpoint="endpoint",
        name="name",

        # the properties below are optional
        description="description"
    ),
    service_now=devopsagent.CfnService.ServiceNowServiceDetailsProperty(
        instance_url="instanceUrl",

        # the properties below are optional
        authorization_config=devopsagent.CfnService.ServiceNowAuthorizationConfigProperty(
            o_auth_client_credentials=devopsagent.CfnService.OAuthClientDetailsProperty(
                client_id="clientId",
                client_secret="clientSecret",

                # the properties below are optional
                client_name="clientName",
                exchange_parameters=exchange_parameters
            )
        )
    )
)

Attributes

dynatrace

Dynatrace service configuration.

See:

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

git_lab

GitLab service configuration.

See:

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

mcp_server

MCP server configuration.

See:

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

mcp_server_new_relic

New Relic service configuration.

See:

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

mcp_server_splunk

Splunk MCP server configuration.

See:

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

service_now

ServiceNow service configuration.

See:

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

ServiceNowAuthorizationConfigProperty

class CfnService.ServiceNowAuthorizationConfigProperty(*, o_auth_client_credentials=None)

Bases: object

ServiceNow OAuth authorization configuration.

Parameters:

o_auth_client_credentials (Union[IResolvable, OAuthClientDetailsProperty, Dict[str, Any], None]) – OAuth client credentials.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-servicenowauthorizationconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_devopsagent as devopsagent

# exchange_parameters: Any

service_now_authorization_config_property = devopsagent.CfnService.ServiceNowAuthorizationConfigProperty(
    o_auth_client_credentials=devopsagent.CfnService.OAuthClientDetailsProperty(
        client_id="clientId",
        client_secret="clientSecret",

        # the properties below are optional
        client_name="clientName",
        exchange_parameters=exchange_parameters
    )
)

Attributes

o_auth_client_credentials

OAuth client credentials.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-servicenowauthorizationconfig.html#cfn-devopsagent-service-servicenowauthorizationconfig-oauthclientcredentials

ServiceNowServiceDetailsProperty

class CfnService.ServiceNowServiceDetailsProperty(*, instance_url, authorization_config=None)

Bases: object

ServiceNow service configuration.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-servicenowservicedetails.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_devopsagent as devopsagent

# exchange_parameters: Any

service_now_service_details_property = devopsagent.CfnService.ServiceNowServiceDetailsProperty(
    instance_url="instanceUrl",

    # the properties below are optional
    authorization_config=devopsagent.CfnService.ServiceNowAuthorizationConfigProperty(
        o_auth_client_credentials=devopsagent.CfnService.OAuthClientDetailsProperty(
            client_id="clientId",
            client_secret="clientSecret",

            # the properties below are optional
            client_name="clientName",
            exchange_parameters=exchange_parameters
        )
    )
)

Attributes

authorization_config

ServiceNow OAuth authorization configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-servicenowservicedetails.html#cfn-devopsagent-service-servicenowservicedetails-authorizationconfig

instance_url

ServiceNow instance URL.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-servicenowservicedetails.html#cfn-devopsagent-service-servicenowservicedetails-instanceurl