Class: Aws::CloudWatchOmni::Types::Integration

Inherits:

Struct

• Object
• Struct
• Aws::CloudWatchOmni::Types::Integration

Defined in:

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

Overview

A connection between CloudWatch and an external system — such as a source of telemetry or configuration data, a messaging destination, or a model provider.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #auth_type ⇒ String

  The authentication method that an integration uses to connect to its external system.

• #authorization_url ⇒ String

  The URL the customer visits to authorize the integration.

• #created_at ⇒ Time

  The time at which the integration was created.

• #credential_arn ⇒ String

  The Amazon Resource Name (ARN) of the secret that stores the integration's credentials.

• #error_message ⇒ String

  A human-readable description of why the integration is in an ERROR or FAILED state.

• #integration_arn ⇒ String

  The Amazon Resource Name (ARN) of the integration.

• #integration_attributes ⇒ Hash<String,String>

  Provider-specific key/value attributes that configure the integration.

• #integration_id ⇒ String

  The unique identifier of the integration.

• #integration_type ⇒ String

  The type of external system that an integration connects to, such as a source of configuration data, a messaging destination, or a model provider.

• #name ⇒ String

  The customer-provided name of the integration.

• #role_arn ⇒ String

  The Amazon Resource Name (ARN) of the IAM role that CloudWatch assumes to access the external system.

• #scope ⇒ String

  Whether this integration is account-scoped (ACCOUNT, customer-created) or organization-scoped (ORGANIZATION, created by an org-enablement rule).

• #status ⇒ String

  The current lifecycle state of an integration.

• #updated_at ⇒ Time

  The time at which the integration was last updated.

Instance Attribute Details

#auth_type ⇒ String

The authentication method that an integration uses to connect to its external system.

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatchomni/lib/aws-sdk-cloudwatchomni/types.rb', line 2566

class Integration < Struct.new(
  :integration_id,
  :integration_arn,
  :integration_type,
  :name,
  :status,
  :auth_type,
  :credential_arn,
  :role_arn,
  :integration_attributes,
  :authorization_url,
  :error_message,
  :created_at,
  :updated_at,
  :scope)
  SENSITIVE = []
  include Aws::Structure
end

#authorization_url ⇒ String

The URL the customer visits to authorize the integration. Present while an OAuth authorization is pending.

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatchomni/lib/aws-sdk-cloudwatchomni/types.rb', line 2566

class Integration < Struct.new(
  :integration_id,
  :integration_arn,
  :integration_type,
  :name,
  :status,
  :auth_type,
  :credential_arn,
  :role_arn,
  :integration_attributes,
  :authorization_url,
  :error_message,
  :created_at,
  :updated_at,
  :scope)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ Time

The time at which the integration was created.

Returns:

• (Time)

# File 'gems/aws-sdk-cloudwatchomni/lib/aws-sdk-cloudwatchomni/types.rb', line 2566

class Integration < Struct.new(
  :integration_id,
  :integration_arn,
  :integration_type,
  :name,
  :status,
  :auth_type,
  :credential_arn,
  :role_arn,
  :integration_attributes,
  :authorization_url,
  :error_message,
  :created_at,
  :updated_at,
  :scope)
  SENSITIVE = []
  include Aws::Structure
end

#credential_arn ⇒ String

The Amazon Resource Name (ARN) of the secret that stores the integration's credentials.

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatchomni/lib/aws-sdk-cloudwatchomni/types.rb', line 2566

class Integration < Struct.new(
  :integration_id,
  :integration_arn,
  :integration_type,
  :name,
  :status,
  :auth_type,
  :credential_arn,
  :role_arn,
  :integration_attributes,
  :authorization_url,
  :error_message,
  :created_at,
  :updated_at,
  :scope)
  SENSITIVE = []
  include Aws::Structure
end

#error_message ⇒ String

A human-readable description of why the integration is in an ERROR or FAILED state. Present only when the integration has failed.

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatchomni/lib/aws-sdk-cloudwatchomni/types.rb', line 2566

class Integration < Struct.new(
  :integration_id,
  :integration_arn,
  :integration_type,
  :name,
  :status,
  :auth_type,
  :credential_arn,
  :role_arn,
  :integration_attributes,
  :authorization_url,
  :error_message,
  :created_at,
  :updated_at,
  :scope)
  SENSITIVE = []
  include Aws::Structure
end

#integration_arn ⇒ String

The Amazon Resource Name (ARN) of the integration.

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatchomni/lib/aws-sdk-cloudwatchomni/types.rb', line 2566

class Integration < Struct.new(
  :integration_id,
  :integration_arn,
  :integration_type,
  :name,
  :status,
  :auth_type,
  :credential_arn,
  :role_arn,
  :integration_attributes,
  :authorization_url,
  :error_message,
  :created_at,
  :updated_at,
  :scope)
  SENSITIVE = []
  include Aws::Structure
end

#integration_attributes ⇒ Hash<String,String>

Provider-specific key/value attributes that configure the integration.

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-cloudwatchomni/lib/aws-sdk-cloudwatchomni/types.rb', line 2566

class Integration < Struct.new(
  :integration_id,
  :integration_arn,
  :integration_type,
  :name,
  :status,
  :auth_type,
  :credential_arn,
  :role_arn,
  :integration_attributes,
  :authorization_url,
  :error_message,
  :created_at,
  :updated_at,
  :scope)
  SENSITIVE = []
  include Aws::Structure
end

#integration_id ⇒ String

The unique identifier of the integration.

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatchomni/lib/aws-sdk-cloudwatchomni/types.rb', line 2566

class Integration < Struct.new(
  :integration_id,
  :integration_arn,
  :integration_type,
  :name,
  :status,
  :auth_type,
  :credential_arn,
  :role_arn,
  :integration_attributes,
  :authorization_url,
  :error_message,
  :created_at,
  :updated_at,
  :scope)
  SENSITIVE = []
  include Aws::Structure
end

#integration_type ⇒ String

The type of external system that an integration connects to, such as a source of configuration data, a messaging destination, or a model provider.

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatchomni/lib/aws-sdk-cloudwatchomni/types.rb', line 2566

class Integration < Struct.new(
  :integration_id,
  :integration_arn,
  :integration_type,
  :name,
  :status,
  :auth_type,
  :credential_arn,
  :role_arn,
  :integration_attributes,
  :authorization_url,
  :error_message,
  :created_at,
  :updated_at,
  :scope)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The customer-provided name of the integration.

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatchomni/lib/aws-sdk-cloudwatchomni/types.rb', line 2566

class Integration < Struct.new(
  :integration_id,
  :integration_arn,
  :integration_type,
  :name,
  :status,
  :auth_type,
  :credential_arn,
  :role_arn,
  :integration_attributes,
  :authorization_url,
  :error_message,
  :created_at,
  :updated_at,
  :scope)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

The Amazon Resource Name (ARN) of the IAM role that CloudWatch assumes to access the external system.

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatchomni/lib/aws-sdk-cloudwatchomni/types.rb', line 2566

class Integration < Struct.new(
  :integration_id,
  :integration_arn,
  :integration_type,
  :name,
  :status,
  :auth_type,
  :credential_arn,
  :role_arn,
  :integration_attributes,
  :authorization_url,
  :error_message,
  :created_at,
  :updated_at,
  :scope)
  SENSITIVE = []
  include Aws::Structure
end

#scope ⇒ String

Whether this integration is account-scoped (ACCOUNT, customer-created) or organization-scoped (ORGANIZATION, created by an org-enablement rule). Absent on legacy records is treated as ACCOUNT.

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatchomni/lib/aws-sdk-cloudwatchomni/types.rb', line 2566

class Integration < Struct.new(
  :integration_id,
  :integration_arn,
  :integration_type,
  :name,
  :status,
  :auth_type,
  :credential_arn,
  :role_arn,
  :integration_attributes,
  :authorization_url,
  :error_message,
  :created_at,
  :updated_at,
  :scope)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The current lifecycle state of an integration.

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatchomni/lib/aws-sdk-cloudwatchomni/types.rb', line 2566

class Integration < Struct.new(
  :integration_id,
  :integration_arn,
  :integration_type,
  :name,
  :status,
  :auth_type,
  :credential_arn,
  :role_arn,
  :integration_attributes,
  :authorization_url,
  :error_message,
  :created_at,
  :updated_at,
  :scope)
  SENSITIVE = []
  include Aws::Structure
end

#updated_at ⇒ Time

The time at which the integration was last updated.

Returns:

• (Time)

# File 'gems/aws-sdk-cloudwatchomni/lib/aws-sdk-cloudwatchomni/types.rb', line 2566

class Integration < Struct.new(
  :integration_id,
  :integration_arn,
  :integration_type,
  :name,
  :status,
  :auth_type,
  :credential_arn,
  :role_arn,
  :integration_attributes,
  :authorization_url,
  :error_message,
  :created_at,
  :updated_at,
  :scope)
  SENSITIVE = []
  include Aws::Structure
end