You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::CloudFront::Types::TrustedSigners

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

Overview

Note:

When making an API call, you may pass TrustedSigners data as a hash:

{
  enabled: false, # required
  quantity: 1, # required
  items: ["string"],
}

A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.

If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, see Serving Private Content through CloudFront in the Amazon Amazon CloudFront Developer Guide.

If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items.

To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

For more information about updating the distribution configuration, see DistributionConfig .

Instance Attribute Summary collapse

Instance Attribute Details

#enabledBoolean

Specifies whether you want to require viewers to use signed URLs to access the files specified by PathPattern and TargetOriginId.

Returns:

  • (Boolean)


5188
5189
5190
5191
5192
5193
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 5188

class TrustedSigners < Struct.new(
  :enabled,
  :quantity,
  :items)
  include Aws::Structure
end

#itemsArray<String>

Optional: A complex type that contains trusted signers for this cache behavior. If Quantity is 0, you can omit Items.

Returns:

  • (Array<String>)


5188
5189
5190
5191
5192
5193
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 5188

class TrustedSigners < Struct.new(
  :enabled,
  :quantity,
  :items)
  include Aws::Structure
end

#quantityInteger

The number of trusted signers for this cache behavior.

Returns:

  • (Integer)


5188
5189
5190
5191
5192
5193
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 5188

class TrustedSigners < Struct.new(
  :enabled,
  :quantity,
  :items)
  include Aws::Structure
end