This repository has been archived on 2025-09-14. You can view files and clone it, but cannot push or open issues or pull requests.
Files
pxz-hos-client-cpp-module/support/aws-sdk-cpp-master/aws-cpp-sdk-cloudfront/include/aws/cloudfront/model/S3OriginConfig.h

228 lines
13 KiB
C++

/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include <aws/cloudfront/CloudFront_EXPORTS.h>
#include <aws/core/utils/memory/stl/AWSString.h>
#include <utility>
namespace Aws
{
namespace Utils
{
namespace Xml
{
class XmlNode;
} // namespace Xml
} // namespace Utils
namespace CloudFront
{
namespace Model
{
/**
* <p>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 <code>CustomOriginConfig</code> element instead.</p><p><h3>See
* Also:</h3> <a
* href="http://docs.aws.amazon.com/goto/WebAPI/cloudfront-2020-05-31/S3OriginConfig">AWS
* API Reference</a></p>
*/
class AWS_CLOUDFRONT_API S3OriginConfig
{
public:
S3OriginConfig();
S3OriginConfig(const Aws::Utils::Xml::XmlNode& xmlNode);
S3OriginConfig& operator=(const Aws::Utils::Xml::XmlNode& xmlNode);
void AddToNode(Aws::Utils::Xml::XmlNode& parentNode) const;
/**
* <p>The CloudFront origin access identity to associate with the origin. Use an
* origin access identity to configure the origin so that viewers can <i>only</i>
* access objects in an Amazon S3 bucket through CloudFront. The format of the
* value is:</p>
* <p>origin-access-identity/cloudfront/<i>ID-of-origin-access-identity</i> </p>
* <p>where <code> <i>ID-of-origin-access-identity</i> </code> is the value that
* CloudFront returned in the <code>ID</code> element when you created the origin
* access identity.</p> <p>If you want viewers to be able to access objects using
* either the CloudFront URL or the Amazon S3 URL, specify an empty
* <code>OriginAccessIdentity</code> element.</p> <p>To delete the origin access
* identity from an existing distribution, update the distribution configuration
* and include an empty <code>OriginAccessIdentity</code> element.</p> <p>To
* replace the origin access identity, update the distribution configuration and
* specify the new origin access identity.</p> <p>For more information about the
* origin access identity, see <a
* href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html">Serving
* Private Content through CloudFront</a> in the <i>Amazon CloudFront Developer
* Guide</i>.</p>
*/
inline const Aws::String& GetOriginAccessIdentity() const{ return m_originAccessIdentity; }
/**
* <p>The CloudFront origin access identity to associate with the origin. Use an
* origin access identity to configure the origin so that viewers can <i>only</i>
* access objects in an Amazon S3 bucket through CloudFront. The format of the
* value is:</p>
* <p>origin-access-identity/cloudfront/<i>ID-of-origin-access-identity</i> </p>
* <p>where <code> <i>ID-of-origin-access-identity</i> </code> is the value that
* CloudFront returned in the <code>ID</code> element when you created the origin
* access identity.</p> <p>If you want viewers to be able to access objects using
* either the CloudFront URL or the Amazon S3 URL, specify an empty
* <code>OriginAccessIdentity</code> element.</p> <p>To delete the origin access
* identity from an existing distribution, update the distribution configuration
* and include an empty <code>OriginAccessIdentity</code> element.</p> <p>To
* replace the origin access identity, update the distribution configuration and
* specify the new origin access identity.</p> <p>For more information about the
* origin access identity, see <a
* href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html">Serving
* Private Content through CloudFront</a> in the <i>Amazon CloudFront Developer
* Guide</i>.</p>
*/
inline bool OriginAccessIdentityHasBeenSet() const { return m_originAccessIdentityHasBeenSet; }
/**
* <p>The CloudFront origin access identity to associate with the origin. Use an
* origin access identity to configure the origin so that viewers can <i>only</i>
* access objects in an Amazon S3 bucket through CloudFront. The format of the
* value is:</p>
* <p>origin-access-identity/cloudfront/<i>ID-of-origin-access-identity</i> </p>
* <p>where <code> <i>ID-of-origin-access-identity</i> </code> is the value that
* CloudFront returned in the <code>ID</code> element when you created the origin
* access identity.</p> <p>If you want viewers to be able to access objects using
* either the CloudFront URL or the Amazon S3 URL, specify an empty
* <code>OriginAccessIdentity</code> element.</p> <p>To delete the origin access
* identity from an existing distribution, update the distribution configuration
* and include an empty <code>OriginAccessIdentity</code> element.</p> <p>To
* replace the origin access identity, update the distribution configuration and
* specify the new origin access identity.</p> <p>For more information about the
* origin access identity, see <a
* href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html">Serving
* Private Content through CloudFront</a> in the <i>Amazon CloudFront Developer
* Guide</i>.</p>
*/
inline void SetOriginAccessIdentity(const Aws::String& value) { m_originAccessIdentityHasBeenSet = true; m_originAccessIdentity = value; }
/**
* <p>The CloudFront origin access identity to associate with the origin. Use an
* origin access identity to configure the origin so that viewers can <i>only</i>
* access objects in an Amazon S3 bucket through CloudFront. The format of the
* value is:</p>
* <p>origin-access-identity/cloudfront/<i>ID-of-origin-access-identity</i> </p>
* <p>where <code> <i>ID-of-origin-access-identity</i> </code> is the value that
* CloudFront returned in the <code>ID</code> element when you created the origin
* access identity.</p> <p>If you want viewers to be able to access objects using
* either the CloudFront URL or the Amazon S3 URL, specify an empty
* <code>OriginAccessIdentity</code> element.</p> <p>To delete the origin access
* identity from an existing distribution, update the distribution configuration
* and include an empty <code>OriginAccessIdentity</code> element.</p> <p>To
* replace the origin access identity, update the distribution configuration and
* specify the new origin access identity.</p> <p>For more information about the
* origin access identity, see <a
* href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html">Serving
* Private Content through CloudFront</a> in the <i>Amazon CloudFront Developer
* Guide</i>.</p>
*/
inline void SetOriginAccessIdentity(Aws::String&& value) { m_originAccessIdentityHasBeenSet = true; m_originAccessIdentity = std::move(value); }
/**
* <p>The CloudFront origin access identity to associate with the origin. Use an
* origin access identity to configure the origin so that viewers can <i>only</i>
* access objects in an Amazon S3 bucket through CloudFront. The format of the
* value is:</p>
* <p>origin-access-identity/cloudfront/<i>ID-of-origin-access-identity</i> </p>
* <p>where <code> <i>ID-of-origin-access-identity</i> </code> is the value that
* CloudFront returned in the <code>ID</code> element when you created the origin
* access identity.</p> <p>If you want viewers to be able to access objects using
* either the CloudFront URL or the Amazon S3 URL, specify an empty
* <code>OriginAccessIdentity</code> element.</p> <p>To delete the origin access
* identity from an existing distribution, update the distribution configuration
* and include an empty <code>OriginAccessIdentity</code> element.</p> <p>To
* replace the origin access identity, update the distribution configuration and
* specify the new origin access identity.</p> <p>For more information about the
* origin access identity, see <a
* href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html">Serving
* Private Content through CloudFront</a> in the <i>Amazon CloudFront Developer
* Guide</i>.</p>
*/
inline void SetOriginAccessIdentity(const char* value) { m_originAccessIdentityHasBeenSet = true; m_originAccessIdentity.assign(value); }
/**
* <p>The CloudFront origin access identity to associate with the origin. Use an
* origin access identity to configure the origin so that viewers can <i>only</i>
* access objects in an Amazon S3 bucket through CloudFront. The format of the
* value is:</p>
* <p>origin-access-identity/cloudfront/<i>ID-of-origin-access-identity</i> </p>
* <p>where <code> <i>ID-of-origin-access-identity</i> </code> is the value that
* CloudFront returned in the <code>ID</code> element when you created the origin
* access identity.</p> <p>If you want viewers to be able to access objects using
* either the CloudFront URL or the Amazon S3 URL, specify an empty
* <code>OriginAccessIdentity</code> element.</p> <p>To delete the origin access
* identity from an existing distribution, update the distribution configuration
* and include an empty <code>OriginAccessIdentity</code> element.</p> <p>To
* replace the origin access identity, update the distribution configuration and
* specify the new origin access identity.</p> <p>For more information about the
* origin access identity, see <a
* href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html">Serving
* Private Content through CloudFront</a> in the <i>Amazon CloudFront Developer
* Guide</i>.</p>
*/
inline S3OriginConfig& WithOriginAccessIdentity(const Aws::String& value) { SetOriginAccessIdentity(value); return *this;}
/**
* <p>The CloudFront origin access identity to associate with the origin. Use an
* origin access identity to configure the origin so that viewers can <i>only</i>
* access objects in an Amazon S3 bucket through CloudFront. The format of the
* value is:</p>
* <p>origin-access-identity/cloudfront/<i>ID-of-origin-access-identity</i> </p>
* <p>where <code> <i>ID-of-origin-access-identity</i> </code> is the value that
* CloudFront returned in the <code>ID</code> element when you created the origin
* access identity.</p> <p>If you want viewers to be able to access objects using
* either the CloudFront URL or the Amazon S3 URL, specify an empty
* <code>OriginAccessIdentity</code> element.</p> <p>To delete the origin access
* identity from an existing distribution, update the distribution configuration
* and include an empty <code>OriginAccessIdentity</code> element.</p> <p>To
* replace the origin access identity, update the distribution configuration and
* specify the new origin access identity.</p> <p>For more information about the
* origin access identity, see <a
* href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html">Serving
* Private Content through CloudFront</a> in the <i>Amazon CloudFront Developer
* Guide</i>.</p>
*/
inline S3OriginConfig& WithOriginAccessIdentity(Aws::String&& value) { SetOriginAccessIdentity(std::move(value)); return *this;}
/**
* <p>The CloudFront origin access identity to associate with the origin. Use an
* origin access identity to configure the origin so that viewers can <i>only</i>
* access objects in an Amazon S3 bucket through CloudFront. The format of the
* value is:</p>
* <p>origin-access-identity/cloudfront/<i>ID-of-origin-access-identity</i> </p>
* <p>where <code> <i>ID-of-origin-access-identity</i> </code> is the value that
* CloudFront returned in the <code>ID</code> element when you created the origin
* access identity.</p> <p>If you want viewers to be able to access objects using
* either the CloudFront URL or the Amazon S3 URL, specify an empty
* <code>OriginAccessIdentity</code> element.</p> <p>To delete the origin access
* identity from an existing distribution, update the distribution configuration
* and include an empty <code>OriginAccessIdentity</code> element.</p> <p>To
* replace the origin access identity, update the distribution configuration and
* specify the new origin access identity.</p> <p>For more information about the
* origin access identity, see <a
* href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html">Serving
* Private Content through CloudFront</a> in the <i>Amazon CloudFront Developer
* Guide</i>.</p>
*/
inline S3OriginConfig& WithOriginAccessIdentity(const char* value) { SetOriginAccessIdentity(value); return *this;}
private:
Aws::String m_originAccessIdentity;
bool m_originAccessIdentityHasBeenSet;
};
} // namespace Model
} // namespace CloudFront
} // namespace Aws