Class: Aws::Transfer::Types::ListedCertificate

Inherits:

Struct

• Object
• Struct
• Aws::Transfer::Types::ListedCertificate

Defined in:

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

Overview

Describes the properties of a certificate.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #active_date ⇒ Time

  An optional date that specifies when the certificate becomes active.

• #arn ⇒ String

  The Amazon Resource Name (ARN) of the specified certificate.

• #certificate_id ⇒ String

  An array of identifiers for the imported certificates.

• #description ⇒ String

  The name or short description that's used to identify the certificate.

• #inactive_date ⇒ Time

  An optional date that specifies when the certificate becomes inactive.

• #status ⇒ String

  The certificate can be either ACTIVE, PENDING_ROTATION, or INACTIVE.

• #type ⇒ String

  The type for the certificate.

• #usage ⇒ String

  Specifies how this certificate is used.

Instance Attribute Details

#active_date ⇒ Time

An optional date that specifies when the certificate becomes active. If you do not specify a value, ActiveDate takes the same value as NotBeforeDate, which is specified by the CA.

Returns:

• (Time)

# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 5158

class ListedCertificate < Struct.new(
  :arn,
  :certificate_id,
  :usage,
  :status,
  :active_date,
  :inactive_date,
  :type,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#arn ⇒ String

The Amazon Resource Name (ARN) of the specified certificate.

Returns:

• (String)

# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 5158

class ListedCertificate < Struct.new(
  :arn,
  :certificate_id,
  :usage,
  :status,
  :active_date,
  :inactive_date,
  :type,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#certificate_id ⇒ String

An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.

Returns:

• (String)

# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 5158

class ListedCertificate < Struct.new(
  :arn,
  :certificate_id,
  :usage,
  :status,
  :active_date,
  :inactive_date,
  :type,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The name or short description that's used to identify the certificate.

Returns:

• (String)

# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 5158

class ListedCertificate < Struct.new(
  :arn,
  :certificate_id,
  :usage,
  :status,
  :active_date,
  :inactive_date,
  :type,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#inactive_date ⇒ Time

An optional date that specifies when the certificate becomes inactive. If you do not specify a value, InactiveDate takes the same value as NotAfterDate, which is specified by the CA.

Returns:

• (Time)

# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 5158

class ListedCertificate < Struct.new(
  :arn,
  :certificate_id,
  :usage,
  :status,
  :active_date,
  :inactive_date,
  :type,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The certificate can be either ACTIVE, PENDING_ROTATION, or INACTIVE. PENDING_ROTATION means that this certificate will replace the current certificate when it expires.

Returns:

• (String)

# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 5158

class ListedCertificate < Struct.new(
  :arn,
  :certificate_id,
  :usage,
  :status,
  :active_date,
  :inactive_date,
  :type,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The type for the certificate. If a private key has been specified for the certificate, its type is CERTIFICATE_WITH_PRIVATE_KEY. If there is no private key, the type is CERTIFICATE.

Returns:

• (String)

# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 5158

class ListedCertificate < Struct.new(
  :arn,
  :certificate_id,
  :usage,
  :status,
  :active_date,
  :inactive_date,
  :type,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#usage ⇒ String

Specifies how this certificate is used. It can be used in the following ways:

• SIGNING: For signing AS2 messages

• ENCRYPTION: For encrypting AS2 messages

• TLS: For securing AS2 communications sent over HTTPS

Returns:

• (String)

# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 5158

class ListedCertificate < Struct.new(
  :arn,
  :certificate_id,
  :usage,
  :status,
  :active_date,
  :inactive_date,
  :type,
  :description)
  SENSITIVE = []
  include Aws::Structure
end