AWS SDK for C++  1.9.1
AWS SDK for C++
Public Member Functions | List of all members
Aws::CloudFront::Model::S3OriginConfig Class Reference

#include <S3OriginConfig.h>

Public Member Functions

 S3OriginConfig ()
 
 S3OriginConfig (const Aws::Utils::Xml::XmlNode &xmlNode)
 
S3OriginConfigoperator= (const Aws::Utils::Xml::XmlNode &xmlNode)
 
void AddToNode (Aws::Utils::Xml::XmlNode &parentNode) const
 
const Aws::StringGetOriginAccessIdentity () const
 
bool OriginAccessIdentityHasBeenSet () const
 
void SetOriginAccessIdentity (const Aws::String &value)
 
void SetOriginAccessIdentity (Aws::String &&value)
 
void SetOriginAccessIdentity (const char *value)
 
S3OriginConfigWithOriginAccessIdentity (const Aws::String &value)
 
S3OriginConfigWithOriginAccessIdentity (Aws::String &&value)
 
S3OriginConfigWithOriginAccessIdentity (const char *value)
 

Detailed Description

A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin or an S3 bucket that is configured as a website endpoint, use the CustomOriginConfig element instead.

See Also:

AWS API Reference

Definition at line 33 of file S3OriginConfig.h.

Constructor & Destructor Documentation

◆ S3OriginConfig() [1/2]

Aws::CloudFront::Model::S3OriginConfig::S3OriginConfig ( )

◆ S3OriginConfig() [2/2]

Aws::CloudFront::Model::S3OriginConfig::S3OriginConfig ( const Aws::Utils::Xml::XmlNode xmlNode)

Member Function Documentation

◆ AddToNode()

void Aws::CloudFront::Model::S3OriginConfig::AddToNode ( Aws::Utils::Xml::XmlNode parentNode) const

◆ GetOriginAccessIdentity()

const Aws::String& Aws::CloudFront::Model::S3OriginConfig::GetOriginAccessIdentity ( ) const
inline

The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can only access objects in an Amazon S3 bucket through CloudFront. The format of the value is:

origin-access-identity/cloudfront/ID-of-origin-access-identity

where ID-of-origin-access-identity is the value that CloudFront returned in the ID element when you created the origin access identity.

If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element.

To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element.

To replace the origin access identity, update the distribution configuration and specify the new origin access identity.

For more information about the origin access identity, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

Definition at line 63 of file S3OriginConfig.h.

◆ operator=()

S3OriginConfig& Aws::CloudFront::Model::S3OriginConfig::operator= ( const Aws::Utils::Xml::XmlNode xmlNode)

◆ OriginAccessIdentityHasBeenSet()

bool Aws::CloudFront::Model::S3OriginConfig::OriginAccessIdentityHasBeenSet ( ) const
inline

The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can only access objects in an Amazon S3 bucket through CloudFront. The format of the value is:

origin-access-identity/cloudfront/ID-of-origin-access-identity

where ID-of-origin-access-identity is the value that CloudFront returned in the ID element when you created the origin access identity.

If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element.

To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element.

To replace the origin access identity, update the distribution configuration and specify the new origin access identity.

For more information about the origin access identity, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

Definition at line 85 of file S3OriginConfig.h.

◆ SetOriginAccessIdentity() [1/3]

void Aws::CloudFront::Model::S3OriginConfig::SetOriginAccessIdentity ( Aws::String &&  value)
inline

The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can only access objects in an Amazon S3 bucket through CloudFront. The format of the value is:

origin-access-identity/cloudfront/ID-of-origin-access-identity

where ID-of-origin-access-identity is the value that CloudFront returned in the ID element when you created the origin access identity.

If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element.

To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element.

To replace the origin access identity, update the distribution configuration and specify the new origin access identity.

For more information about the origin access identity, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

Definition at line 129 of file S3OriginConfig.h.

◆ SetOriginAccessIdentity() [2/3]

void Aws::CloudFront::Model::S3OriginConfig::SetOriginAccessIdentity ( const Aws::String value)
inline

The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can only access objects in an Amazon S3 bucket through CloudFront. The format of the value is:

origin-access-identity/cloudfront/ID-of-origin-access-identity

where ID-of-origin-access-identity is the value that CloudFront returned in the ID element when you created the origin access identity.

If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element.

To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element.

To replace the origin access identity, update the distribution configuration and specify the new origin access identity.

For more information about the origin access identity, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

Definition at line 107 of file S3OriginConfig.h.

◆ SetOriginAccessIdentity() [3/3]

void Aws::CloudFront::Model::S3OriginConfig::SetOriginAccessIdentity ( const char *  value)
inline

The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can only access objects in an Amazon S3 bucket through CloudFront. The format of the value is:

origin-access-identity/cloudfront/ID-of-origin-access-identity

where ID-of-origin-access-identity is the value that CloudFront returned in the ID element when you created the origin access identity.

If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element.

To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element.

To replace the origin access identity, update the distribution configuration and specify the new origin access identity.

For more information about the origin access identity, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

Definition at line 151 of file S3OriginConfig.h.

◆ WithOriginAccessIdentity() [1/3]

S3OriginConfig& Aws::CloudFront::Model::S3OriginConfig::WithOriginAccessIdentity ( Aws::String &&  value)
inline

The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can only access objects in an Amazon S3 bucket through CloudFront. The format of the value is:

origin-access-identity/cloudfront/ID-of-origin-access-identity

where ID-of-origin-access-identity is the value that CloudFront returned in the ID element when you created the origin access identity.

If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element.

To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element.

To replace the origin access identity, update the distribution configuration and specify the new origin access identity.

For more information about the origin access identity, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

Definition at line 195 of file S3OriginConfig.h.

◆ WithOriginAccessIdentity() [2/3]

S3OriginConfig& Aws::CloudFront::Model::S3OriginConfig::WithOriginAccessIdentity ( const Aws::String value)
inline

The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can only access objects in an Amazon S3 bucket through CloudFront. The format of the value is:

origin-access-identity/cloudfront/ID-of-origin-access-identity

where ID-of-origin-access-identity is the value that CloudFront returned in the ID element when you created the origin access identity.

If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element.

To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element.

To replace the origin access identity, update the distribution configuration and specify the new origin access identity.

For more information about the origin access identity, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

Definition at line 173 of file S3OriginConfig.h.

◆ WithOriginAccessIdentity() [3/3]

S3OriginConfig& Aws::CloudFront::Model::S3OriginConfig::WithOriginAccessIdentity ( const char *  value)
inline

The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can only access objects in an Amazon S3 bucket through CloudFront. The format of the value is:

origin-access-identity/cloudfront/ID-of-origin-access-identity

where ID-of-origin-access-identity is the value that CloudFront returned in the ID element when you created the origin access identity.

If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element.

To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element.

To replace the origin access identity, update the distribution configuration and specify the new origin access identity.

For more information about the origin access identity, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

Definition at line 217 of file S3OriginConfig.h.


The documentation for this class was generated from the following file: