Class: Aws::Transfer::Types::DescribedCertificate

Inherits:

Struct

• Object
• Struct
• Aws::Transfer::Types::DescribedCertificate

Includes:

Structure

Defined in:

lib/aws-sdk-transfer/types.rb

Overview

Describes the properties of a certificate.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:certificate, :certificate_chain]

Instance Attribute Summary

• #active_date ⇒ Time

  An optional date that specifies when the certificate becomes active.

• #arn ⇒ String

  The unique Amazon Resource Name (ARN) for the certificate.

• #certificate ⇒ String

  The file name for the certificate.

• #certificate_chain ⇒ String

  The list of certificates that make up the chain for the certificate.

• #certificate_id ⇒ String

  An array of identifiers for the imported certificates.

• #description ⇒ String

  The name or description that’s used to identity the certificate.

• #inactive_date ⇒ Time

  An optional date that specifies when the certificate becomes inactive.

• #not_after_date ⇒ Time

  The final date that the certificate is valid.

• #not_before_date ⇒ Time

  The earliest date that the certificate is valid.

• #serial ⇒ String

  The serial number for the certificate.

• #status ⇒ String

  A certificate’s status can be either ‘ACTIVE` or `INACTIVE`.

• #tags ⇒ Array<Types::Tag>

  Key-value pairs that can be used to group and search for certificates.

• #type ⇒ String

  If a private key has been specified for the certificate, its type is ‘CERTIFICATE_WITH_PRIVATE_KEY`.

• #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 'lib/aws-sdk-transfer/types.rb', line 2567

class DescribedCertificate < Struct.new(
  :arn,
  :certificate_id,
  :usage,
  :status,
  :certificate,
  :certificate_chain,
  :active_date,
  :inactive_date,
  :serial,
  :not_before_date,
  :not_after_date,
  :type,
  :description,
  :tags)
  SENSITIVE = [:certificate, :certificate_chain]
  include Aws::Structure
end

#arn ⇒ String

The unique Amazon Resource Name (ARN) for the certificate.

Returns:

• (String)

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

class DescribedCertificate < Struct.new(
  :arn,
  :certificate_id,
  :usage,
  :status,
  :certificate,
  :certificate_chain,
  :active_date,
  :inactive_date,
  :serial,
  :not_before_date,
  :not_after_date,
  :type,
  :description,
  :tags)
  SENSITIVE = [:certificate, :certificate_chain]
  include Aws::Structure
end

#certificate ⇒ String

The file name for the certificate.

Returns:

• (String)

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

class DescribedCertificate < Struct.new(
  :arn,
  :certificate_id,
  :usage,
  :status,
  :certificate,
  :certificate_chain,
  :active_date,
  :inactive_date,
  :serial,
  :not_before_date,
  :not_after_date,
  :type,
  :description,
  :tags)
  SENSITIVE = [:certificate, :certificate_chain]
  include Aws::Structure
end

#certificate_chain ⇒ String

The list of certificates that make up the chain for the certificate.

Returns:

• (String)

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

class DescribedCertificate < Struct.new(
  :arn,
  :certificate_id,
  :usage,
  :status,
  :certificate,
  :certificate_chain,
  :active_date,
  :inactive_date,
  :serial,
  :not_before_date,
  :not_after_date,
  :type,
  :description,
  :tags)
  SENSITIVE = [:certificate, :certificate_chain]
  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 'lib/aws-sdk-transfer/types.rb', line 2567

class DescribedCertificate < Struct.new(
  :arn,
  :certificate_id,
  :usage,
  :status,
  :certificate,
  :certificate_chain,
  :active_date,
  :inactive_date,
  :serial,
  :not_before_date,
  :not_after_date,
  :type,
  :description,
  :tags)
  SENSITIVE = [:certificate, :certificate_chain]
  include Aws::Structure
end

#description ⇒ String

The name or description that’s used to identity the certificate.

Returns:

• (String)

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

class DescribedCertificate < Struct.new(
  :arn,
  :certificate_id,
  :usage,
  :status,
  :certificate,
  :certificate_chain,
  :active_date,
  :inactive_date,
  :serial,
  :not_before_date,
  :not_after_date,
  :type,
  :description,
  :tags)
  SENSITIVE = [:certificate, :certificate_chain]
  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 'lib/aws-sdk-transfer/types.rb', line 2567

class DescribedCertificate < Struct.new(
  :arn,
  :certificate_id,
  :usage,
  :status,
  :certificate,
  :certificate_chain,
  :active_date,
  :inactive_date,
  :serial,
  :not_before_date,
  :not_after_date,
  :type,
  :description,
  :tags)
  SENSITIVE = [:certificate, :certificate_chain]
  include Aws::Structure
end

#not_after_date ⇒ Time

The final date that the certificate is valid.

Returns:

• (Time)

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

class DescribedCertificate < Struct.new(
  :arn,
  :certificate_id,
  :usage,
  :status,
  :certificate,
  :certificate_chain,
  :active_date,
  :inactive_date,
  :serial,
  :not_before_date,
  :not_after_date,
  :type,
  :description,
  :tags)
  SENSITIVE = [:certificate, :certificate_chain]
  include Aws::Structure
end

#not_before_date ⇒ Time

The earliest date that the certificate is valid.

Returns:

• (Time)

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

class DescribedCertificate < Struct.new(
  :arn,
  :certificate_id,
  :usage,
  :status,
  :certificate,
  :certificate_chain,
  :active_date,
  :inactive_date,
  :serial,
  :not_before_date,
  :not_after_date,
  :type,
  :description,
  :tags)
  SENSITIVE = [:certificate, :certificate_chain]
  include Aws::Structure
end

#serial ⇒ String

The serial number for the certificate.

Returns:

• (String)

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

class DescribedCertificate < Struct.new(
  :arn,
  :certificate_id,
  :usage,
  :status,
  :certificate,
  :certificate_chain,
  :active_date,
  :inactive_date,
  :serial,
  :not_before_date,
  :not_after_date,
  :type,
  :description,
  :tags)
  SENSITIVE = [:certificate, :certificate_chain]
  include Aws::Structure
end

#status ⇒ String

A certificate’s status can be either ‘ACTIVE` or `INACTIVE`.

You can set ‘ActiveDate` and `InactiveDate` in the `UpdateCertificate` call. If you set values for these parameters, those values are used to determine whether the certificate has a status of `ACTIVE` or `INACTIVE`.

If you don’t set values for ‘ActiveDate` and `InactiveDate`, we use the `NotBefore` and `NotAfter` date as specified on the X509 certificate to determine when a certificate is active and when it is inactive.

Returns:

• (String)

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

class DescribedCertificate < Struct.new(
  :arn,
  :certificate_id,
  :usage,
  :status,
  :certificate,
  :certificate_chain,
  :active_date,
  :inactive_date,
  :serial,
  :not_before_date,
  :not_after_date,
  :type,
  :description,
  :tags)
  SENSITIVE = [:certificate, :certificate_chain]
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

Key-value pairs that can be used to group and search for certificates.

Returns:

• (Array<Types::Tag>)

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

class DescribedCertificate < Struct.new(
  :arn,
  :certificate_id,
  :usage,
  :status,
  :certificate,
  :certificate_chain,
  :active_date,
  :inactive_date,
  :serial,
  :not_before_date,
  :not_after_date,
  :type,
  :description,
  :tags)
  SENSITIVE = [:certificate, :certificate_chain]
  include Aws::Structure
end

#type ⇒ String

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 'lib/aws-sdk-transfer/types.rb', line 2567

class DescribedCertificate < Struct.new(
  :arn,
  :certificate_id,
  :usage,
  :status,
  :certificate,
  :certificate_chain,
  :active_date,
  :inactive_date,
  :serial,
  :not_before_date,
  :not_after_date,
  :type,
  :description,
  :tags)
  SENSITIVE = [:certificate, :certificate_chain]
  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 'lib/aws-sdk-transfer/types.rb', line 2567

class DescribedCertificate < Struct.new(
  :arn,
  :certificate_id,
  :usage,
  :status,
  :certificate,
  :certificate_chain,
  :active_date,
  :inactive_date,
  :serial,
  :not_before_date,
  :not_after_date,
  :type,
  :description,
  :tags)
  SENSITIVE = [:certificate, :certificate_chain]
  include Aws::Structure
end