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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb

Overview

Describes the properties of a certificate.

See Also:

Constant Summary collapse

SENSITIVE = 
[:certificate, :certificate_chain]

Instance Attribute Summary collapse

Instance Attribute Details

#active_date ⇒ Time

An optional date that specifies when the certificate becomes active.

Returns:

  • (Time) 


2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
 
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2287

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) 


2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
 
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2287

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) 


2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
 
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2287

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) 


2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
 
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2287

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) 


2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
 
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2287

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) 


2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
 
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2287

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.

Returns:

  • (Time) 


2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
 
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2287

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) 


2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
 
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2287

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) 


2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
 
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2287

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) 


2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
 
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2287

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

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) 


2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
 
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2287

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:



2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
 
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2287

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) 


2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
 
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2287

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) 


2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
 
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2287

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