AWS::SecurityAgent::Integration

Creates a new integration with a third-party provider, such as GitHub, for code review and remediation.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::SecurityAgent::Integration",
  "Properties" : {
      "DisplayName" : String,
      "KmsKeyId" : String,
      "PrivateConnectionName" : String,
      "Provider" : String,
      "ProviderInput" : ProviderInput,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::SecurityAgent::Integration
Properties:
  DisplayName: String
  KmsKeyId: String
  PrivateConnectionName: String
  Provider: String
  ProviderInput: 
    ProviderInput
  Tags: 
    - Tag

Properties

DisplayName

The display name of the integration.

Required: Yes

Type: String

Update requires: Replacement

KmsKeyId

Identifier of a KMS key. Can be a key ID, key ARN, alias name, or alias ARN.

Required: No

Type: String

Update requires: Replacement

PrivateConnectionName

The name of the private connection used to reach the integration's self-hosted instance over private networking, if one is configured.

Required: No

Type: String

Update requires: Replacement

Provider

The integration provider.

Required: Yes

Type: String

Allowed values: GITHUB | GITLAB | BITBUCKET | CONFLUENCE

Update requires: Replacement

ProviderInput

The provider-specific input for creating an integration. This is a union type that contains provider-specific configuration.

Required: No

Type: ProviderInput

Update requires: Replacement

Tags

Property description not available.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

Fn::GetAtt

Arn

Property description not available.

InstallationId

The installation identifier from the integration provider.

IntegrationId

The unique identifier of the integration.

ProviderType

The type of the integration provider.

TargetUrl

The HTTPS URL of the customer self-hosted instance, such as a GitHub Enterprise Server or self-managed GitLab instance. This value is absent for SaaS integrations.