Skip to content

Commit 1aa41d5

Browse files
author
awstools
committed
docs(client-iam): Documentation updates for AWS Identity and Access Management (IAM).
1 parent 4835de4 commit 1aa41d5

File tree

3 files changed

+58
-25
lines changed

3 files changed

+58
-25
lines changed

clients/client-iam/src/commands/CreateOpenIDConnectProviderCommand.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -60,12 +60,12 @@ export interface CreateOpenIDConnectProviderCommandOutput
6060
* <p>You get all of this information from the OIDC IdP you want to use to access
6161
* Amazon Web Services.</p>
6262
* <note>
63-
* <p>Amazon Web Services secures communication with some OIDC identity providers (IdPs) through our
64-
* library of trusted root certificate authorities (CAs) instead of using a certificate
65-
* thumbprint to verify your IdP server certificate. These OIDC IdPs include Auth0, GitHub,
66-
* Google, and those that use an Amazon S3 bucket to host a JSON Web Key Set (JWKS) endpoint. In
67-
* these cases, your legacy thumbprint remains in your configuration, but is no longer used
68-
* for validation.</p>
63+
* <p>Amazon Web Services secures communication with some OIDC identity providers (IdPs) through our library
64+
* of trusted root certificate authorities (CAs) instead of using a certificate thumbprint to
65+
* verify your IdP server certificate. In these cases, your legacy thumbprint remains in your
66+
* configuration, but is no longer used for validation. These OIDC IdPs include Auth0, GitHub,
67+
* GitLab, Google, and those that use an Amazon S3 bucket to host a JSON Web Key Set (JWKS)
68+
* endpoint.</p>
6969
* </note>
7070
* <note>
7171
* <p>The trust for the OIDC provider is derived from the IAM provider that this

clients/client-iam/src/commands/UpdateOpenIDConnectProviderThumbprintCommand.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -42,12 +42,12 @@ export interface UpdateOpenIDConnectProviderThumbprintCommandOutput extends __Me
4242
* the OIDC provider as a principal fails until the certificate thumbprint is
4343
* updated.</p>
4444
* <note>
45-
* <p>Amazon Web Services secures communication with some OIDC identity providers (IdPs) through our
46-
* library of trusted root certificate authorities (CAs) instead of using a certificate
47-
* thumbprint to verify your IdP server certificate. These OIDC IdPs include Auth0, GitHub,
48-
* Google, and those that use an Amazon S3 bucket to host a JSON Web Key Set (JWKS) endpoint. In
49-
* these cases, your legacy thumbprint remains in your configuration, but is no longer used
50-
* for validation.</p>
45+
* <p>Amazon Web Services secures communication with some OIDC identity providers (IdPs) through our library
46+
* of trusted root certificate authorities (CAs) instead of using a certificate thumbprint to
47+
* verify your IdP server certificate. In these cases, your legacy thumbprint remains in your
48+
* configuration, but is no longer used for validation. These OIDC IdPs include Auth0, GitHub,
49+
* GitLab, Google, and those that use an Amazon S3 bucket to host a JSON Web Key Set (JWKS)
50+
* endpoint.</p>
5151
* </note>
5252
* <note>
5353
* <p>Trust for the OIDC provider is derived from the provider certificate and is

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

Lines changed: 46 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1772,6 +1772,50 @@
17721772
"UseDualStack": false
17731773
}
17741774
},
1775+
{
1776+
"documentation": "For region eu-isoe-west-1 with FIPS disabled and DualStack disabled",
1777+
"expect": {
1778+
"endpoint": {
1779+
"properties": {
1780+
"authSchemes": [
1781+
{
1782+
"name": "sigv4",
1783+
"signingName": "iam",
1784+
"signingRegion": "eu-isoe-west-1"
1785+
}
1786+
]
1787+
},
1788+
"url": "https://iam.eu-isoe-west-1.cloud.adc-e.uk"
1789+
}
1790+
},
1791+
"params": {
1792+
"Region": "eu-isoe-west-1",
1793+
"UseFIPS": false,
1794+
"UseDualStack": false
1795+
}
1796+
},
1797+
{
1798+
"documentation": "For region us-isof-south-1 with FIPS disabled and DualStack disabled",
1799+
"expect": {
1800+
"endpoint": {
1801+
"properties": {
1802+
"authSchemes": [
1803+
{
1804+
"name": "sigv4",
1805+
"signingName": "iam",
1806+
"signingRegion": "us-isof-south-1"
1807+
}
1808+
]
1809+
},
1810+
"url": "https://iam.us-isof-south-1.csp.hci.ic.gov"
1811+
}
1812+
},
1813+
"params": {
1814+
"Region": "us-isof-south-1",
1815+
"UseFIPS": false,
1816+
"UseDualStack": false
1817+
}
1818+
},
17751819
{
17761820
"documentation": "For custom endpoint with region set and fips disabled and dualstack disabled",
17771821
"expect": {
@@ -1828,17 +1872,6 @@
18281872
"expect": {
18291873
"error": "Invalid Configuration: Missing Region"
18301874
}
1831-
},
1832-
{
1833-
"documentation": "Partition doesn't support DualStack",
1834-
"expect": {
1835-
"error": "DualStack is enabled but this partition does not support DualStack"
1836-
},
1837-
"params": {
1838-
"Region": "us-isob-east-1",
1839-
"UseFIPS": false,
1840-
"UseDualStack": true
1841-
}
18421875
}
18431876
],
18441877
"version": "1.0"
@@ -3104,7 +3137,7 @@
31043137
}
31053138
],
31063139
"traits": {
3107-
"smithy.api#documentation": "<p>Creates an IAM entity to describe an identity provider (IdP) that supports <a href=\"http://openid.net/connect/\">OpenID Connect (OIDC)</a>.</p>\n <p>The OIDC provider that you create with this operation can be used as a principal in a\n role's trust policy. Such a policy establishes a trust relationship between Amazon Web Services and\n the OIDC provider.</p>\n <p>If you are using an OIDC identity provider from Google, Facebook, or Amazon Cognito, you don't\n need to create a separate IAM identity provider. These OIDC identity providers are\n already built-in to Amazon Web Services and are available for your use. Instead, you can move directly\n to creating new roles using your identity provider. To learn more, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-idp_oidc.html\">Creating\n a role for web identity or OpenID connect federation</a> in the <i>IAM\n User Guide</i>.</p>\n <p>When you create the IAM OIDC provider, you specify the following:</p>\n <ul>\n <li>\n <p>The URL of the OIDC identity provider (IdP) to trust</p>\n </li>\n <li>\n <p>A list of client IDs (also known as audiences) that identify the application\n or applications allowed to authenticate using the OIDC provider</p>\n </li>\n <li>\n <p>A list of tags that are attached to the specified IAM OIDC provider</p>\n </li>\n <li>\n <p>A list of thumbprints of one or more server certificates that the IdP\n uses</p>\n </li>\n </ul>\n <p>You get all of this information from the OIDC IdP you want to use to access\n Amazon Web Services.</p>\n <note>\n <p>Amazon Web Services secures communication with some OIDC identity providers (IdPs) through our\n library of trusted root certificate authorities (CAs) instead of using a certificate\n thumbprint to verify your IdP server certificate. These OIDC IdPs include Auth0, GitHub,\n Google, and those that use an Amazon S3 bucket to host a JSON Web Key Set (JWKS) endpoint. In\n these cases, your legacy thumbprint remains in your configuration, but is no longer used\n for validation.</p>\n </note>\n <note>\n <p>The trust for the OIDC provider is derived from the IAM provider that this\n operation creates. Therefore, it is best to limit access to the <a>CreateOpenIDConnectProvider</a> operation to highly privileged\n users.</p>\n </note>",
3140+
"smithy.api#documentation": "<p>Creates an IAM entity to describe an identity provider (IdP) that supports <a href=\"http://openid.net/connect/\">OpenID Connect (OIDC)</a>.</p>\n <p>The OIDC provider that you create with this operation can be used as a principal in a\n role's trust policy. Such a policy establishes a trust relationship between Amazon Web Services and\n the OIDC provider.</p>\n <p>If you are using an OIDC identity provider from Google, Facebook, or Amazon Cognito, you don't\n need to create a separate IAM identity provider. These OIDC identity providers are\n already built-in to Amazon Web Services and are available for your use. Instead, you can move directly\n to creating new roles using your identity provider. To learn more, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-idp_oidc.html\">Creating\n a role for web identity or OpenID connect federation</a> in the <i>IAM\n User Guide</i>.</p>\n <p>When you create the IAM OIDC provider, you specify the following:</p>\n <ul>\n <li>\n <p>The URL of the OIDC identity provider (IdP) to trust</p>\n </li>\n <li>\n <p>A list of client IDs (also known as audiences) that identify the application\n or applications allowed to authenticate using the OIDC provider</p>\n </li>\n <li>\n <p>A list of tags that are attached to the specified IAM OIDC provider</p>\n </li>\n <li>\n <p>A list of thumbprints of one or more server certificates that the IdP\n uses</p>\n </li>\n </ul>\n <p>You get all of this information from the OIDC IdP you want to use to access\n Amazon Web Services.</p>\n <note>\n <p>Amazon Web Services secures communication with some OIDC identity providers (IdPs) through our library\n of trusted root certificate authorities (CAs) instead of using a certificate thumbprint to\n verify your IdP server certificate. In these cases, your legacy thumbprint remains in your\n configuration, but is no longer used for validation. These OIDC IdPs include Auth0, GitHub,\n GitLab, Google, and those that use an Amazon S3 bucket to host a JSON Web Key Set (JWKS)\n endpoint.</p>\n </note>\n <note>\n <p>The trust for the OIDC provider is derived from the IAM provider that this\n operation creates. Therefore, it is best to limit access to the <a>CreateOpenIDConnectProvider</a> operation to highly privileged\n users.</p>\n </note>",
31083141
"smithy.api#examples": [
31093142
{
31103143
"title": "To create an instance profile",
@@ -14844,7 +14877,7 @@
1484414877
}
1484514878
],
1484614879
"traits": {
14847-
"smithy.api#documentation": "<p>Replaces the existing list of server certificate thumbprints associated with an OpenID\n Connect (OIDC) provider resource object with a new list of thumbprints.</p>\n <p>The list that you pass with this operation completely replaces the existing list of\n thumbprints. (The lists are not merged.)</p>\n <p>Typically, you need to update a thumbprint only when the identity provider certificate\n changes, which occurs rarely. However, if the provider's certificate\n <i>does</i> change, any attempt to assume an IAM role that specifies\n the OIDC provider as a principal fails until the certificate thumbprint is\n updated.</p>\n <note>\n <p>Amazon Web Services secures communication with some OIDC identity providers (IdPs) through our\n library of trusted root certificate authorities (CAs) instead of using a certificate\n thumbprint to verify your IdP server certificate. These OIDC IdPs include Auth0, GitHub,\n Google, and those that use an Amazon S3 bucket to host a JSON Web Key Set (JWKS) endpoint. In\n these cases, your legacy thumbprint remains in your configuration, but is no longer used\n for validation.</p>\n </note>\n <note>\n <p>Trust for the OIDC provider is derived from the provider certificate and is\n validated by the thumbprint. Therefore, it is best to limit access to the\n <code>UpdateOpenIDConnectProviderThumbprint</code> operation to highly\n privileged users.</p>\n </note>"
14880+
"smithy.api#documentation": "<p>Replaces the existing list of server certificate thumbprints associated with an OpenID\n Connect (OIDC) provider resource object with a new list of thumbprints.</p>\n <p>The list that you pass with this operation completely replaces the existing list of\n thumbprints. (The lists are not merged.)</p>\n <p>Typically, you need to update a thumbprint only when the identity provider certificate\n changes, which occurs rarely. However, if the provider's certificate\n <i>does</i> change, any attempt to assume an IAM role that specifies\n the OIDC provider as a principal fails until the certificate thumbprint is\n updated.</p>\n <note>\n <p>Amazon Web Services secures communication with some OIDC identity providers (IdPs) through our library\n of trusted root certificate authorities (CAs) instead of using a certificate thumbprint to\n verify your IdP server certificate. In these cases, your legacy thumbprint remains in your\n configuration, but is no longer used for validation. These OIDC IdPs include Auth0, GitHub,\n GitLab, Google, and those that use an Amazon S3 bucket to host a JSON Web Key Set (JWKS)\n endpoint.</p>\n </note>\n <note>\n <p>Trust for the OIDC provider is derived from the provider certificate and is\n validated by the thumbprint. Therefore, it is best to limit access to the\n <code>UpdateOpenIDConnectProviderThumbprint</code> operation to highly\n privileged users.</p>\n </note>"
1484814881
}
1484914882
},
1485014883
"com.amazonaws.iam#UpdateOpenIDConnectProviderThumbprintRequest": {

0 commit comments

Comments
 (0)