Skip to content

Commit 4313a21

Browse files
docs(cfnspec): update CloudFormation documentation (#23807)
1 parent 3334acc commit 4313a21

File tree

1 file changed

+25
-25
lines changed

1 file changed

+25
-25
lines changed

packages/@aws-cdk/cfnspec/spec-source/cfn-docs/cfn-docs.json

+25-25
Original file line numberDiff line numberDiff line change
@@ -2055,7 +2055,7 @@
20552055
"ConnectorLabel": "The label used for registering the connector.",
20562056
"ConnectorProvisioningConfig": "The configuration required for registering the connector.",
20572057
"ConnectorProvisioningType": "The provisioning type used to register the connector.",
2058-
"Description": "A description about the connector runtime setting."
2058+
"Description": "A description of the connector entity field."
20592059
}
20602060
},
20612061
"AWS::AppFlow::Connector.ConnectorProvisioningConfig": {
@@ -36811,7 +36811,7 @@
3681136811
"ClusterConfig": "Container for the cluster configuration of a domain.",
3681236812
"CognitoOptions": "Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.",
3681336813
"DomainEndpointOptions": "Specifies additional options for the domain endpoint, such as whether to require HTTPS for all traffic or whether to use a custom endpoint rather than the default endpoint.",
36814-
"DomainName": "A name for the OpenSearch Service domain. For valid values, see the [DomainName](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/configuration-api.html#configuration-api-datatypes-domainname) data type in the *Amazon OpenSearch Service Developer Guide* . If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the domain name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) .\n\nRequired when creating a new domain.\n\n> If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.",
36814+
"DomainName": "A name for the OpenSearch Service domain. The name must have a minimum length of 3 and a maximum length of 28. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the domain name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) .\n\nRequired when creating a new domain.\n\n> If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.",
3681536815
"EBSOptions": "The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the OpenSearch Service domain. For more information, see [EBS volume size limits](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/limits.html#ebsresource) in the *Amazon OpenSearch Service Developer Guide* .",
3681636816
"EncryptionAtRestOptions": "Whether the domain should encrypt data at rest, and if so, the AWS KMS key to use. See [Encryption of data at rest for Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/encryption-at-rest.html) .",
3681736817
"EngineVersion": "The version of OpenSearch to use. The value must be in the format `OpenSearch_X.Y` or `Elasticsearch_X.Y` . If not specified, the latest version of OpenSearch is used. For information about the versions that OpenSearch Service supports, see [Supported versions of OpenSearch and Elasticsearch](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/what-is.html#choosing-version) in the *Amazon OpenSearch Service Developer Guide* .\n\nIf you set the [EnableVersionUpgrade](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html#cfn-attributes-updatepolicy-upgradeopensearchdomain) update policy to `true` , you can update `EngineVersion` without interruption. When `EnableVersionUpgrade` is set to `false` , or is not specified, updating `EngineVersion` results in [replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) .",
@@ -41609,42 +41609,42 @@
4160941609
"AWS::RolesAnywhere::CRL": {
4161041610
"attributes": {
4161141611
"CrlId": "The unique primary identifier of the Crl",
41612-
"Ref": "The name of the CRL."
41612+
"Ref": "`Ref` returns `CrlId` ."
4161341613
},
41614-
"description": "Creates a Crl.",
41614+
"description": "The state of the certificate revocation list (CRL) after a read or write operation.",
4161541615
"properties": {
41616-
"CrlData": "x509 v3 Certificate Revocation List to revoke auth for corresponding certificates presented in CreateSession operations",
41617-
"Enabled": "The enabled status of the resource.",
41618-
"Name": "The customer specified name of the resource.",
41619-
"Tags": "A list of Tags.",
41616+
"CrlData": "The revocation record for a certificate, following the x509 v3 standard.",
41617+
"Enabled": "Indicates whether the certificate revocation list (CRL) is enabled.",
41618+
"Name": "The name of the certificate revocation list (CRL).",
41619+
"Tags": "A list of tags to attach to the CRL.",
4162041620
"TrustAnchorArn": "The ARN of the TrustAnchor the certificate revocation list (CRL) will provide revocation for."
4162141621
}
4162241622
},
4162341623
"AWS::RolesAnywhere::Profile": {
4162441624
"attributes": {
41625-
"ProfileArn": "",
41625+
"ProfileArn": "The ARN of the profile.",
4162641626
"ProfileId": "The unique primary identifier of the Profile",
41627-
"Ref": "The name of the Profile"
41627+
"Ref": "`Ref` returns `ProfileId` ."
4162841628
},
41629-
"description": "Creates a Profile.",
41629+
"description": "Creates a *profile* , a list of the roles that Roles Anywhere service is trusted to assume. You use profiles to intersect permissions with IAM managed policies.\n\n*Required permissions:* `rolesanywhere:CreateProfile` .",
4163041630
"properties": {
41631-
"DurationSeconds": "The number of seconds vended session credentials will be valid for",
41632-
"Enabled": "The enabled status of the resource.",
41633-
"ManagedPolicyArns": "A list of managed policy ARNs. Managed policies identified by this list will be applied to the vended session credentials.",
41634-
"Name": "The customer specified name of the resource.",
41635-
"RequireInstanceProperties": "Specifies whether instance properties are required in CreateSession requests with this profile.",
41636-
"RoleArns": "A list of IAM role ARNs that can be assumed when this profile is specified in a CreateSession request.",
41637-
"SessionPolicy": "A session policy that will applied to the trust boundary of the vended session credentials.",
41638-
"Tags": "A list of Tags."
41631+
"DurationSeconds": "Sets the maximum number of seconds that vended temporary credentials through [CreateSession](https://docs.aws.amazon.com/rolesanywhere/latest/userguide/authentication-create-session.html) will be valid for, between 900 and 3600.",
41632+
"Enabled": "Indicates whether the profile is enabled.",
41633+
"ManagedPolicyArns": "A list of managed policy ARNs that apply to the vended session credentials.",
41634+
"Name": "The name of the profile.",
41635+
"RequireInstanceProperties": "Specifies whether instance properties are required in temporary credential requests with this profile.",
41636+
"RoleArns": "A list of IAM role ARNs. During `CreateSession` , if a matching role ARN is provided, the properties in this profile will be applied to the intersection session policy.",
41637+
"SessionPolicy": "A session policy that applies to the trust boundary of the vended session credentials.",
41638+
"Tags": "A list of tags to attach to the profile."
4163941639
}
4164041640
},
4164141641
"AWS::RolesAnywhere::TrustAnchor": {
4164241642
"attributes": {
4164341643
"Ref": "`Ref` returns `TrustAnchorId` .",
4164441644
"TrustAnchorArn": "The ARN of the trust anchor.",
41645-
"TrustAnchorId": ""
41645+
"TrustAnchorId": "The unique primary identifier of the TrustAnchor"
4164641646
},
41647-
"description": "Creates a TrustAnchor.",
41647+
"description": "The state of the trust anchor after a read or write operation.",
4164841648
"properties": {
4164941649
"Enabled": "Indicates whether the trust anchor is enabled.",
4165041650
"Name": "The name of the trust anchor.",
@@ -41654,15 +41654,15 @@
4165441654
},
4165541655
"AWS::RolesAnywhere::TrustAnchor.Source": {
4165641656
"attributes": {},
41657-
"description": "Object representing the TrustAnchor type and its related certificate data.",
41657+
"description": "The trust anchor type and its related certificate data.",
4165841658
"properties": {
41659-
"SourceData": "A union object representing the data field of the TrustAnchor depending on its type",
41660-
"SourceType": "The type of the TrustAnchor."
41659+
"SourceData": "The data field of the trust anchor depending on its type.",
41660+
"SourceType": "The type of the trust anchor."
4166141661
}
4166241662
},
4166341663
"AWS::RolesAnywhere::TrustAnchor.SourceData": {
4166441664
"attributes": {},
41665-
"description": "A union object representing the data field of the TrustAnchor depending on its type",
41665+
"description": "The data field of the trust anchor depending on its type.",
4166641666
"properties": {
4166741667
"AcmPcaArn": "The root certificate of the AWS Private Certificate Authority specified by this ARN is used in trust validation for temporary credential requests. Included for trust anchors of type `AWS_ACM_PCA` .",
4166841668
"X509CertificateData": "The PEM-encoded data for the certificate anchor. Included for trust anchors of type `CERTIFICATE_BUNDLE` ."

0 commit comments

Comments
 (0)