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.

Constant Summary collapse

SENSITIVE =
[:certificate, :certificate_chain]

Instance Attribute Summary collapse

Instance Attribute Details

#active_dateTime

An optional date that specifies when the certificate becomes active.

Returns:

  • (Time)


2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2126

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

#arnString

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

Returns:

  • (String)


2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2126

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

#certificateString

The file name for the certificate.

Returns:

  • (String)


2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2126

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_chainString

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

Returns:

  • (String)


2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2126

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_idString

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

Returns:

  • (String)


2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2126

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

#descriptionString

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

Returns:

  • (String)


2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2126

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_dateTime

An optional date that specifies when the certificate becomes inactive.

Returns:

  • (Time)


2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2126

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_dateTime

The final date that the certificate is valid.

Returns:

  • (Time)


2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2126

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_dateTime

The earliest date that the certificate is valid.

Returns:

  • (Time)


2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2126

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

#serialString

The serial number for the certificate.

Returns:

  • (String)


2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2126

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

#statusString

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)


2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2126

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

#tagsArray<Types::Tag>

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

Returns:



2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2126

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

#typeString

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)


2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2126

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

#usageString

Specifies whether this certificate is used for signing or encryption.

Returns:

  • (String)


2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2126

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