Class: Aws::SecurityAgent::Types::IntegrationSummary

Inherits:

Struct

• Object
• Struct
• Aws::SecurityAgent::Types::IntegrationSummary

Defined in:

gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb

Overview

Contains summary information about an integration.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #display_name ⇒ String

  The display name of the integration.

• #installation_id ⇒ String

  The installation identifier from the integration provider.

• #integration_id ⇒ String

  The unique identifier of the integration.

• #private_connection_name ⇒ String

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

• #provider ⇒ String

  The integration provider.

• #provider_type ⇒ String

  The type of the integration provider.

• #target_url ⇒ String

  The HTTPS URL of the customer self-hosted instance, such as a GitHub Enterprise Server or self-managed GitLab instance.

• #webhook_url ⇒ String

  The payload URL of the integration's webhook, once it has been created.

Instance Attribute Details

#display_name ⇒ String

The display name of the integration.

Returns:

• (String)

# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 5122

class IntegrationSummary < Struct.new(
  :integration_id,
  :installation_id,
  :provider,
  :provider_type,
  :display_name,
  :target_url,
  :webhook_url,
  :private_connection_name)
  SENSITIVE = []
  include Aws::Structure
end

#installation_id ⇒ String

The installation identifier from the integration provider.

Returns:

• (String)

# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 5122

class IntegrationSummary < Struct.new(
  :integration_id,
  :installation_id,
  :provider,
  :provider_type,
  :display_name,
  :target_url,
  :webhook_url,
  :private_connection_name)
  SENSITIVE = []
  include Aws::Structure
end

#integration_id ⇒ String

The unique identifier of the integration.

Returns:

• (String)

# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 5122

class IntegrationSummary < Struct.new(
  :integration_id,
  :installation_id,
  :provider,
  :provider_type,
  :display_name,
  :target_url,
  :webhook_url,
  :private_connection_name)
  SENSITIVE = []
  include Aws::Structure
end

#private_connection_name ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 5122

class IntegrationSummary < Struct.new(
  :integration_id,
  :installation_id,
  :provider,
  :provider_type,
  :display_name,
  :target_url,
  :webhook_url,
  :private_connection_name)
  SENSITIVE = []
  include Aws::Structure
end

#provider ⇒ String

The integration provider.

Returns:

• (String)

# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 5122

class IntegrationSummary < Struct.new(
  :integration_id,
  :installation_id,
  :provider,
  :provider_type,
  :display_name,
  :target_url,
  :webhook_url,
  :private_connection_name)
  SENSITIVE = []
  include Aws::Structure
end

#provider_type ⇒ String

The type of the integration provider.

Returns:

• (String)

# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 5122

class IntegrationSummary < Struct.new(
  :integration_id,
  :installation_id,
  :provider,
  :provider_type,
  :display_name,
  :target_url,
  :webhook_url,
  :private_connection_name)
  SENSITIVE = []
  include Aws::Structure
end

#target_url ⇒ String

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.

Returns:

• (String)

# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 5122

class IntegrationSummary < Struct.new(
  :integration_id,
  :installation_id,
  :provider,
  :provider_type,
  :display_name,
  :target_url,
  :webhook_url,
  :private_connection_name)
  SENSITIVE = []
  include Aws::Structure
end

#webhook_url ⇒ String

The payload URL of the integration's webhook, once it has been created. The signing secret is never returned on a read.

Returns:

• (String)

# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 5122

class IntegrationSummary < Struct.new(
  :integration_id,
  :installation_id,
  :provider,
  :provider_type,
  :display_name,
  :target_url,
  :webhook_url,
  :private_connection_name)
  SENSITIVE = []
  include Aws::Structure
end