Class: Aws::EventBridge::Types::DescribeConnectionResponse

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-eventbridge/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#auth_parameters ⇒ Types::ConnectionAuthResponseParameters

The parameters to use for authorization for the connection.

Returns:



1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
 
# File 'lib/aws-sdk-eventbridge/types.rb', line 1887

class DescribeConnectionResponse < Struct.new(
  :connection_arn,
  :name,
  :description,
  :invocation_connectivity_parameters,
  :connection_state,
  :state_reason,
  :authorization_type,
  :secret_arn,
  :kms_key_identifier,
  :auth_parameters,
  :creation_time,
  :last_modified_time,
  :last_authorized_time)
  SENSITIVE = []
  include Aws::Structure
end

#authorization_type ⇒ String

The type of authorization specified for the connection.

Returns:

  • (String) 


1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
 
# File 'lib/aws-sdk-eventbridge/types.rb', line 1887

class DescribeConnectionResponse < Struct.new(
  :connection_arn,
  :name,
  :description,
  :invocation_connectivity_parameters,
  :connection_state,
  :state_reason,
  :authorization_type,
  :secret_arn,
  :kms_key_identifier,
  :auth_parameters,
  :creation_time,
  :last_modified_time,
  :last_authorized_time)
  SENSITIVE = []
  include Aws::Structure
end

#connection_arn ⇒ String

The ARN of the connection retrieved.

Returns:

  • (String) 


1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
 
# File 'lib/aws-sdk-eventbridge/types.rb', line 1887

class DescribeConnectionResponse < Struct.new(
  :connection_arn,
  :name,
  :description,
  :invocation_connectivity_parameters,
  :connection_state,
  :state_reason,
  :authorization_type,
  :secret_arn,
  :kms_key_identifier,
  :auth_parameters,
  :creation_time,
  :last_modified_time,
  :last_authorized_time)
  SENSITIVE = []
  include Aws::Structure
end

#connection_state ⇒ String

The state of the connection retrieved.

Returns:

  • (String) 


1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
 
# File 'lib/aws-sdk-eventbridge/types.rb', line 1887

class DescribeConnectionResponse < Struct.new(
  :connection_arn,
  :name,
  :description,
  :invocation_connectivity_parameters,
  :connection_state,
  :state_reason,
  :authorization_type,
  :secret_arn,
  :kms_key_identifier,
  :auth_parameters,
  :creation_time,
  :last_modified_time,
  :last_authorized_time)
  SENSITIVE = []
  include Aws::Structure
end

#creation_time ⇒ Time

A time stamp for the time that the connection was created.

Returns:

  • (Time) 


1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
 
# File 'lib/aws-sdk-eventbridge/types.rb', line 1887

class DescribeConnectionResponse < Struct.new(
  :connection_arn,
  :name,
  :description,
  :invocation_connectivity_parameters,
  :connection_state,
  :state_reason,
  :authorization_type,
  :secret_arn,
  :kms_key_identifier,
  :auth_parameters,
  :creation_time,
  :last_modified_time,
  :last_authorized_time)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description for the connection retrieved.

Returns:

  • (String) 


1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
 
# File 'lib/aws-sdk-eventbridge/types.rb', line 1887

class DescribeConnectionResponse < Struct.new(
  :connection_arn,
  :name,
  :description,
  :invocation_connectivity_parameters,
  :connection_state,
  :state_reason,
  :authorization_type,
  :secret_arn,
  :kms_key_identifier,
  :auth_parameters,
  :creation_time,
  :last_modified_time,
  :last_authorized_time)
  SENSITIVE = []
  include Aws::Structure
end

#invocation_connectivity_parameters ⇒ Types::DescribeConnectionConnectivityParameters

For connections to private APIs The parameters EventBridge uses to invoke the resource endpoint.

For more information, see [Connecting to private APIs] in the Amazon EventBridge User Guide .

[1]: docs.aws.amazon.com/eventbridge/latest/userguide/connection-private.html

Returns:



1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
 
# File 'lib/aws-sdk-eventbridge/types.rb', line 1887

class DescribeConnectionResponse < Struct.new(
  :connection_arn,
  :name,
  :description,
  :invocation_connectivity_parameters,
  :connection_state,
  :state_reason,
  :authorization_type,
  :secret_arn,
  :kms_key_identifier,
  :auth_parameters,
  :creation_time,
  :last_modified_time,
  :last_authorized_time)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_identifier ⇒ String

The identifier of the KMS customer managed key for EventBridge to use to encrypt the connection, if one has been specified.

For more information, see [Encrypting connections] in the *Amazon EventBridge User Guide*.

[1]: docs.aws.amazon.com/eventbridge/latest/userguide/encryption-connections.html

Returns:

  • (String) 


1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
 
# File 'lib/aws-sdk-eventbridge/types.rb', line 1887

class DescribeConnectionResponse < Struct.new(
  :connection_arn,
  :name,
  :description,
  :invocation_connectivity_parameters,
  :connection_state,
  :state_reason,
  :authorization_type,
  :secret_arn,
  :kms_key_identifier,
  :auth_parameters,
  :creation_time,
  :last_modified_time,
  :last_authorized_time)
  SENSITIVE = []
  include Aws::Structure
end

#last_authorized_time ⇒ Time

A time stamp for the time that the connection was last authorized.

Returns:

  • (Time) 


1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
 
# File 'lib/aws-sdk-eventbridge/types.rb', line 1887

class DescribeConnectionResponse < Struct.new(
  :connection_arn,
  :name,
  :description,
  :invocation_connectivity_parameters,
  :connection_state,
  :state_reason,
  :authorization_type,
  :secret_arn,
  :kms_key_identifier,
  :auth_parameters,
  :creation_time,
  :last_modified_time,
  :last_authorized_time)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_time ⇒ Time

A time stamp for the time that the connection was last modified.

Returns:

  • (Time) 


1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
 
# File 'lib/aws-sdk-eventbridge/types.rb', line 1887

class DescribeConnectionResponse < Struct.new(
  :connection_arn,
  :name,
  :description,
  :invocation_connectivity_parameters,
  :connection_state,
  :state_reason,
  :authorization_type,
  :secret_arn,
  :kms_key_identifier,
  :auth_parameters,
  :creation_time,
  :last_modified_time,
  :last_authorized_time)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the connection retrieved.

Returns:

  • (String) 


1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
 
# File 'lib/aws-sdk-eventbridge/types.rb', line 1887

class DescribeConnectionResponse < Struct.new(
  :connection_arn,
  :name,
  :description,
  :invocation_connectivity_parameters,
  :connection_state,
  :state_reason,
  :authorization_type,
  :secret_arn,
  :kms_key_identifier,
  :auth_parameters,
  :creation_time,
  :last_modified_time,
  :last_authorized_time)
  SENSITIVE = []
  include Aws::Structure
end

#secret_arn ⇒ String

The ARN of the secret created from the authorization parameters specified for the connection.

Returns:

  • (String) 


1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
 
# File 'lib/aws-sdk-eventbridge/types.rb', line 1887

class DescribeConnectionResponse < Struct.new(
  :connection_arn,
  :name,
  :description,
  :invocation_connectivity_parameters,
  :connection_state,
  :state_reason,
  :authorization_type,
  :secret_arn,
  :kms_key_identifier,
  :auth_parameters,
  :creation_time,
  :last_modified_time,
  :last_authorized_time)
  SENSITIVE = []
  include Aws::Structure
end

#state_reason ⇒ String

The reason that the connection is in the current connection state.

Returns:

  • (String) 


1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
 
# File 'lib/aws-sdk-eventbridge/types.rb', line 1887

class DescribeConnectionResponse < Struct.new(
  :connection_arn,
  :name,
  :description,
  :invocation_connectivity_parameters,
  :connection_state,
  :state_reason,
  :authorization_type,
  :secret_arn,
  :kms_key_identifier,
  :auth_parameters,
  :creation_time,
  :last_modified_time,
  :last_authorized_time)
  SENSITIVE = []
  include Aws::Structure
end