Skip to content

Commit e5bf679

Browse files
author
awstools
committed
docs(client-cloudfront): Update API documentation for CloudFront origin access control (OAC)
1 parent 2584904 commit e5bf679

File tree

6 files changed

+17
-17
lines changed

6 files changed

+17
-17
lines changed

clients/client-cloudfront/src/CloudFront.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2246,7 +2246,7 @@ export class CloudFront extends CloudFrontClient {
22462246
}
22472247

22482248
/**
2249-
* <p>Gets a CloudFront origin access control.</p>
2249+
* <p>Gets a CloudFront origin access control, including its unique identifier.</p>
22502250
*/
22512251
public getOriginAccessControl(
22522252
args: GetOriginAccessControlCommandInput,
@@ -2278,7 +2278,7 @@ export class CloudFront extends CloudFrontClient {
22782278
}
22792279

22802280
/**
2281-
* <p>Gets a CloudFront origin access control.</p>
2281+
* <p>Gets a CloudFront origin access control configuration.</p>
22822282
*/
22832283
public getOriginAccessControlConfig(
22842284
args: GetOriginAccessControlConfigCommandInput,

clients/client-cloudfront/src/commands/GetOriginAccessControlCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface GetOriginAccessControlCommandInput extends GetOriginAccessContr
2828
export interface GetOriginAccessControlCommandOutput extends GetOriginAccessControlResult, __MetadataBearer {}
2929

3030
/**
31-
* <p>Gets a CloudFront origin access control.</p>
31+
* <p>Gets a CloudFront origin access control, including its unique identifier.</p>
3232
* @example
3333
* Use a bare-bones client and the command you need to make an API call.
3434
* ```javascript

clients/client-cloudfront/src/commands/GetOriginAccessControlConfigCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ export interface GetOriginAccessControlConfigCommandOutput
3030
__MetadataBearer {}
3131

3232
/**
33-
* <p>Gets a CloudFront origin access control.</p>
33+
* <p>Gets a CloudFront origin access control configuration.</p>
3434
* @example
3535
* Use a bare-bones client and the command you need to make an API call.
3636
* ```javascript

clients/client-cloudfront/src/models/models_0.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5657,7 +5657,7 @@ export enum OriginAccessControlSigningProtocols {
56575657
}
56585658

56595659
/**
5660-
* <p>A CloudFront origin access control.</p>
5660+
* <p>A CloudFront origin access control configuration.</p>
56615661
*/
56625662
export interface OriginAccessControlConfig {
56635663
/**
@@ -5701,8 +5701,8 @@ export interface OriginAccessControlConfig {
57015701
* sign the origin request and instead passes along the <code>Authorization</code>
57025702
* header from the viewer request. <b>WARNING: To pass along the
57035703
* <code>Authorization</code> header from the viewer request, you
5704-
* <i>must</i> add the <code>Authorization</code> header to an <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html">origin request policy</a> for all cache behaviors that
5705-
* use origins associated with this origin access control.</b>
5704+
* <i>must</i> add the <code>Authorization</code> header to a <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html">cache policy</a> for all cache behaviors that use
5705+
* origins associated with this origin access control.</b>
57065706
* </p>
57075707
* </li>
57085708
* </ul>
@@ -5724,7 +5724,7 @@ export interface CreateOriginAccessControlRequest {
57245724
}
57255725

57265726
/**
5727-
* <p>A CloudFront origin access control.</p>
5727+
* <p>A CloudFront origin access control, including its unique identifier.</p>
57285728
*/
57295729
export interface OriginAccessControl {
57305730
/**

clients/client-cloudfront/src/models/models_1.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1062,7 +1062,7 @@ export interface GetOriginAccessControlRequest {
10621062

10631063
export interface GetOriginAccessControlResult {
10641064
/**
1065-
* <p>Contains an origin access control.</p>
1065+
* <p>Contains an origin access control, including its unique identifier.</p>
10661066
*/
10671067
OriginAccessControl?: OriginAccessControl;
10681068

@@ -1081,7 +1081,7 @@ export interface GetOriginAccessControlConfigRequest {
10811081

10821082
export interface GetOriginAccessControlConfigResult {
10831083
/**
1084-
* <p>Contains an origin access control.</p>
1084+
* <p>Contains an origin access control configuration.</p>
10851085
*/
10861086
OriginAccessControlConfig?: OriginAccessControlConfig;
10871087

codegen/sdk-codegen/aws-models/cloudfront.json

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6663,7 +6663,7 @@
66636663
}
66646664
],
66656665
"traits": {
6666-
"smithy.api#documentation": "<p>Gets a CloudFront origin access control.</p>",
6666+
"smithy.api#documentation": "<p>Gets a CloudFront origin access control, including its unique identifier.</p>",
66676667
"smithy.api#http": {
66686668
"method": "GET",
66696669
"uri": "/2020-05-31/origin-access-control/{Id}",
@@ -6688,7 +6688,7 @@
66886688
}
66896689
],
66906690
"traits": {
6691-
"smithy.api#documentation": "<p>Gets a CloudFront origin access control.</p>",
6691+
"smithy.api#documentation": "<p>Gets a CloudFront origin access control configuration.</p>",
66926692
"smithy.api#http": {
66936693
"method": "GET",
66946694
"uri": "/2020-05-31/origin-access-control/{Id}/config",
@@ -6715,7 +6715,7 @@
67156715
"OriginAccessControlConfig": {
67166716
"target": "com.amazonaws.cloudfront#OriginAccessControlConfig",
67176717
"traits": {
6718-
"smithy.api#documentation": "<p>Contains an origin access control.</p>",
6718+
"smithy.api#documentation": "<p>Contains an origin access control configuration.</p>",
67196719
"smithy.api#httpPayload": {}
67206720
}
67216721
},
@@ -6747,7 +6747,7 @@
67476747
"OriginAccessControl": {
67486748
"target": "com.amazonaws.cloudfront#OriginAccessControl",
67496749
"traits": {
6750-
"smithy.api#documentation": "<p>Contains an origin access control.</p>",
6750+
"smithy.api#documentation": "<p>Contains an origin access control, including its unique identifier.</p>",
67516751
"smithy.api#httpPayload": {}
67526752
}
67536753
},
@@ -10056,7 +10056,7 @@
1005610056
}
1005710057
},
1005810058
"traits": {
10059-
"smithy.api#documentation": "<p>A CloudFront origin access control.</p>"
10059+
"smithy.api#documentation": "<p>A CloudFront origin access control, including its unique identifier.</p>"
1006010060
}
1006110061
},
1006210062
"com.amazonaws.cloudfront#OriginAccessControlAlreadyExists": {
@@ -10099,7 +10099,7 @@
1009910099
"SigningBehavior": {
1010010100
"target": "com.amazonaws.cloudfront#OriginAccessControlSigningBehaviors",
1010110101
"traits": {
10102-
"smithy.api#documentation": "<p>Specifies which requests CloudFront signs (adds authentication information to). Specify\n\t\t\t<code>always</code> for the most common use case. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html#oac-advanced-settings\">origin access control advanced settings</a> in the\n\t\t\t<i>Amazon CloudFront Developer Guide</i>.</p>\n\t\t <p>This field can have one of the following values:</p>\n\t\t <ul>\n <li>\n\t\t\t\t <p>\n <code>always</code> – CloudFront signs all origin requests, overwriting the\n\t\t\t\t\t<code>Authorization</code> header from the viewer request if one exists.</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>\n <code>never</code> – CloudFront doesn't sign any origin requests. This value turns off origin\n\t\t\t\t\taccess control for all origins in all distributions that use this origin access\n\t\t\t\t\tcontrol.</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>\n <code>no-override</code> – If the viewer request doesn't contain the\n\t\t\t\t\t<code>Authorization</code> header, then CloudFront signs the origin request. If the\n\t\t\t\t\tviewer request contains the <code>Authorization</code> header, then CloudFront doesn't\n\t\t\t\t\tsign the origin request and instead passes along the <code>Authorization</code>\n\t\t\t\t\theader from the viewer request. <b>WARNING: To pass along the\n\t\t\t\t\t<code>Authorization</code> header from the viewer request, you\n\t\t\t\t\t<i>must</i> add the <code>Authorization</code> header to an <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html\">origin request policy</a> for all cache behaviors that\n\t\t\t\t\tuse origins associated with this origin access control.</b>\n </p>\n\t\t\t </li>\n </ul>",
10102+
"smithy.api#documentation": "<p>Specifies which requests CloudFront signs (adds authentication information to). Specify\n\t\t\t<code>always</code> for the most common use case. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html#oac-advanced-settings\">origin access control advanced settings</a> in the\n\t\t\t<i>Amazon CloudFront Developer Guide</i>.</p>\n\t\t <p>This field can have one of the following values:</p>\n\t\t <ul>\n <li>\n\t\t\t\t <p>\n <code>always</code> – CloudFront signs all origin requests, overwriting the\n\t\t\t\t\t<code>Authorization</code> header from the viewer request if one exists.</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>\n <code>never</code> – CloudFront doesn't sign any origin requests. This value turns off origin\n\t\t\t\t\taccess control for all origins in all distributions that use this origin access\n\t\t\t\t\tcontrol.</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>\n <code>no-override</code> – If the viewer request doesn't contain the\n\t\t\t\t\t<code>Authorization</code> header, then CloudFront signs the origin request. If the\n\t\t\t\t\tviewer request contains the <code>Authorization</code> header, then CloudFront doesn't\n\t\t\t\t\tsign the origin request and instead passes along the <code>Authorization</code>\n\t\t\t\t\theader from the viewer request. <b>WARNING: To pass along the\n\t\t\t\t\t<code>Authorization</code> header from the viewer request, you\n\t\t\t\t\t<i>must</i> add the <code>Authorization</code> header to a <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html\">cache policy</a> for all cache behaviors that use\n\t\t\t\t\torigins associated with this origin access control.</b>\n </p>\n\t\t\t </li>\n </ul>",
1010310103
"smithy.api#required": {}
1010410104
}
1010510105
},
@@ -10112,7 +10112,7 @@
1011210112
}
1011310113
},
1011410114
"traits": {
10115-
"smithy.api#documentation": "<p>A CloudFront origin access control.</p>"
10115+
"smithy.api#documentation": "<p>A CloudFront origin access control configuration.</p>"
1011610116
}
1011710117
},
1011810118
"com.amazonaws.cloudfront#OriginAccessControlInUse": {

0 commit comments

Comments
 (0)